public abstract class TextAttribute extends Attribute
An abstract class specializing Attribute
for
the family of text attributes.
Modifier and Type | Field and Description |
---|---|
protected SpecificCharacterSet |
specificCharacterSet |
valueLength, valueMultiplicity
Modifier | Constructor and Description |
---|---|
protected |
TextAttribute(AttributeTag t)
Construct an (empty) attribute; called only by concrete sub-classes.
|
protected |
TextAttribute(AttributeTag t,
long vl,
DicomInputStream i,
SpecificCharacterSet specificCharacterSet)
Read an attribute from an input stream; called only by concrete sub-classes.
|
protected |
TextAttribute(AttributeTag t,
Long vl,
DicomInputStream i,
SpecificCharacterSet specificCharacterSet)
Read an attribute from an input stream; called only by concrete sub-classes.
|
protected |
TextAttribute(AttributeTag t,
SpecificCharacterSet specificCharacterSet)
Construct an (empty) attribute; called only by concrete sub-classes.
|
Modifier and Type | Method and Description |
---|---|
void |
addValue(String v)
Add a(nother)
String value after any existing values of this attribute. |
byte[] |
getByteValues()
Get the values of this attribute as a byte array.
|
long |
getPaddedVL()
Get the value length of this attribute, accounting for the need for even-length padding.
|
String[] |
getStringValues(NumberFormat format)
Get the values of this attribute as strings.
|
void |
removeValues()
Remove any existing values, making the attribute empty (zero length).
|
String |
toString(DicomDictionary dictionary)
Dump the contents of the attribute as a human-readable string.
|
protected String |
translateByteArrayToString(byte[] bytes,
int offset,
int length)
Decode a byte array into a string.
|
protected byte[] |
translateStringToByteArray(String string)
Encode a string into a byte array.
|
void |
write(DicomOutputStream o)
Write the entire attribute (including values) to the output stream.
|
addValue, addValue, addValue, addValue, addValue, addValue, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDoubleValues, getDoubleValues, getDoubleValues, getElement, getFloatValues, getFloatValues, getFloatValues, getGroup, getIntegerValues, getIntegerValues, getIntegerValues, getLongValues, getLongValues, getLongValues, getOriginalStringValues, getShortValues, getSingleDoubleValueOrDefault, getSingleDoubleValueOrDefault, getSingleDoubleValueOrDefault, getSingleFloatValueOrDefault, getSingleFloatValueOrDefault, getSingleFloatValueOrDefault, getSingleIntegerValueOrDefault, getSingleIntegerValueOrDefault, getSingleIntegerValueOrDefault, getSingleLongValueOrDefault, getSingleLongValueOrDefault, getSingleLongValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrEmptyString, getSingleStringValueOrEmptyString, getSingleStringValueOrEmptyString, getSingleStringValueOrEmptyString, getSingleStringValueOrEmptyString, getSingleStringValueOrEmptyString, getSingleStringValueOrNull, getSingleStringValueOrNull, getSingleStringValueOrNull, getSingleStringValueOrNull, getSingleStringValueOrNull, getSingleStringValueOrNull, getStringValues, getStringValues, getStringValues, getStringValues, getStringValues, getTag, getVL, getVM, getVR, getVRAsString, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValues, setValues, setValues, setValues, toString, writeBase
protected SpecificCharacterSet specificCharacterSet
protected TextAttribute(AttributeTag t)
Construct an (empty) attribute; called only by concrete sub-classes.
t
- the tag of the attributeprotected TextAttribute(AttributeTag t, SpecificCharacterSet specificCharacterSet)
Construct an (empty) attribute; called only by concrete sub-classes.
t
- the tag of the attributespecificCharacterSet
- the character set to be used for the textprotected TextAttribute(AttributeTag t, long vl, DicomInputStream i, SpecificCharacterSet specificCharacterSet) throws IOException, DicomException
Read an attribute from an input stream; called only by concrete sub-classes.
t
- the tag of the attributevl
- the value length of the attributei
- the input streamspecificCharacterSet
- the character set to be used for the textIOException
DicomException
protected TextAttribute(AttributeTag t, Long vl, DicomInputStream i, SpecificCharacterSet specificCharacterSet) throws IOException, DicomException
Read an attribute from an input stream; called only by concrete sub-classes.
t
- the tag of the attributevl
- the value length of the attributei
- the input streamspecificCharacterSet
- the character set to be used for the textIOException
DicomException
protected String translateByteArrayToString(byte[] bytes, int offset, int length)
Decode a byte array into a string.
bytes
- the byte buffer in which the encoded string is locatedoffset
- the offset into the bufferlength
- the number of bytes to be decodedprotected byte[] translateStringToByteArray(String string) throws UnsupportedEncodingException
Encode a string into a byte array.
string
- the string to be encodedUnsupportedEncodingException
public long getPaddedVL()
Attribute
Get the value length of this attribute, accounting for the need for even-length padding.
getPaddedVL
in class Attribute
public void write(DicomOutputStream o) throws DicomException, IOException
Attribute
Write the entire attribute (including values) to the output stream.
write
in class Attribute
o
- IOException
DicomException
public String toString(DicomDictionary dictionary)
Attribute
Dump the contents of the attribute as a human-readable string.
No new line is appended.
The result is of the form:
(0xgggg,0xeeee) Name VR=<XX> VL=<0xnnnn> <...>
For example:
(0x0018,0x0020) ScanningSequence VR=<CS> VL=<0x2> <GR>
public byte[] getByteValues() throws DicomException
Get the values of this attribute as a byte array.
getByteValues
in class Attribute
DicomException
- thrown if values are not availablepublic String[] getStringValues(NumberFormat format) throws DicomException
Attribute
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.
getStringValues
in class Attribute
format
- the format to use for each numerical or decimal valueString
DicomException
public void addValue(String v) throws DicomException
Attribute
String
value after any existing values of this attribute.addValue
in class Attribute
v
- DicomException
public void removeValues() throws DicomException
Attribute
Remove any existing values, making the attribute empty (zero length).
removeValues
in class Attribute
DicomException