oracle.hsgbu.ets.mapping

Interface MapTarget

public interface MapTarget

Defines target of a cross map. Cross map targets contain one or more target concepts, along with rules and advice used for choosing among potential multiple mappings.

Method Summary

Modifier and Type	Method and Description
String	getCode() Gets the vendor-assigned target code of this MapTarget object.
CrossMap[]	getCrossMaps() Gets an array of all the cross maps that refer to this MapTarget object.
MapSet	getMapSet() Gets the parent MapSet associated with this MapTarget object.
String	getTargetAdvice() Gets the human-readable advice specified by this MapTarget vendor.
Concept[]	getTargetConcepts() Gets an array of target concepts that this MapTarget object encompasses.
String	getTargetRule() Gets the machine-readable mapping rule associated with this MapTarget object.

Method Detail

getCrossMaps

CrossMap[] getCrossMaps()
                 throws ETSDataException

Gets an array of all the cross maps that refer to this MapTarget object. This method returns an empty array if this MapTarget object does not belong to any of the cross maps.

Returns:

Array that contains all the cross maps of this MapTarget object, or an empty array if this MapTarget object does not belong to any of the cross maps.

Throws:

ETSDataException - If a data transport error occurs.

getMapSet

MapSet getMapSet()
          throws ETSDataException

Gets the parent MapSet associated with this MapTarget object.

Returns:

Parent MapSet associated with this MapSet object.

Throws:

ETSDataException - If a data transport error occurs.

getCode

String getCode()

Gets the vendor-assigned target code of this MapTarget object. The maximum length of this attribute is 30.

Returns:

Vendor-assigned target code.

getTargetConcepts

Concept[] getTargetConcepts()
                     throws ETSDataException

Gets an array of target concepts that this MapTarget object encompasses. The target concepts belong to the target coding scheme version. This method returns an empty array if the required target concepts are not available.

Returns:

Array containing target concepts that are mapped to this MapTarget object, or an empty array if the required target concepts are not available.

Throws:

ETSDataException - If a data transport error occurs.

getTargetAdvice

String getTargetAdvice()

Gets the human-readable advice specified by this MapTarget vendor. This method returns null if this MapTarget object does not have any human-readable advice. The maximum length of this attribute is 240.

Returns:

Human-readable advice or null if this MapTarget object does not have any human-readable advice.

getTargetRule

String getTargetRule()

Gets the machine-readable mapping rule associated with this MapTarget object. This method returns null if this MapTarget object does not have any machine-readable mapping rules. The maximum length of this attribute is 4000.

Returns:

Machine-readable mapping rule or null if this MapTarget object does not have any machine-readable mapping rules.