org.dcm4chee.xds2.persistence

Class ClassificationScheme

java.lang.Object

org.dcm4chee.xds2.persistence.Identifiable

org.dcm4chee.xds2.persistence.RegistryObject

org.dcm4chee.xds2.persistence.ClassificationScheme

All Implemented Interfaces:

Serializable

@Entity
public class ClassificationScheme
extends RegistryObject
implements Serializable

A ClassificationScheme instance describes a taxonomy. The taxonomy hierarchy may be defined internally to the registry by instances of ClassificationNode, or it may be defined externally to the Registry, in which case the structure and values of the taxonomy elements are not known to the Registry.

Since:

Nov 02, 2011

Version:

$Revision$ $Date$

Author:

Franz Willer

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.dcm4chee.xds2.persistence.RegistryObject

RegistryObject.XDSSearchIndexKey

Field Summary

Fields inherited from class org.dcm4chee.xds2.persistence.RegistryObject

INDEX_XPATHS, marshallerThreadLocal, unmarshallerThreadLocal

Constructor Summary

Constructors

Constructor and Description
ClassificationScheme()

Method Summary

Methods

Modifier and Type	Method and Description
String	getNodeType() When submitting a ClassificationScheme instance the Submitting Organization MUST declare the structure of taxonomy nodes within the ClassificationScheme via the nodeType attribute.
boolean	isInternal() When submitting a ClassificationScheme instance the submitter MUST declare whether the ClassificationScheme instance represents an internal or an external taxonomy.
void	setInternal(boolean isInternal)
void	setNodeType(String nodeType)

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

getClassifications, getComment, getDescription, getExternalIdentifiers, getFullObject, getIndexedValues, getLid, getName, getObjectType, getStatus, getVersionName, getXml, setComment, setDescription, setHome, setId, setIndexedValues, setLid, setName, setObjectType, setSlotTypes, setStatus, setVersionName, setXml

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

Constructor Detail

ClassificationScheme

public ClassificationScheme()

Method Detail

isInternal

public boolean isInternal()

When submitting a ClassificationScheme instance the submitter MUST declare whether the ClassificationScheme instance represents an internal or an external taxonomy. This allows the registry to validate the subsequent submissions of ClassificationNode and Classification instances in order to maintain the type of ClassificationScheme consistent throughout its lifecycle.

Returns:

setInternal

public void setInternal(boolean isInternal)

getNodeType

public String getNodeType()

When submitting a ClassificationScheme instance the Submitting Organization MUST declare the structure of taxonomy nodes within the ClassificationScheme via the nodeType attribute. The value of the nodeType attribute MUST be a reference to a ClassificationNode within the canonical NodeType ClassificationScheme. A Registry MUST support the node types as defined by the canonical NodeType ClassificationScheme. The canonical NodeType ClassificationScheme MAY easily be extended by adding additional ClassificationNodes to it. The following canonical values are defined for the NodeType ClassificationScheme: - UniqueCode: This value indicates that each node of the taxonomy has a unique code assigned to it. - EmbeddedPath: This value indicates that the unique code assigned to each node of the taxonomy also encodes its path. This is the case in the NAICS taxonomy. - NonUniqueCode: In some cases nodes are not unique, and it is necessary to use the full path (from ClassificationScheme to the node of interest) in order to identify the node. For example, in a geography taxonomy Moscow could be under both Russia and the USA, where there are five cities of that name in different states.

Returns:

setNodeType

public void setNodeType(String nodeType)