Package org.dcm4che.typeddicom.dataelements

Class UnformattedTextValue

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.UnformattedTextValue

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class UnformattedTextValue
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: Unformatted Text Value
Keyword: UnformattedTextValue
Tag: (0070,0006)
Value Representation: ST
Value Multiplicity: 1

• Described in the contexts:
  • Waveform Annotation Module > Waveform Annotation Sequence > Unformatted Text Value
  as follows:
  Attribute Name: Unformatted Text Value
  Type: 1C
  Attribute Description:

  Text Observation Value (annotation).

  Mutually exclusive with Concept Name Code Sequence (0040,A043)

  
  
• Described in the contexts:
  • Graphic Annotation Module > Graphic Annotation Sequence > Text Object Sequence > Unformatted Text Value
  as follows:
  Attribute Name: Unformatted Text Value
  Type: 1
  Attribute Description:

  Text data that is unformatted and whose manner of display within the defined bounding box or relative to the specified anchor point is implementation dependent. See DICOM Standard Part 3 - Section C.10.5.1.1.

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

  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:
  • Volumetric Graphic Annotation Module > Volumetric Presentation Input Annotation Sequence > Text Object Sequence > Unformatted Text Value
  as follows:
  Attribute Name: Unformatted Text Value
  Type: 1
  Attribute Description:

  Displayed text associated with the input.

  See DICOM Standard Part 3 - Section C.10.5.1.1.

  
  
• Described in the contexts:
  • Volumetric Graphic Annotation Module > Volumetric Annotation Sequence > Text Object Sequence > Unformatted Text Value
  as follows:
  Attribute Name: Unformatted Text Value
  Type: 1
  Attribute Description:

  Displayed text associated with the input Instance.

  See DICOM Standard Part 3 - Section C.10.5.1.1.

  
  
• Described in the contexts:
  • Structured Display Annotation Module > Structured Display Text Box Sequence > Unformatted Text Value
  as follows:
  Attribute Name: Unformatted Text Value
  Type: 1
  Attribute Description:

  Text data that is unformatted and whose manner of display within the defined bounding box is implementation dependent. See DICOM Standard Part 3 - Section C.11.18.1.1.

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

  The text shall be interpreted as specified by Specific Character Set (0008,0005) if present in the SOP Instance.

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

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

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

UnformattedTextValue

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

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

Parameters:

attributes - The Attributes object to be wrapped.

UnformattedTextValue

public UnformattedTextValue()

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

Method Details

copy

public UnformattedTextValue copy()

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

Returns:

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