org.dicom4j.data.elements
Class SignedShort

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

public class SignedShort
extends DataElement

A concrete class specializing Attribute for Signed Short (SS) attributes.

Though an instance of this class may be created using its constructors, there is also a factory class, AttributeFactory.

Author:

dclunie

See Also:

DataElement, DataElementFactory

Constructor Summary

SignedShort(DicomTag t)
Construct an (empty) attribute.

Method Summary

void	addValue(int v) Add a(nother) int value after any existing values of this attribute.
void	addValue(long v) Add a(nother) long value after any existing values of this attribute.
void	addValue(short v) Add a(nother) short value after any existing values of this attribute.
int[]	getIntegerValues() Get the values of this attribute as an int array.
long[]	getLongValues() Get the values of this attribute as a long array.
short[]	getShortValues() Get the values of this attribute as a short array.
String[]	getStringValues(NumberFormat format) Get the values of this attribute as strings.
ValueRepresentation	getValueRepresentation() Return the value representation of this data element
byte[]	getVR() Get the value representation of this attribute (SS).
void	read(DicomInputStream aStream, long aLength, SpecificCharacterSet aCharacterSet)
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, clear, getByteValues, getDelimitedStringValues, getDelimitedStringValues, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDoubleValues, getDoubleValues, getFloatValues, getIntegerValues, getLongValues, getName, getOriginalStringValues, getPaddedVL, getSingleDoubleValueOrDefault, getSingleDoubleValueOrDefault, getSingleIntegerValue, getSingleIntegerValue, getSingleIntegerValue, getSingleIntegerValueOrDefault, getSingleLongValueOrDefault, getSingleLongValueOrDefault, getSingleStringValue, getSingleStringValue, getSingleStringValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrEmptyString, getSingleStringValueOrEmptyString, getSingleStringValueOrEmptyString, getSingleStringValueOrNull, getSingleStringValueOrNull, getSingleStringValueOrNull, getSingleStringValueOrNull, getStringValues, getStringValues, getStringValues, getTag, getValueLength, getValueMultiplicity, isAvailableAsString, isGroupLength, isValid, read, removeValues, setValues, setValues, setValues

Methods inherited from class java.lang.Object

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

Constructor Detail

SignedShort

public SignedShort(DicomTag t)

Construct an (empty) attribute.

Parameters:

t - the tag of the attribute

Method Detail

addValue

public void addValue(int v)
              throws DicomException

Description copied from class: DataElement

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

Overrides:

addValue in class DataElement

Parameters:

v -

Throws:

DicomException

addValue

public void addValue(long v)
              throws DicomException

Description copied from class: DataElement

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

Overrides:

addValue in class DataElement

Parameters:

v -

Throws:

DicomException

addValue

public void addValue(short v)
              throws DicomException

Description copied from class: DataElement

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

Overrides:

addValue in class DataElement

Parameters:

v -

Throws:

DicomException

getIntegerValues

public int[] getIntegerValues()
                       throws DicomException

Description copied from class: DataElement

Get the values of this attribute as an int array.

Overrides:

getIntegerValues in class DataElement

Returns:

the values as an array of int

Throws:

DicomException

getLongValues

public long[] getLongValues()
                     throws DicomException

Description copied from class: DataElement

Get the values of this attribute as a long array.

Overrides:

getLongValues in class DataElement

Returns:

the values as an array of long

Throws:

DicomException

getShortValues

public short[] getShortValues()
                       throws DicomException

Description copied from class: DataElement

Get the values of this attribute as a short array.

Overrides:

getShortValues in class DataElement

Returns:

the values as an array of short

Throws:

DicomException

getStringValues

public String[] getStringValues(NumberFormat format)
                         throws DicomException

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

getValueRepresentation

public ValueRepresentation getValueRepresentation()

Return the value representation of this data element

Specified by:

getValueRepresentation in class DataElement

Returns:

the value representation (SS)

getVR

public byte[] getVR()

Get the value representation of this attribute (SS).

Returns:

'S','S' 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

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