org.dicom4j.data.elements.support
Class TextElement

java.lang.Object
  org.dicom4j.data.elements.support.DataElement
      org.dicom4j.data.elements.support.TextElement

Direct Known Subclasses:

LongText, ShortText, UnlimitedText

public abstract class TextElement
extends DataElement

An abstract class specializing Attribute for the family of text attributes.

Since:

0.0.0

Author:

Laurent Lecomte

Method Summary

void	addValue(String v) Deprecated.
void	clear() Clear Data contains in this Element
long	getPaddedVL() Get the value length of this attribute, accounting for the need for even-length padding.
String[]	getStringValues(NumberFormat format) Deprecated.
String	getValue()
long	getValueLength() Gets the value length
int	getValueMultiplicity() Get the value multiplicity of this element
ValueRepresentation	getValueRepresentation() Return the ValueRepresentation of this element
void	read(DicomInputStream aStream, long aLength, SpecificCharacterSet aCharacterSet)
void	removeValues() Deprecated. use clear()
void	setValue(String aValue)
String	toString() Dump the contents of the attribute as a human-readable string.
void	write(DicomOutputStream o) Write the entire attribute (including values) to the output stream.

Methods inherited from class org.dicom4j.data.elements.support.DataElement

addValue, addValue, addValue, addValue, addValue, addValue, getByteValues, getDelimitedStringValues, getDelimitedStringValues, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDoubleValues, getDoubleValues, getFloatValues, getIntegerValues, getIntegerValues, getLongValues, getLongValues, getName, getOriginalStringValues, getShortValues, getSingleDoubleValueOrDefault, getSingleDoubleValueOrDefault, getSingleIntegerValue, getSingleIntegerValue, getSingleIntegerValue, getSingleIntegerValueOrDefault, getSingleLongValueOrDefault, getSingleLongValueOrDefault, getSingleStringValue, getSingleStringValue, getSingleStringValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrEmptyString, getSingleStringValueOrEmptyString, getSingleStringValueOrEmptyString, getSingleStringValueOrNull, getSingleStringValueOrNull, getSingleStringValueOrNull, getSingleStringValueOrNull, getStringValues, getStringValues, getStringValues, getTag, isAvailableAsString, isGroupLength, isValid, read, setValues, setValues, setValues

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

addValue

@Deprecated
public void addValue(String v)
              throws DicomException

Deprecated.

Description copied from class: DataElement

Add a(nother) String value after any existing values of this attribute.

Overrides:

addValue in class DataElement

Parameters:

v -

Throws:

DicomException

clear

public void clear()

Description copied from class: DataElement

Clear Data contains in this Element

Overrides:

clear in class DataElement

getPaddedVL

public long getPaddedVL()

Description copied from class: DataElement

Get the value length of this attribute, accounting for the need for even-length padding.

Overrides:

getPaddedVL in class DataElement

Returns:

the value length (padded to an even length)

getStringValues

@Deprecated
public String[] getStringValues(NumberFormat format)
                         throws DicomException

Deprecated.

Description copied from class: DataElement

Get the values of this attribute as strings.

The strings may have been cleaned up into a canonical form, such as to remove padding as well as numbers formatted.

Overrides:

getStringValues in class DataElement

Parameters:

format - the format to use for each numerical or decimal value

Returns:

the values as an array of String

Throws:

DicomException

getValue

public String getValue()

getValueLength

public long getValueLength()

Description copied from class: DataElement

Gets the value length

Overrides:

getValueLength in class DataElement

Returns:

the value length (does not include need for even-length padding, hence may be odd length)

getValueMultiplicity

public int getValueMultiplicity()

Description copied from class: DataElement

Get the value multiplicity of this element

Overrides:

getValueMultiplicity in class DataElement

Returns:

the value multiplicity

getValueRepresentation

public ValueRepresentation getValueRepresentation()

Description copied from class: DataElement

Return the ValueRepresentation of this element

Specified by:

getValueRepresentation in class DataElement

Returns:

the ValueRepresentation

read

public void read(DicomInputStream aStream,
                 long aLength,
                 SpecificCharacterSet aCharacterSet)
          throws IOException,
                 DicomException

Specified by:

read in class DataElement

Parameters:

vl -

i -

specificCharacterSet -

Throws:

IOException

DicomException

removeValues

@Deprecated
public void removeValues()
                  throws DicomException

Deprecated. use clear()

Description copied from class: DataElement

Remove any existing values, making the attribute empty (zero length).

Overrides:

removeValues in class DataElement

Throws:

DicomException

setValue

public void setValue(String aValue)

toString

public String toString()

Description copied from class: DataElement

Dump the contents of the attribute as a human-readable string.

No new line is appended.

The result is of the form:

 (0xgggg,0xeeee) VR=<XX> VL=<0xnnnn> <...>
 

For example:

 (0x0018,0x0020) VR=<CS> VL=<0x2> <GR>
 

Overrides:

toString in class DataElement

Returns:

a single String value

write

public void write(DicomOutputStream o)
           throws DicomException,
                  IOException

Description copied from class: DataElement

Write the entire attribute (including values) to the output stream.

Specified by:

write in class DataElement

Parameters:

o -

Throws:

IOException

DicomException