Package org.openehealth.ipf.commons.ihe.xds.core.ebxml.ebxml30

Class EbXMLClassification30

java.lang.Object

org.openehealth.ipf.commons.ihe.xds.core.ebxml.ebxml30.EbXMLClassification30

All Implemented Interfaces:

EbXMLClassification, EbXMLSlotList

public class EbXMLClassification30
extends Object
implements EbXMLClassification

Encapsulation of ClassificationType.

Author:

Jens Riemschneider

Field Summary

Fields inherited from interface org.openehealth.ipf.commons.ihe.xds.core.ebxml.EbXMLClassification

CLASSIFICATION_OBJECT_TYPE

Constructor Summary

Constructors

Constructor	Description
EbXMLClassification30(ClassificationType classification)	Constructs a classification by wrapping the given ebXML 3.0 object.

Method Summary

Modifier and Type	Method	Description
void	addSlot(String slotName, String... slotValues)	Adds a slot with a list of values.
void	assignUniqueId()	Assigns a random unique ID to this classification.
String	getClassificationNode()
String	getClassificationScheme()
String	getClassifiedObject()
ClassificationType	getInternal()
LocalizedString	getName()
EbXMLInternationalString30	getNameAsInternationalString()
String	getNodeRepresentation()
String	getSingleSlotValue(String slotName)	Gets a single slot value.
List<EbXMLSlot>	getSlots()
List<EbXMLSlot>	getSlots(String slotName)	Returns a filtered list of the slots.
List<String>	getSlotValues(String slotName)	Gets the values of a slot.
void	setClassificationNode(String classificationNode)
void	setClassificationScheme(String classificationScheme)
void	setClassifiedObject(String classifiedObject)
void	setName(LocalizedString name)
void	setNodeRepresentation(String nodeRepresentation)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EbXMLClassification30

public EbXMLClassification30(ClassificationType classification)

Constructs a classification by wrapping the given ebXML 3.0 object.

Parameters:

classification - the object to wrap.

Method Details

getClassificationScheme

public String getClassificationScheme()

Specified by:

getClassificationScheme in interface EbXMLClassification

Returns:

the classification scheme.

getClassifiedObject

public String getClassifiedObject()

Specified by:

getClassifiedObject in interface EbXMLClassification

Returns:

the object being classified by this classification.

setClassificationScheme

public void setClassificationScheme(String classificationScheme)

Specified by:

setClassificationScheme in interface EbXMLClassification

Parameters:

classificationScheme - the classification scheme.

setClassifiedObject

public void setClassifiedObject(String classifiedObject)

Specified by:

setClassifiedObject in interface EbXMLClassification

Parameters:

classifiedObject - the object being classified by this classification.

getNodeRepresentation

public String getNodeRepresentation()

Specified by:

getNodeRepresentation in interface EbXMLClassification

Returns:

the node representation.

setNodeRepresentation

public void setNodeRepresentation(String nodeRepresentation)

Specified by:

setNodeRepresentation in interface EbXMLClassification

Parameters:

nodeRepresentation - the node representation.

getName

public LocalizedString getName()

Specified by:

getName in interface EbXMLClassification

Returns:

the name as a localized string.

getNameAsInternationalString

public EbXMLInternationalString30 getNameAsInternationalString()

Specified by:

getNameAsInternationalString in interface EbXMLClassification

Returns:

the name as an international string.

setName

public void setName(LocalizedString name)

Specified by:

setName in interface EbXMLClassification

Parameters:

name - the name as a localized string.

setClassificationNode

public void setClassificationNode(String classificationNode)

Specified by:

setClassificationNode in interface EbXMLClassification

Parameters:

classificationNode - the classification node.

getClassificationNode

public String getClassificationNode()

Specified by:

getClassificationNode in interface EbXMLClassification

Returns:

the classification node.

getInternal

public ClassificationType getInternal()

Specified by:

getInternal in interface EbXMLClassification

Returns:

the ebXML 3.0 object being wrapped by this class.

assignUniqueId

public void assignUniqueId()

Description copied from interface: EbXMLClassification

Assigns a random unique ID to this classification.

Specified by:

assignUniqueId in interface EbXMLClassification

addSlot

public void addSlot(String slotName,
 String... slotValues)

Description copied from interface: EbXMLSlotList

Adds a slot with a list of values.

Specified by:

addSlot in interface EbXMLSlotList

Parameters:

slotName - the slot name.

slotValues - the slot values. The slot will not be created if this parameter is empty or null.

getSlotValues

public List<String> getSlotValues(String slotName)

Description copied from interface: EbXMLSlotList

Gets the values of a slot.

Specified by:

getSlotValues in interface EbXMLSlotList

Parameters:

slotName - the name of the slot. It is expected that the name is only used for a single slot. Use EbXMLSlotList.getSlots(String) if it is possible that the name is used multiple times.

Returns:

the list of slot values.

getSingleSlotValue

public String getSingleSlotValue(String slotName)

Description copied from interface: EbXMLSlotList

Gets a single slot value.

Specified by:

getSingleSlotValue in interface EbXMLSlotList

Parameters:

slotName - the name of the slot. It is expected that the name is only used for a single slot. Use EbXMLSlotList.getSlots(String) if it is possible that the name is used multiple times.

Returns:

the first slot value. Other slot values are ignored. Can be null if the slot does not exist, has no slot values or the value is null.

getSlots

public List<EbXMLSlot> getSlots()

Specified by:

getSlots in interface EbXMLSlotList

Returns:

the complete list of all slots.

getSlots

public List<EbXMLSlot> getSlots(String slotName)

Description copied from interface: EbXMLSlotList

Returns a filtered list of the slots.

Specified by:

getSlots in interface EbXMLSlotList

Parameters:

slotName - name of the slots.

Returns:

the list of slots named with the given slot name.