org.dicom4j.data.elements
Class OtherByteString

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

Direct Known Subclasses:

Unknown

public class OtherByteString
extends DataElement

Other Byte (OB) DataElement

Author:

Laurent Lecomte

Constructor Summary

OtherByteString(DicomTag aTag)
Creates an empty element

Method Summary

void	clear() Clear Data contains in this Element
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.
int	getValueMultiplicity() Get the value multiplicity of this element
ValueRepresentation	getValueRepresentation() Return the value representation of this element
byte[]	getVR() Get the value representation of this attribute (OB).
boolean	isAvailableAsString() used to check if the element's value can be available as a string.
void	read(DicomInputStream aStream, long aLength, SpecificCharacterSet aCharacterSet)
void	setValues(byte[] v) Replace any existing values with the supplied array of byte.
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, addValue, 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, getStringValues, getTag, getValueLength, isGroupLength, isValid, read, removeValues, setValues, setValues

Methods inherited from class java.lang.Object

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

Constructor Detail

OtherByteString

public OtherByteString(DicomTag aTag)

Creates an empty element

Parameters:

aTag - the tag of the element

Method Detail

clear

public void clear()

Description copied from class: DataElement

Clear Data contains in this Element

Overrides:

clear in class DataElement

getByteValues

public byte[] getByteValues()
                     throws DicomException

Description copied from class: DataElement

Get the values of this attribute as a byte array.

Overrides:

getByteValues in class DataElement

Returns:

the values as an array of bytes

Throws:

DicomException

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)

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

Return the value representation of this element

Specified by:

getValueRepresentation in class DataElement

Returns:

the value representation (OB)

getVR

public byte[] getVR()

Get the value representation of this attribute (OB).

Returns:

'O','B' in ASCII as a two byte array; see

read

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

Specified by:

read in class DataElement

Parameters:

vl -

i -

Throws:

IOException

DicomException

setValues

public void setValues(byte[] v)
               throws DicomException

Description copied from class: DataElement

Replace any existing values with the supplied array of byte.

Overrides:

setValues in class DataElement

Parameters:

v -

Throws:

DicomException

isAvailableAsString

public boolean isAvailableAsString()

Description copied from class: DataElement

used to check if the element's value can be available as a string.
must be check before getSrtingxxx methods

Overrides:

isAvailableAsString in class DataElement

Returns:

true if value is available as a string

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