Package org.dcm4che.typeddicom.dataelements

Class UID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.UID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UniqueIdentifierUIDWrapper

public class UID
extends AbstractDataElementWrapper
implements UniqueIdentifierUIDWrapper

Name: UID
Keyword: UID
Tag: (0040,A124)
Value Representation: UI
Value Multiplicity: 1

• Described in the contexts:
  • Document Content Macro > UID
  as follows:
  Attribute Name: UID
  Type: 1C
  Attribute Description:

  This is the value of the Content Item.

  Required if Value Type (0040,A040) is UIDREF.

  
  
• Described in the contexts:
  • Content Item Macro Description > UID
  as follows:
  Attribute Name: UID
  Type: 1C
  Attribute Description:

  UID value for this name-value Item.

  Required if Value Type (0040,A040) is UIDREF.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UID.Builder<SELF extends UID.Builder<SELF,T>,T extends UID.Holder>
static interface	UID.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "UID" (see UID)
static class	UID.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
UID()	Creates a new UID object which wraps a new and empty Attributes object.
UID(org.dcm4che3.data.Attributes attributes)	Creates a new UID object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
UID	copy()	Returns a new UID which wraps a copy of the Attributes wrapped in this 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

UID

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

Creates a new UID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

UID

public UID()

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

Method Details

copy

public UID copy()

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

Returns:

a new UID which wraps a copy of the Attributes wrapped in this 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.