Package org.dcm4che.typeddicom.dataelements

Class SpecimenUID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SpecimenUID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UniqueIdentifierUIDWrapper

public class SpecimenUID
extends AbstractDataElementWrapper
implements UniqueIdentifierUIDWrapper

Name: Specimen UID
Keyword: SpecimenUID
Tag: (0040,0554)
Value Representation: UI
Value Multiplicity: 1

• Described in the contexts:
  • Image Acquisition Results Module > Performed Series Sequence > Referenced Image Sequence > Specimen Description Sequence > Specimen UID
  as follows:
  Attribute Name: Specimen UID
  Type:
  Attribute Description:

  Unique identifier for the Specimen.

  
  
• Described in the contexts:
  • Specimen Macro > Specimen Description Sequence > Specimen UID
  as follows:
  Attribute Name: Specimen UID
  Type: 1
  Attribute Description:

  Unique Identifier for Specimen. See DICOM Standard Part 3 - Section C.7.6.22.1.2.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SpecimenUID.Builder<SELF extends SpecimenUID.Builder<SELF,T>,T extends SpecimenUID.Holder>
static interface	SpecimenUID.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Specimen UID" (see SpecimenUID)
static class	SpecimenUID.SimpleHolder

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.UniqueIdentifierUIDWrapper

UniqueIdentifierUIDWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends UniqueIdentifierUIDWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRIVATE_CREATOR	The Private Creator associated with this class.
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.UniqueIdentifierUIDWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
SpecimenUID()	Creates a new Specimen UID object which wraps a new and empty Attributes object.
SpecimenUID(org.dcm4che3.data.Attributes attributes)	Creates a new Specimen UID object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
SpecimenUID	copy()	Returns a new Specimen UID which wraps a copy of the Attributes wrapped in this Specimen UID.
String	getPrivateCreator()
int	getTag()

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

equals, exists, getValue, hashCode, toString

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

getAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.UniqueIdentifierUIDWrapper

getValueRepresentation

Field Details

PRIVATE_CREATOR

public static final String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

SpecimenUID

public SpecimenUID(org.dcm4che3.data.Attributes attributes)

Creates a new Specimen UID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

SpecimenUID

public SpecimenUID()

Creates a new Specimen UID object which wraps a new and empty Attributes object.

Method Details

copy

public SpecimenUID copy()

Returns a new Specimen UID which wraps a copy of the Attributes wrapped in this Specimen UID. (see Attributes(Attributes)

Returns:

a new Specimen UID which wraps a copy of the Attributes wrapped in this Specimen UID.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.