org.dcm4chee.xds2.persistence

Class RegistryObject

java.lang.Object

org.dcm4chee.xds2.persistence.Identifiable

org.dcm4chee.xds2.persistence.RegistryObject

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Association, AuditableEvent, ClassificationNode, ClassificationScheme, ExternalLink, ExtrinsicObject, RegistryPackage

@Entity
public abstract class RegistryObject
extends Identifiable
implements Serializable

The RegistryObject class extends the Identifiable class and serves as a common super class for most classes in the information model.

Since:

Nov 02, 2011

Version:

$Revision$ $Date$

Author:

Franz Willer

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegistryObject.XDSSearchIndexKey Searchtable keys for which index can be enabled. Defined in a single location to prevent name clashes, and to use enum binding for a field in the searchtable

Field Summary

Fields

Modifier and Type	Field and Description
static Map<RegistryObject.XDSSearchIndexKey,String>	INDEX_XPATHS
static ThreadLocal<Marshaller>	marshallerThreadLocal
static ThreadLocal<Unmarshaller>	unmarshallerThreadLocal

Constructor Summary

Constructors

Constructor and Description
RegistryObject()

Method Summary

Methods

Modifier and Type	Method and Description
Collection<org.dcm4chee.xds2.infoset.rim.ClassificationType>	getClassifications()
String	getComment() VerionInfo (flattened: VersionName, Comment)
org.dcm4chee.xds2.infoset.rim.InternationalStringType	getDescription()
Collection<org.dcm4chee.xds2.infoset.rim.ExternalIdentifierType>	getExternalIdentifiers()
org.dcm4chee.xds2.infoset.rim.RegistryObjectType	getFullObject() Will lazily fetch the blob from the DB, in not done already.
Set<RegistryObjectIndex>	getIndexedValues() Indexed properties that are used in queries.
String	getLid() Each RegistryObject instance MUST have a lid (Logical Id) attribute .
org.dcm4chee.xds2.infoset.rim.InternationalStringType	getName()
String	getObjectType() Each RegistryObject instance has an objectType attribute.
String	getStatus() Each RegistryObject instance has an objectType attribute.
String	getVersionName() VerionInfo (flattened: VersionName, Comment) Each RegistryObject instance MAY have a versionInfo attribute.
byte[]	getXml() The blob
void	setComment(String comment)
void	setDescription(org.dcm4chee.xds2.infoset.rim.InternationalStringType description)
void	setHome(String home)
void	setId(String id)
void	setIndexedValues(Set<RegistryObjectIndex> indexedValues)
void	setLid(String lid)
void	setName(org.dcm4chee.xds2.infoset.rim.InternationalStringType name)
void	setObjectType(String objectType)
void	setSlotTypes(List<org.dcm4chee.xds2.infoset.rim.SlotType1> slotTs)
void	setStatus(String status)
void	setVersionName(String versionName)
void	setXml(byte[] xml)

Methods inherited from class org.dcm4chee.xds2.persistence.Identifiable

equals, getHome, getId, getPk, getSlots, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INDEX_XPATHS

public static final Map<RegistryObject.XDSSearchIndexKey,String> INDEX_XPATHS

marshallerThreadLocal

public static ThreadLocal<Marshaller> marshallerThreadLocal

unmarshallerThreadLocal

public static ThreadLocal<Unmarshaller> unmarshallerThreadLocal

Constructor Detail

RegistryObject

public RegistryObject()

Method Detail

getXml

public byte[] getXml()
              throws JAXBException

The blob

Throws:

JAXBException

setXml

public void setXml(byte[] xml)
            throws JAXBException

Throws:

JAXBException

getIndexedValues

public Set<RegistryObjectIndex> getIndexedValues()

Indexed properties that are used in queries. Do not use the setter - the update is fully seamless - when object is merged/persisted - indexes are re/-created and updated if needed

Returns:

setIndexedValues

public void setIndexedValues(Set<RegistryObjectIndex> indexedValues)

getClassifications

public Collection<org.dcm4chee.xds2.infoset.rim.ClassificationType> getClassifications()

getDescription

public org.dcm4chee.xds2.infoset.rim.InternationalStringType getDescription()

setDescription

public void setDescription(org.dcm4chee.xds2.infoset.rim.InternationalStringType description)

getName

public org.dcm4chee.xds2.infoset.rim.InternationalStringType getName()

setName

public void setName(org.dcm4chee.xds2.infoset.rim.InternationalStringType name)

getExternalIdentifiers

public Collection<org.dcm4chee.xds2.infoset.rim.ExternalIdentifierType> getExternalIdentifiers()

setHome

public void setHome(String home)

Overrides:

setHome in class Identifiable

setId

public void setId(String id)

Overrides:

setId in class Identifiable

setSlotTypes

public void setSlotTypes(List<org.dcm4chee.xds2.infoset.rim.SlotType1> slotTs)

Overrides:

setSlotTypes in class Identifiable

getLid

public String getLid()

Each RegistryObject instance MUST have a lid (Logical Id) attribute . The lid is used to refer to a logical RegistryObject in a version independent manner. All versions of a RegistryObject MUST have the same value for the lid attribute. Note that this is in contrast with the id attribute that MUST be unique for each version of the same logical RegistryObject. The lid attribute MAY be specified by the submitter when creating the original version of a RegistryObject. If the submitter assigns the lid attribute, she must guarantee that it is a globally unique URN. A registry MUST honor a valid submittersupplied LID. If the submitter does not specify a LID then the registry MUST assign a LID and the value of the LID attribute MUST be identical to the value of the id attribute of the first (originally created) version of the logical RegistryObject.

Returns:

setLid

public void setLid(String lid)

getObjectType

public String getObjectType()

Each RegistryObject instance has an objectType attribute. The value of the objectType attribute MUST be a reference to a ClassificationNode in the canonical ObjectType ClassificationScheme. A Registry MUST support the object types as defined by the ObjectType ClassificationScheme. The canonical ObjectType ClassificationScheme may easily be extended by adding additional ClassificationNodes to the canonical ObjectType ClassificationScheme. The objectType for almost all objects in the information model matches the ClassificationNode that corresponds to the name of their class. For example the objectType for a Classification is a reference to the ClassificationNode with code 'Classification' in the canonical ObjectType ClassificationScheme. The only exception to this rule is that the objectType for an ExtrinsicObject or an ExternalLink instance MAY be defined by the submitter and indicates the type of content associated with that object. A registry MUST set the correct objectType on a RegistryObject when returning it as a response to a client request. A client MAY set the objectType on a RegistryObject when submitting the object. A client SHOULD set the objectType when the object is an ExternalLink or an ExtrinsicObject since content pointed to or described by these types may be of arbitrary objectType.

Returns:

setObjectType

public void setObjectType(String objectType)

getStatus

public String getStatus()

Each RegistryObject instance has an objectType attribute. The value of the objectType attribute MUST be a reference to a ClassificationNode in the canonical ObjectType ClassificationScheme. A Registry MUST support the object types as defined by the ObjectType ClassificationScheme. The canonical ObjectType ClassificationScheme may easily be extended by adding additional ClassificationNodes to the canonical ObjectType ClassificationScheme. The objectType for almost all objects in the information model matches the ClassificationNode that corresponds to the name of their class. For example the objectType for a Classification is a reference to the ClassificationNode with code 'Classification' in the canonical ObjectType ClassificationScheme. The only exception to this rule is that the objectType for an ExtrinsicObject or an ExternalLink instance MAY be defined by the submitter and indicates the type of content associated with that object. A registry MUST set the correct objectType on a RegistryObject when returning it as a response to a client request. A client MAY set the objectType on a RegistryObject when submitting the object. A client SHOULD set the objectType when the object is an ExternalLink or an ExtrinsicObject since content pointed to or described by these types may be of arbitrary objectType.

Returns:

setStatus

public void setStatus(String status)

getVersionName

public String getVersionName()

VerionInfo (flattened: VersionName, Comment) Each RegistryObject instance MAY have a versionInfo attribute. The value of the versionInfo attribute MUST be of type VersionInfo. The versionInfo attribute provides information about the specific version of a RegistryObject. The versionInfo attribute is set by the registry.

Returns:

setVersionName

public void setVersionName(String versionName)

getComment

public String getComment()

VerionInfo (flattened: VersionName, Comment)

Returns:

setComment

public void setComment(String comment)

getFullObject

public org.dcm4chee.xds2.infoset.rim.RegistryObjectType getFullObject()

Will lazily fetch the blob from the DB, in not done already. If the returned object is changed, the changes will be persisted in case the entity is persisted!

Returns: