BidiMappingService (ipf-commons-map 3.5.3 API)

java.lang.Object
- org.openehealth.ipf.commons.map.BidiMappingService

All Implemented Interfaces:: groovy.lang.GroovyObject, MappingService

public class BidiMappingService
extends Object
implements MappingService, groovy.lang.GroovyObject

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`ELSE`
`protected static String`	`KEYSYSTEM`
`protected static String`	`SEPARATOR`
`protected static String`	`VALUESYSTEM`

Constructor Summary

Constructors
Constructor and Description

BidiMappingService()

BidiMappingService(String separator)

Constructors
Constructor and Description
`BidiMappingService()`
`BidiMappingService(String separator)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMappingScript(URL script)`
`void`	`addMappingScripts(URL... scripts)`
`protected void`	`checkMappingKey(Map<Object,Map> map, Object mappingKey)`
`void`	`clearMappings()`
`Object`	`get(Object mappingKey, Object key)`
`Object`	`get(Object mappingKey, Object key, Object defaultValue)`
`boolean`	`getIgnoreResourceNotFound()`
`Object`	`getKey(Object mappingKey, Object value)` Reverse mapping (Optional implementation)
`Object`	`getKey(Object mappingKey, Object value, Object defaultValue)` Reverse mapping (Optional implementation)
`Object`	`getKeySystem(Object mappingKey)`
`Map<Object,Map>`	`getMap()`
`groovy.lang.MetaClass`	`getMetaClass()`
`Object`	`getProperty(String property)`
`Map`	`getReverseMap()`
`List<URL>`	`getScripts()`
`String`	`getSeparator()`
`Object`	`getValueSystem(Object mappingKey)`
`Object`	`invokeMethod(String method, Object arguments)`
`boolean`	`isIgnoreResourceNotFound()`
`protected Object`	`joinKey(Object x)`
`Set<?>`	`keys(Object mappingKey)`
`Set<?>`	`mappingKeys()`
`protected Object`	`retrieve(Map<Object,Map> m, Object mappingKey, Object key)`
`protected Object`	`retrieveElse(Map<Object,Map> m, Object mappingKey, Object key)`
`void`	`setIgnoreResourceNotFound(boolean value)`
`void`	`setMap(Map<Object,Map> value)`
`void`	`setMappingScript(URL script)`
`void`	`setMappingScripts(URL... scripts)`
`void`	`setMetaClass(groovy.lang.MetaClass mc)`
`void`	`setProperty(String property, Object value)`
`void`	`setReverseMap(Map value)`
`void`	`setScripts(List<URL> value)`
`void`	`setSeparator(String value)`
`protected Object`	`splitKey(Object x)`
`protected void`	`updateReverseMap()`
`Collection<?>`	`values(Object mappingKey)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEYSYSTEM
```
protected static final String KEYSYSTEM
```
    See Also:
    
    Constant Field Values
  - VALUESYSTEM
```
protected static final String VALUESYSTEM
```
    See Also:
    
    Constant Field Values
  - ELSE
```
protected static final String ELSE
```
    See Also:
    
    Constant Field Values
  - SEPARATOR
```
protected static final String SEPARATOR
```
- Constructor Detail
  - BidiMappingService
```
public BidiMappingService()
```
  - BidiMappingService
```
public BidiMappingService(String separator)
```
- Method Detail
  - getMetaClass
```
public groovy.lang.MetaClass getMetaClass()
```
    Specified by:
    
    getMetaClass in interface groovy.lang.GroovyObject
  - setMetaClass
```
public void setMetaClass(groovy.lang.MetaClass mc)
```
    Specified by:
    
    setMetaClass in interface groovy.lang.GroovyObject
  - invokeMethod
```
public Object invokeMethod(String method,
                           Object arguments)
```
    Specified by:
    
    invokeMethod in interface groovy.lang.GroovyObject
  - getProperty
```
public Object getProperty(String property)
```
    Specified by:
    
    getProperty in interface groovy.lang.GroovyObject
  - setProperty
```
public void setProperty(String property,
                        Object value)
```
    Specified by:
    
    setProperty in interface groovy.lang.GroovyObject
  - getMap
```
public Map<Object,Map> getMap()
```
  - setMap
```
public void setMap(Map<Object,Map> value)
```
  - getReverseMap
```
public Map getReverseMap()
```
  - setReverseMap
```
public void setReverseMap(Map value)
```
  - getSeparator
```
public String getSeparator()
```
  - setSeparator
```
public void setSeparator(String value)
```
  - getIgnoreResourceNotFound
```
public boolean getIgnoreResourceNotFound()
```
  - isIgnoreResourceNotFound
```
public boolean isIgnoreResourceNotFound()
```
  - setIgnoreResourceNotFound
```
public void setIgnoreResourceNotFound(boolean value)
```
  - getScripts
```
public List<URL> getScripts()
```
  - setScripts
```
public void setScripts(List<URL> value)
```
  - setMappingScript
```
public void setMappingScript(URL script)
```
  - setMappingScripts
```
public void setMappingScripts(URL... scripts)
```
  - addMappingScript
```
public void addMappingScript(URL script)
```
  - addMappingScripts
```
public void addMappingScripts(URL... scripts)
```
  - clearMappings
```
public void clearMappings()
```
  - get
```
public Object get(Object mappingKey,
                  Object key)
```
    Specified by:
    
    get in interface MappingService
    
    Parameters:
    
    mappingKey - mapping name
    
    key - left side of the mapping
    
    Returns:
    
    the value mapped by a registered mapping. The implementation of the mapping implements the behavior if the key does not exist.
  - getKey
```
public Object getKey(Object mappingKey,
                     Object value)
```
    Description copied from interface: MappingService
    
    Reverse mapping (Optional implementation)
    
    Specified by:
    
    getKey in interface MappingService
    
    Parameters:
    
    mappingKey - mapping name
    
    value - right side of the mapping
    
    Returns:
    
    the key mapped by a registered mapping. The implementation of the mapping implements the behavior if the value does not exist.
  - get
```
public Object get(Object mappingKey,
                  Object key,
                  Object defaultValue)
```
    Specified by:
    
    get in interface MappingService
    
    Parameters:
    
    mappingKey - mapping name
    
    key - left side of the mapping
    
    defaultValue - default right side if there is no mapping for the code
    
    Returns:
    
    the value mapped by a registered mapping. If no mapping exists, the default value if returned. The implementation of the mapping implements the behavior if the key does not exist.
  - getKey
```
public Object getKey(Object mappingKey,
                     Object value,
                     Object defaultValue)
```
    Description copied from interface: MappingService
    
    Reverse mapping (Optional implementation)
    
    Specified by:
    
    getKey in interface MappingService
    
    Parameters:
    
    mappingKey - mapping name
    
    value - right side of the mapping
    
    defaultValue - default left side
    
    Returns:
    
    the key mapped by a registered mapping. If no mapping exists, the default value if returned. The implementation of the mapping implements the behavior if the key does not exist.
  - getKeySystem
```
public Object getKeySystem(Object mappingKey)
```
    Specified by:
    
    getKeySystem in interface MappingService
    
    Parameters:
    
    mappingKey - mapping name
    
    Returns:
    
    a formal identification of the key system (e.g. an OID)
  - getValueSystem
```
public Object getValueSystem(Object mappingKey)
```
    Specified by:
    
    getValueSystem in interface MappingService
    
    Parameters:
    
    mappingKey - mapping name
    
    Returns:
    
    a formal identification of the value system (e.g. an OID)
  - mappingKeys
```
public Set<?> mappingKeys()
```
    Specified by:
    
    mappingKeys in interface MappingService
    
    Returns:
    
    a set of names of all registered mappings. Changes to the set do not change the registry itself.
  - keys
```
public Set<?> keys(Object mappingKey)
```
    Specified by:
    
    keys in interface MappingService
    
    Parameters:
    
    mappingKey - mapping key
    
    Returns:
    
    key set of a registered mapping. Changes to the set do not change the registry itself.
  - values
```
public Collection<?> values(Object mappingKey)
```
    Specified by:
    
    values in interface MappingService
    
    Parameters:
    
    mappingKey - mapping key
    
    Returns:
    
    value set of a registered mapping. Changes to the set do not change the registry itself.
  - retrieve
```
protected Object retrieve(Map<Object,Map> m,
                          Object mappingKey,
                          Object key)
```
  - retrieveElse
```
protected Object retrieveElse(Map<Object,Map> m,
                              Object mappingKey,
                              Object key)
```
  - updateReverseMap
```
protected void updateReverseMap()
```
  - checkMappingKey
```
protected void checkMappingKey(Map<Object,Map> map,
                               Object mappingKey)
```
  - joinKey
```
protected Object joinKey(Object x)
```
  - splitKey
```
protected Object splitKey(Object x)
```

Class BidiMappingService

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEYSYSTEM

VALUESYSTEM

ELSE

SEPARATOR

Constructor Detail

BidiMappingService

BidiMappingService

Method Detail

getMetaClass

setMetaClass

invokeMethod

getProperty

setProperty

getMap

setMap

getReverseMap

setReverseMap

getSeparator

setSeparator

getIgnoreResourceNotFound

isIgnoreResourceNotFound

setIgnoreResourceNotFound

getScripts

setScripts

setMappingScript

setMappingScripts

addMappingScript

addMappingScripts

clearMappings

get

getKey

get

getKey

getKeySystem

getValueSystem

mappingKeys

keys

values

retrieve

retrieveElse

updateReverseMap

checkMappingKey

joinKey

splitKey