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

Class EbXMLRegistryObject30<E extends RegistryObjectType>

java.lang.Object

org.openehealth.ipf.commons.ihe.xds.core.ebxml.ebxml30.EbXMLRegistryObject30<E>

Type Parameters:

E - the EBXML type of the registry object.

All Implemented Interfaces:

EbXMLRegistryObject, EbXMLSlotList

Direct Known Subclasses:

EbXMLAssociation30, EbXMLExtrinsicObject30, EbXMLRegistryPackage30

public abstract class EbXMLRegistryObject30<E extends RegistryObjectType>
extends Object
implements EbXMLRegistryObject

Encapsulation of RegistryObjectType.

Author:

Jens Riemschneider

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EbXMLRegistryObject30(E registryEntry, EbXMLObjectLibrary objectLibrary)	Constructs a registry entry by wrapping the given ebXML 3.0 object.

Method Summary

Modifier and Type	Method	Description
void	addClassification(EbXMLClassification classification, String scheme)	Adds a classification to this entry with a random id.
void	addExternalIdentifier(String value, String scheme, String name)	Adds a new external identifier to this entry.
void	addSlot(String slotName, String... slotValues)	Adds a slot with a list of values.
List<EbXMLClassification>	getClassifications()
List<EbXMLClassification>	getClassifications(String scheme)	Returns the classification matching the given scheme.
LocalizedString	getDescription()
List<EbXMLExternalIdentifier>	getExternalIdentifiers()
String	getExternalIdentifierValue(String scheme)	Returns the value of the external identifier matching the given scheme.
String	getHome()
String	getId()
E	getInternal()
String	getLid()
LocalizedString	getName()
protected EbXMLObjectLibrary	getObjectLibrary()
String	getObjectType()
EbXMLClassification	getSingleClassification(String scheme)	Returns the first classification matching the given scheme.
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.
Version	getVersionInfo()
void	setDescription(LocalizedString description)
void	setHome(String home)
void	setId(String id)
void	setLid(String lid)
void	setName(LocalizedString name)
void	setObjectType(String objectType)
void	setVersionInfo(Version version)

Methods inherited from class java.lang.Object

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

Constructor Details

EbXMLRegistryObject30

protected EbXMLRegistryObject30(E registryEntry,
 EbXMLObjectLibrary objectLibrary)

Constructs a registry entry by wrapping the given ebXML 3.0 object.

Parameters:

registryEntry - the object to wrap.

objectLibrary - the object library to use.

Method Details

getObjectLibrary

protected EbXMLObjectLibrary getObjectLibrary()

Returns:

the object library.

addClassification

public void addClassification(EbXMLClassification classification,
 String scheme)

Description copied from interface: EbXMLRegistryObject

Adds a classification to this entry with a random id.

Specified by:

addClassification in interface EbXMLRegistryObject

Parameters:

classification - the classification to add.

scheme - the scheme of the classification.

addExternalIdentifier

public void addExternalIdentifier(String value,
 String scheme,
 String name)

Description copied from interface: EbXMLRegistryObject

Adds a new external identifier to this entry.

Specified by:

addExternalIdentifier in interface EbXMLRegistryObject

Parameters:

value - the value of the identifier.

scheme - the scheme of the identifier.

name - the name of the identifier.

getClassifications

public List<EbXMLClassification> getClassifications()

Specified by:

getClassifications in interface EbXMLRegistryObject

Returns:

all classifications contained in this entry.

getClassifications

public List<EbXMLClassification> getClassifications(String scheme)

Description copied from interface: EbXMLRegistryObject

Returns the classification matching the given scheme.

Specified by:

getClassifications in interface EbXMLRegistryObject

Parameters:

scheme - the scheme.

Returns:

the classifications contained in this entry that match the scheme.

getDescription

public LocalizedString getDescription()

Specified by:

getDescription in interface EbXMLRegistryObject

Returns:

the description of this entry.

getExternalIdentifierValue

public String getExternalIdentifierValue(String scheme)

Description copied from interface: EbXMLRegistryObject

Returns the value of the external identifier matching the given scheme.

Specified by:

getExternalIdentifierValue in interface EbXMLRegistryObject

Parameters:

scheme - the scheme of the external identifier.

Returns:

the value of the external identifier that matched the scheme. null if no identifier was found that matched the scheme.

getExternalIdentifiers

public List<EbXMLExternalIdentifier> getExternalIdentifiers()

Specified by:

getExternalIdentifiers in interface EbXMLRegistryObject

Returns:

all external identifiers contained in this entry.

getId

public String getId()

Specified by:

getId in interface EbXMLRegistryObject

Returns:

the id of this entry.

setId

public void setId(String id)

Specified by:

setId in interface EbXMLRegistryObject

Parameters:

id - the id of this entry.

getLid

public String getLid()

Specified by:

getLid in interface EbXMLRegistryObject

Returns:

the lid of this entry.

setLid

public void setLid(String lid)

Specified by:

setLid in interface EbXMLRegistryObject

Parameters:

lid - the lid of this entry.

getVersionInfo

public Version getVersionInfo()

Specified by:

getVersionInfo in interface EbXMLRegistryObject

Returns:

the id of this entry.

setVersionInfo

public void setVersionInfo(Version version)

Specified by:

setVersionInfo in interface EbXMLRegistryObject

Parameters:

version - the versionInfo of this entry.

getName

public LocalizedString getName()

Specified by:

getName in interface EbXMLRegistryObject

Returns:

the name of this entry.

getObjectType

public String getObjectType()

Specified by:

getObjectType in interface EbXMLRegistryObject

Returns:

the object type of this entry.

getSingleClassification

public EbXMLClassification getSingleClassification(String scheme)

Description copied from interface: EbXMLRegistryObject

Returns the first classification matching the given scheme.

Specified by:

getSingleClassification in interface EbXMLRegistryObject

Parameters:

scheme - the scheme.

Returns:

the classification matching the scheme. Only the first classification is considered, other classifications are ignored.

setDescription

public void setDescription(LocalizedString description)

Specified by:

setDescription in interface EbXMLRegistryObject

Parameters:

description - the description of this entry.

setName

public void setName(LocalizedString name)

Specified by:

setName in interface EbXMLRegistryObject

Parameters:

name - the name of this entry.

setObjectType

public void setObjectType(String objectType)

Specified by:

setObjectType in interface EbXMLRegistryObject

Parameters:

objectType - the object type of this entry.

getHome

public String getHome()

Specified by:

getHome in interface EbXMLRegistryObject

Returns:

the home attribute of this entry.

setHome

public void setHome(String home)

Specified by:

setHome in interface EbXMLRegistryObject

Parameters:

home - the home attribute of this entry.

getInternal

public E getInternal()

Specified by:

getInternal in interface EbXMLRegistryObject

Returns:

the ebXML object being wrapped by this entry.

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.