Package org.dcm4che.typeddicom.dataelements

Class CodeValue

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CodeValue

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class CodeValue
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Code Value
Keyword: CodeValue
Tag: (0008,0100)
Value Representation: SH
Value Multiplicity: 1

• Described in the contexts:
  • Basic Code Sequence Macro > Code Value
  as follows:
  Attribute Name: Code Value
  Type: 1C
  Attribute Description:

  The identifier of the Coded Entry.

  See DICOM Standard Part 3 - Section 8.1.

  Shall be present if the code value length is 16 characters or less, and the code value is not a URN or URL.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

CodeValue

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

Creates a new Code Value object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

CodeValue

public CodeValue()

Creates a new Code Value object which wraps a new and empty Attributes object.

Method Details

copy

public CodeValue copy()

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

Returns:

a new Code Value which wraps a copy of the Attributes wrapped in this Code Value.

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.