Package org.dcm4che.typeddicom.dataelements

Class UserContentLabel

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.UserContentLabel

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class UserContentLabel
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: User Content Label
Keyword: UserContentLabel
Tag: (3010,0033)
Value Representation: SH
Value Multiplicity: 1

• Described in the contexts:
  • Enhanced Content Identification Macro > User Content Label
  as follows:
  Attribute Name: User Content Label
  Type: 1
  Attribute Description:

  User-defined label for this SOP Instance.

  See DICOM Standard Part 3 - Section 10.9.1.1.1.

  
  

Nested Class Summary

Nested Classes

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

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

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

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.ShortStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
UserContentLabel()	Creates a new User Content Label object which wraps a new and empty Attributes object.
UserContentLabel(org.dcm4che3.data.Attributes attributes)	Creates a new User Content Label object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
UserContentLabel	copy()	Returns a new User Content Label which wraps a copy of the Attributes wrapped in this User Content Label.
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.ShortStringWrapper

getValueRepresentation

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

getString, setString

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

UserContentLabel

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

Creates a new User Content Label object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

UserContentLabel

public UserContentLabel()

Creates a new User Content Label object which wraps a new and empty Attributes object.

Method Details

copy

public UserContentLabel copy()

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

Returns:

a new User Content Label which wraps a copy of the Attributes wrapped in this User Content Label.

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.