oracle.hsgbu.ets.mapping

Interface CrossMap

public interface CrossMap

Defines a single mapping between a source concept and a map target. A map set may contain multiple CrossMap objects for a single source concept. Cross maps may optionally provide human-readable advice, or machine-readable rules to help choose an appropriate mapping.

Method Summary

Modifier and Type	Method and Description
String	getMapAdvice() Gets the human-readable String that provides advice on how to use this CrossMap object.
int	getMapOption() Gets the option number (map option) of this CrossMap object.
int	getMapPriority() Gets the priority of this CrossMap object that specifies a suggested order in which a series of mapping options (cross maps) can be presented to the user.
String	getMapRule() Gets the machine-readable map rule that provides advice on how to use this CrossMap object.
MapSet	getMapSet() Gets the MapSet that contains this CrossMap object.
MapTarget	getMapTarget() Gets the MapTarget associated with this CrossMap object.
Concept	getSourceConcept() Gets the source concept of this CrossMap object.
boolean	isDefault() Indicates if this CrossMap object is the default cross map for its source concept.

Method Detail

getSourceConcept

Concept getSourceConcept()
                  throws ETSDataException

Gets the source concept of this CrossMap object. For example, the source concept of this CrossMap object can be a particular SNOMED concept.

Returns:

Source concept of this CrossMap object.

Throws:

ETSDataException - If a data transport error occurs.

getMapSet

MapSet getMapSet()
          throws ETSDataException

Gets the MapSet that contains this CrossMap object.

Returns:

MapSet that contains this CrossMap object.

Throws:

ETSDataException - If a data transport error occurs.

getMapTarget

MapTarget getMapTarget()
                throws ETSDataException

Gets the MapTarget associated with this CrossMap object.

Returns:

MapTarget associated with this CrossMap object.

Throws:

ETSDataException - If a data transport error occurs.

getMapAdvice

String getMapAdvice()

Gets the human-readable String that provides advice on how to use this CrossMap object. Example for human-readable String is "Use this map under the following conditions: ___". This method returns null if the advice for this CrossMap object does not exist. The maximum length of this attribute is 4000.

Returns:

Human-readable String, or null if advice for this CrossMap object does not exist.

getMapRule

String getMapRule()

Gets the machine-readable map rule that provides advice on how to use this CrossMap object. A map rule specifies the tenet of selecting a particular alternative cross map to this CrossMap object.

Map rules are provided to support future plans of SNOMED-CT or other map set vendors and are expected to be available in the native format provided by the map set vendor. ETS does not attempt to interpret or validate the map rules. The method returns null if the machine-readable rules for this CrossMap object does not exist.

The maximum length of this attribute is 4000.

Returns:

Machine-readable map rule that provides advice on how to use this CrossMap object, or null if the machine-readable rules for this CrossMap object does not exist.

getMapPriority

int getMapPriority()

Gets the priority of this CrossMap object that specifies a suggested order in which a series of mapping options (cross maps) can be presented to the user. The lower the MapPriority value, the higher the priority of the CrossMap. For example, a CrossMap object with priority zero has higher priority than a CrossMap with priority one.

ETS does not guarantee the number of cross maps of a given priority. Multiple cross maps with the same priority may exist. Priority values of the cross maps can be negative. ETS assigns a default priority of zero to cross maps in map sets that do not define any priority.

Returns:

Priority of CrossMap.

getMapOption

int getMapOption()

Gets the option number (map option) of this CrossMap object. The option number of a cross map distinguishes between multiple mapping options for a given source concept. The map set vendor specifies the option numbers. Map options may be used to process machine-readable rules. For example, if each cross map has a map rule, the order in which the rules are evaluated may be determined by examining the map option of each cross map.

ETS does not guarantee that map options will be distinct for a given source concept. ETS assigns a default value of 0 to cross maps in map sets that do not define any map option.

Returns:

Map option of this CrossMap object.

isDefault

boolean isDefault()

Indicates if this CrossMap object is the default cross map for its source concept. This method returns true if this CrossMap is the default cross map for its source concept.

Returns:

true if this cross map is the default cross map for its source concept.