Package org.dcm4che.typeddicom.dataelements

Class TextValue

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.TextValue

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UnlimitedTextWrapper

public class TextValue
extends AbstractDataElementWrapper
implements UnlimitedTextWrapper

Name: Text Value
Keyword: TextValue
Tag: (0040,A160)
Value Representation: UT
Value Multiplicity: 1

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

  This is the value of the Content Item.

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

  Text data that is unformatted and whose manner of display is implementation dependent.

  The text value may contain spaces, as well as multiple lines separated by CR LF, but otherwise no format control characters (such as horizontal or vertical tab and form feed) shall be present, even if permitted by the Value Representation of UT.

  The text shall be interpreted as specified by Specific Character Set (0008,0005) if present in the DICOM Standard Part 3 - Section C.12.1.

  Note

  The text may contain single or multi-byte characters and use code extension techniques as described in PS3.5 PS3.5 if permitted by the values of Specific Character Set (0008,0005).

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

  Text value for this name-value Item.

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

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
TextValue()	Creates a new Text Value object which wraps a new and empty Attributes object.
TextValue(org.dcm4che3.data.Attributes attributes)	Creates a new Text Value object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
TextValue	copy()	Returns a new Text Value which wraps a copy of the Attributes wrapped in this Text Value.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

TextValue

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

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

Parameters:

attributes - The Attributes object to be wrapped.

TextValue

public TextValue()

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

Method Details

copy

public TextValue copy()

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

Returns:

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

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.