org.dicom4j.data.elements.support
Class DataElement

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

Direct Known Subclasses:

AttributeTag, FloatingPointDouble, FloatingPointSingle, OtherByteString, OtherFloatString, OtherWordString, SequenceOfItems, SignedLong, SignedShort, StringElement, TextElement, UnsignedLong, UnsignedShort

public abstract class DataElement
extends Object

abstract class that contains the core functionality for storing, accessing and maintaining values of a DICOM Attribute.

Though instances of concrete sub-classes of this abstract class may be created using their constructors, there is also a factory class, DataElementFactory.

Since:

0.0.0

Author:

Laurent Lecomte

See Also:

DataElementFactory

Method Summary

void	addValue(byte v) Add a(nother) byte value after any existing values of this attribute.
void	addValue(double v) Add a(nother) double value after any existing values of this attribute.
void	addValue(float v) Add a(nother) float value after any existing values of this attribute.
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.
void	addValue(String v) Add a(nother) String value after any existing values of this attribute.
void	clear() Clear Data contains in this Element
byte[]	getByteValues() Get the values of this attribute as a byte array.
String	getDelimitedStringValues()
String	getDelimitedStringValues(String aDefault) Get all the string values for the attribute, separated by the appropriate delimiter.
static String	getDelimitedStringValuesOrDefault(DataSet list, DicomTag tag, String dflt) Get all the string values for a named attribute in an attribute list, separated by the appropriate delimiter.
static String	getDelimitedStringValuesOrDefault(DataSet list, DicomTag tag, String dflt, NumberFormat format) Get all the string values for a named attribute in an attribute list, separated by the appropriate delimiter.
String	getDelimitedStringValuesOrDefault(String dflt, NumberFormat format) Get all the string values for the attribute, separated by the appropriate delimiter.
String	getDelimitedStringValuesOrEmptyString() Get all the string values for the attribute, separated by the appropriate delimiter.
static String	getDelimitedStringValuesOrEmptyString(DataSet list, DicomTag tag) Get all the string values for a named attribute in an attribute list, separated by the appropriate delimiter.
static String	getDelimitedStringValuesOrEmptyString(DataSet list, DicomTag tag, NumberFormat format) Get all the string values for a named attribute in an attribute list, separated by the appropriate delimiter.
String	getDelimitedStringValuesOrEmptyString(NumberFormat format) Get all the string values for the attribute, separated by the appropriate delimiter.
String	getDelimitedStringValuesOrNull() Get all the string values for the attribute, separated by the appropriate delimiter.
static String	getDelimitedStringValuesOrNull(DataSet list, DicomTag tag) Get all the string values for a named attribute in an attribute list, separated by the appropriate delimiter.
static String	getDelimitedStringValuesOrNull(DataSet list, DicomTag tag, NumberFormat format) Get all the string values for a named attribute in an attribute list, separated by the appropriate delimiter.
String	getDelimitedStringValuesOrNull(NumberFormat format) Get all the string values for the attribute, separated by the appropriate delimiter.
double[]	getDoubleValues() Get the values of this attribute as a double array.
static double[]	getDoubleValues(DataSet list, DicomTag tag) Get the values of a named attribute in an attribute list, as an array of double.
float[]	getFloatValues() Get the values of this attribute as a float array.
int[]	getIntegerValues() Get the values of this attribute as an int array.
static int[]	getIntegerValues(DataSet list, DicomTag tag) Get the values of a named attribute in an attribute list, as an array of int.
long[]	getLongValues() Get the values of this attribute as a long array.
static long[]	getLongValues(DataSet list, DicomTag tag) Get the values of a named attribute in an attribute list, as an array of long.
String	getName()
String[]	getOriginalStringValues() Get the values of this attribute as strings, the way they were originally inserted or read.
long	getPaddedVL() Get the value length of this attribute, accounting for the need for even-length padding.
short[]	getShortValues() Get the values of this attribute as a short array.
static double	getSingleDoubleValueOrDefault(DataSet list, DicomTag tag, double dflt) Get a single double value of a named attribute in an attribute list.
double	getSingleDoubleValueOrDefault(double dflt) Get a single double value for the attribute.
int	getSingleIntegerValue()
static int	getSingleIntegerValue(DataSet aDataSet, DicomTag aTag, int aDefault)
int	getSingleIntegerValue(int aDefault) Get a single int value for the attribute.
static int	getSingleIntegerValueOrDefault(DataSet list, DicomTag tag, int dflt) Get a single int value of a named attribute in an attribute list.
static long	getSingleLongValueOrDefault(DataSet list, DicomTag tag, long dflt) Get a single long value of a named attribute in an attribute list.
long	getSingleLongValueOrDefault(long dflt) Get a single long value for the attribute.
String	getSingleStringValue() Get a single string value If there is more than one string value, only the first is returned.
String	getSingleStringValue(String dflt) Get a single string value for the attribute.
static String	getSingleStringValueOrDefault(DataSet aDataset, DicomTag tag, String aDefault) Get a single string value for a named attribute in an attribute list.
static String	getSingleStringValueOrDefault(DataSet list, DicomTag tag, String dflt, NumberFormat format) Get a single string value for a named attribute in an attribute list.
String	getSingleStringValueOrDefault(String dflt, NumberFormat format) Get a single string value for the attribute.
static String	getSingleStringValueOrEmptyString(DataSet list, DicomTag tag) Get a single string value for a named attribute in an attribute list.
static String	getSingleStringValueOrEmptyString(DataSet list, DicomTag tag, NumberFormat format) Get a single string value for a named attribute in an attribute list.
String	getSingleStringValueOrEmptyString(NumberFormat format) Get a single string value for the attribute.
String	getSingleStringValueOrNull() Get a single string value for the attribute.
static String	getSingleStringValueOrNull(DataSet list, DicomTag tag) Get a single string value for a named attribute in an attribute list.
static String	getSingleStringValueOrNull(DataSet list, DicomTag tag, NumberFormat format) Get a single string value for a named attribute in an attribute list.
String	getSingleStringValueOrNull(NumberFormat format) Get a single string value for the attribute.
String[]	getStringValues() Get the values of this attribute as strings.
static String[]	getStringValues(DataSet list, DicomTag tag) Get the values of a named attribute in an attribute list, as an array of strings.
static String[]	getStringValues(DataSet list, DicomTag tag, NumberFormat format) Get the values of a named attribute in an attribute list, as an array of strings.
String[]	getStringValues(NumberFormat format) Get the values of this attribute as strings.
DicomTag	getTag() Return element's tag
long	getValueLength() Gets the value length
int	getValueMultiplicity() Get the value multiplicity of this element
abstract ValueRepresentation	getValueRepresentation() Return the ValueRepresentation of this element
boolean	isAvailableAsString() used to check if the element's value can be available as a string.
static boolean	isGroupLength(DataElement aDataElement) Return true if the DataElement represent a group length element (ie: the value of Element is equal to 0x0000)
boolean	isValid() check is the data of this element is Dicom compliant
void	read(DicomInputStream aStream, long aLength) Read data from a stream
abstract void	read(DicomInputStream aStream, long aLength, SpecificCharacterSet aCharacterSet)
void	removeValues() Remove any existing values, making the attribute empty (zero length).
void	setValues(byte[] v) Replace any existing values with the supplied array of byte.
void	setValues(float[] v) Replace any existing values with the supplied array of float.
void	setValues(short[] v) Replace any existing values with the supplied array of short.
String	toString() Dump the contents of the attribute as a human-readable string.
abstract void	write(DicomOutputStream o) Write the entire attribute (including values) to the output stream.

Methods inherited from class java.lang.Object

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

Method Detail

getDelimitedStringValuesOrDefault

public static String getDelimitedStringValuesOrDefault(DataSet list,
                                                       DicomTag tag,
                                                       String dflt)

Get all the string values for a named attribute in an attribute list, separated by the appropriate delimiter.

If there is no such attribute, the supplied default is returned.

If there is no string value, the supplied default is returned.

If there is an exception trying to fetch the values, the supplied default is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

dflt - what to return if there are no (valid) string values

Returns:

the values as a delimited String

getDelimitedStringValuesOrDefault

public static String getDelimitedStringValuesOrDefault(DataSet list,
                                                       DicomTag tag,
                                                       String dflt,
                                                       NumberFormat format)

Get all the string values for a named attribute in an attribute list, separated by the appropriate delimiter.

If there is no such attribute, the supplied default is returned.

If there is no string value, the supplied default is returned.

If there is an exception trying to fetch the values, the supplied default is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

dflt - what to return if there are no (valid) string values

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

Returns:

the values as a delimited String

getDelimitedStringValuesOrEmptyString

public static String getDelimitedStringValuesOrEmptyString(DataSet list,
                                                           DicomTag tag)

Get all the string values for a named attribute in an attribute list, separated by the appropriate delimiter.

If there is no such attribute, an empty string is returned.

If there is no string value, an empty string is returned.

If there is an exception trying to fetch the values, an empty string is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

Returns:

the values as a delimited String

getDelimitedStringValuesOrEmptyString

public static String getDelimitedStringValuesOrEmptyString(DataSet list,
                                                           DicomTag tag,
                                                           NumberFormat format)

Get all the string values for a named attribute in an attribute list, separated by the appropriate delimiter.

If there is no such attribute, an empty string is returned.

If there is no string value, an empty string is returned.

If there is an exception trying to fetch the values, an empty string is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

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

Returns:

the values as a delimited String

getDelimitedStringValuesOrNull

public static String getDelimitedStringValuesOrNull(DataSet list,
                                                    DicomTag tag)

Get all the string values for a named attribute in an attribute list, separated by the appropriate delimiter.

If there is no such attribute, null is returned.

If there is no string value, null is returned.

If there is an exception trying to fetch the values, null is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

Returns:

the values as a delimited String

getDelimitedStringValuesOrNull

public static String getDelimitedStringValuesOrNull(DataSet list,
                                                    DicomTag tag,
                                                    NumberFormat format)

Get all the string values for a named attribute in an attribute list, separated by the appropriate delimiter.

If there is no such attribute, null is returned.

If there is no string value, null is returned.

If there is an exception trying to fetch the values, null is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

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

Returns:

the values as a delimited String

getDoubleValues

public static double[] getDoubleValues(DataSet list,
                                       DicomTag tag)

Get the values of a named attribute in an attribute list, as an array of double.

If there is no such attribute, null is returned.

If there is an exception trying to fetch the values, null is returned.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

Returns:

the values as an array of double

getIntegerValues

public static int[] getIntegerValues(DataSet list,
                                     DicomTag tag)

Get the values of a named attribute in an attribute list, as an array of int.

If there is no such attribute, null is returned.

If there is an exception trying to fetch the values, null is returned.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

Returns:

the values as an array of int

getLongValues

public static long[] getLongValues(DataSet list,
                                   DicomTag tag)

Get the values of a named attribute in an attribute list, as an array of long.

If there is no such attribute, null is returned.

If there is an exception trying to fetch the values, null is returned.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

Returns:

the values as an array of long

getSingleDoubleValueOrDefault

public static double getSingleDoubleValueOrDefault(DataSet list,
                                                   DicomTag tag,
                                                   double dflt)

Get a single double value of a named attribute in an attribute list.

If there is more than one value, only the first is returned.

If there is no value, the supplied default is returned.

If there is an exception trying to fetch the value, the supplied default is returned.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

dflt - what to return if there is no (valid) value

Returns:

a single double value

getSingleIntegerValue

public static final int getSingleIntegerValue(DataSet aDataSet,
                                              DicomTag aTag,
                                              int aDefault)

getSingleIntegerValueOrDefault

public static int getSingleIntegerValueOrDefault(DataSet list,
                                                 DicomTag tag,
                                                 int dflt)

Get a single int value of a named attribute in an attribute list.

If there is more than one value, only the first is returned.

If there is no value, the supplied default is returned.

If there is an exception trying to fetch the value, the supplied default is returned.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

dflt - what to return if there is no (valid) value

Returns:

a single int value

getSingleLongValueOrDefault

public static long getSingleLongValueOrDefault(DataSet list,
                                               DicomTag tag,
                                               long dflt)

Get a single long value of a named attribute in an attribute list.

If there is more than one value, only the first is returned.

If there is no value, the supplied default is returned.

If there is an exception trying to fetch the value, the supplied default is returned.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

dflt - what to return if there is no (valid) value

Returns:

a single long value

getSingleStringValueOrDefault

public static String getSingleStringValueOrDefault(DataSet aDataset,
                                                   DicomTag tag,
                                                   String aDefault)

Get a single string value for a named attribute in an attribute list.

If there is no such attribute, the supplied default is returned.

If there is more than one string value, only the first is returned.

If there is no string value, the supplied default is returned.

If there is an exception trying to fetch the value, the supplied default is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

aDataset - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

aDefault - what to return if there is no (valid) string value

Returns:

a single String value

getSingleStringValueOrDefault

public static String getSingleStringValueOrDefault(DataSet list,
                                                   DicomTag tag,
                                                   String dflt,
                                                   NumberFormat format)

Get a single string value for a named attribute in an attribute list.

If there is no such attribute, the supplied default is returned.

If there is more than one string value, only the first is returned.

If there is no string value, the supplied default is returned.

If there is an exception trying to fetch the value, the supplied default is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

dflt - what to return if there is no (valid) string value

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

Returns:

a single String value

getSingleStringValueOrEmptyString

public static String getSingleStringValueOrEmptyString(DataSet list,
                                                       DicomTag tag)

Get a single string value for a named attribute in an attribute list.

If there is no such attribute, an empty string is returned.

If there is more than one string value, only the first is returned.

If there is no string value, an empty string is returned.

If there is an exception trying to fetch the value, an empty string is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

Returns:

a single String value

getSingleStringValueOrEmptyString

public static String getSingleStringValueOrEmptyString(DataSet list,
                                                       DicomTag tag,
                                                       NumberFormat format)

Get a single string value for a named attribute in an attribute list.

If there is no such attribute, an empty string is returned.

If there is more than one string value, only the first is returned.

If there is no string value, an empty string is returned.

If there is an exception trying to fetch the value, an empty string is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

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

Returns:

a single String value

getSingleStringValueOrNull

public static String getSingleStringValueOrNull(DataSet list,
                                                DicomTag tag)

Get a single string value for a named attribute in an attribute list.

If there is no such attribute, null is returned.

If there is more than one string value, only the first is returned.

If there is no string value, null is returned.

If there is an exception trying to fetch the value, null is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

Returns:

a single String value

getSingleStringValueOrNull

public static String getSingleStringValueOrNull(DataSet list,
                                                DicomTag tag,
                                                NumberFormat format)

Get a single string value for a named attribute in an attribute list.

If there is no such attribute, null is returned.

If there is more than one string value, only the first is returned.

If there is no string value, null is returned.

If there is an exception trying to fetch the value, null is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

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

Returns:

a single String value

getStringValues

public static String[] getStringValues(DataSet list,
                                       DicomTag tag)

Get the values of a named attribute in an attribute list, as an array of strings.

If there is no such attribute, null is returned.

If there is an exception trying to fetch the values, null is returned.

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

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

Returns:

the values as an array of String

getStringValues

public static String[] getStringValues(DataSet list,
                                       DicomTag tag,
                                       NumberFormat format)

Get the values of a named attribute in an attribute list, as an array of strings.

If there is no such attribute, null is returned.

If there is an exception trying to fetch the values, null is returned.

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

Parameters:

list - the list of attributes in which to look for the attribute

tag - the tag of the attribute to find

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

Returns:

the values as an array of String

isGroupLength

public static boolean isGroupLength(DataElement aDataElement)

Return true if the DataElement represent a group length element (ie: the value of Element is equal to 0x0000)

Parameters:

aDataElement -

Returns:

addValue

public void addValue(byte v)
              throws DicomException

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

Parameters:

v - value to add

Throws:

DicomException - thrown if value of this type is not valid for this concrete attribute class

addValue

public void addValue(double v)
              throws DicomException

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

Parameters:

v - value to add

Throws:

DicomException - thrown if value of this type is not valid for this concrete attribute class

addValue

public void addValue(float v)
              throws DicomException

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

Parameters:

v - value to add

Throws:

DicomException - thrown if value of this type is not valid for this concrete attribute class

addValue

public void addValue(int v)
              throws DicomException

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

Parameters:

v - value to add

Throws:

DicomException - thrown if value of this type is not valid for this concrete attribute class

addValue

public void addValue(long v)
              throws DicomException

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

Parameters:

v - value to add

Throws:

DicomException - thrown if value of this type is not valid for this concrete attribute class

addValue

public void addValue(short v)
              throws DicomException

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

Parameters:

v - value to add

Throws:

DicomException - thrown if value of this type is not valid for this concrete attribute class

addValue

public void addValue(String v)
              throws DicomException

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

Parameters:

v - value to add

Throws:

DicomException - thrown if value of this type is not valid for this concrete attribute class

clear

public void clear()

Clear Data contains in this Element

getByteValues

public byte[] getByteValues()
                     throws DicomException

Get the values of this attribute as a byte array.

Returns:

the values as an array of bytes

Throws:

DicomException - thrown if values are not available (such as not supported for this concrete attribute class)

getDelimitedStringValues

public String getDelimitedStringValues()

getDelimitedStringValues

public String getDelimitedStringValues(String aDefault)

Get all the string values for the attribute, separated by the appropriate delimiter.

If there is no string value, the supplied default is returned.

If there is an exception trying to fetch the values, the supplied default is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

dflt - what to return if there are no (valid) string values

Returns:

the values as a delimited String

getDelimitedStringValuesOrDefault

public String getDelimitedStringValuesOrDefault(String dflt,
                                                NumberFormat format)

Get all the string values for the attribute, separated by the appropriate delimiter.

If there is no string value, the supplied default is returned.

If there is an exception trying to fetch the values, the supplied default is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

dflt - what to return if there are no (valid) string values

format - the format to use for each numerical or decimal value (null if none)

Returns:

the values as a delimited String

getDelimitedStringValuesOrEmptyString

public String getDelimitedStringValuesOrEmptyString()

Get all the string values for the attribute, separated by the appropriate delimiter.

If there is no string value, an empty string is returned.

If there is an exception trying to fetch the values, an empty string is returned.

A canonicalized (unpadded) form is returned, not the original string.

Returns:

the values as a delimited String

getDelimitedStringValuesOrEmptyString

public String getDelimitedStringValuesOrEmptyString(NumberFormat format)

Get all the string values for the attribute, separated by the appropriate delimiter.

If there is no string value, an empty string is returned.

If there is an exception trying to fetch the values, an empty string is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

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

Returns:

the values as a delimited String

getDelimitedStringValuesOrNull

public String getDelimitedStringValuesOrNull()

Get all the string values for the attribute, separated by the appropriate delimiter.

If there is no string value, null is returned.

If there is an exception trying to fetch the values, null is returned.

A canonicalized (unpadded) form is returned, not the original string.

Returns:

the values as a delimited String

getDelimitedStringValuesOrNull

public String getDelimitedStringValuesOrNull(NumberFormat format)

Get all the string values for the attribute, separated by the appropriate delimiter.

If there is no string value, null is returned.

If there is an exception trying to fetch the values, null is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

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

Returns:

the values as a delimited String

getDoubleValues

public double[] getDoubleValues()
                         throws DicomException

Get the values of this attribute as a double array.

Returns:

the values as an array of double

Throws:

DicomException - thrown if values are not available (such as not supported for this concrete attribute class)

getFloatValues

public float[] getFloatValues()
                       throws DicomException

Get the values of this attribute as a float array.

Returns:

the values as an array of float

Throws:

DicomException - thrown if values are not available (such as not supported for this concrete attribute class)

getIntegerValues

public int[] getIntegerValues()
                       throws DicomException

Get the values of this attribute as an int array.

Returns:

the values as an array of int

Throws:

DicomException - thrown if values are not available (such as not supported for this concrete attribute class)

getLongValues

public long[] getLongValues()
                     throws DicomException

Get the values of this attribute as a long array.

Returns:

the values as an array of long

Throws:

DicomException - thrown if values are not available (such as not supported for this concrete attribute class)

getName

public String getName()

getOriginalStringValues

public String[] getOriginalStringValues()
                                 throws DicomException

Get the values of this attribute as strings, the way they were originally inserted or read.

Returns:

the values as an array of String

Throws:

DicomException - thrown if values are not available (such as not supported for this concrete attribute class)

getPaddedVL

public long getPaddedVL()

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

Returns:

the value length (padded to an even length)

getShortValues

public short[] getShortValues()
                       throws DicomException

Get the values of this attribute as a short array.

Returns:

the values as an array of short

Throws:

DicomException - thrown if values are not available (such as not supported for this concrete attribute class)

getSingleDoubleValueOrDefault

public double getSingleDoubleValueOrDefault(double dflt)

Get a single double value for the attribute.

If there is more than one value, only the first is returned.

If there is no value, the supplied default is returned.

If there is an exception trying to fetch the value, the supplied default is returned.

Parameters:

dflt - what to return if there is no (valid) value

Returns:

a single double value

getSingleIntegerValue

public int getSingleIntegerValue()

getSingleIntegerValue

public int getSingleIntegerValue(int aDefault)

Get a single int value for the attribute.

If there is more than one value, only the first is returned.

If there is no value, the supplied default is returned.

If there is an exception trying to fetch the value, the supplied default is returned.

Parameters:

aDefault - what to return if there is no (valid) value

Returns:

a single int value

getSingleLongValueOrDefault

public long getSingleLongValueOrDefault(long dflt)

Get a single long value for the attribute.

If there is more than one value, only the first is returned.

If there is no value, the supplied default is returned.

If there is an exception trying to fetch the value, the supplied default is returned.

Parameters:

dflt - what to return if there is no (valid) value

Returns:

a single long value

getSingleStringValue

public String getSingleStringValue()

Get a single string value

If there is more than one string value, only the first is returned.

If there is no string value, the supplied default is returned.

getSingleStringValue

public String getSingleStringValue(String dflt)

Get a single string value for the attribute.

If there is more than one string value, only the first is returned.

If there is no string value, the supplied default is returned.

If there is an exception trying to fetch the value, the supplied default is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

dflt - what to return if there is no (valid) string value

Returns:

a single String value

getSingleStringValueOrDefault

public String getSingleStringValueOrDefault(String dflt,
                                            NumberFormat format)

Get a single string value for the attribute.

If there is more than one string value, only the first is returned.

If there is no string value, the supplied default is returned.

If there is an exception trying to fetch the value, the supplied default is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

dflt - what to return if there is no (valid) string value

format - the format to use for each numerical or decimal value (null if none)

Returns:

a single String value

getSingleStringValueOrEmptyString

public String getSingleStringValueOrEmptyString(NumberFormat format)

Get a single string value for the attribute.

If there is more than one string value, only the first is returned.

If there is no string value, an empty string is returned.

If there is an exception trying to fetch the value, an empty string is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

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

Returns:

a single String value

getSingleStringValueOrNull

public String getSingleStringValueOrNull()

Get a single string value for the attribute.

If there is more than one string value, only the first is returned.

If there is no string value, null is returned.

If there is an exception trying to fetch the value, null is returned.

A canonicalized (unpadded) form is returned, not the original string.

Returns:

a single String value

getSingleStringValueOrNull

public String getSingleStringValueOrNull(NumberFormat format)

Get a single string value for the attribute.

If there is more than one string value, only the first is returned.

If there is no string value, null is returned.

If there is an exception trying to fetch the value, null is returned.

A canonicalized (unpadded) form is returned, not the original string.

Parameters:

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

Returns:

a single String value

getStringValues

public String[] getStringValues()
                         throws DicomException

Get the values of this attribute as strings.

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

Returns:

the values as an array of String

Throws:

DicomException - thrown if values are not available (such as not supported for this concrete attribute class)

getStringValues

public String[] getStringValues(NumberFormat format)
                         throws DicomException

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.

Parameters:

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

Returns:

the values as an array of String

Throws:

DicomException - thrown if values are not available (such as not supported for this concrete attribute class)

getTag

public DicomTag getTag()

Return element's tag

Returns:

the tag

getValueLength

public long getValueLength()

Gets the value length

Returns:

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

getValueMultiplicity

public int getValueMultiplicity()

Get the value multiplicity of this element

Returns:

the value multiplicity

getValueRepresentation

public abstract ValueRepresentation getValueRepresentation()

Return the ValueRepresentation of this element

Returns:

the ValueRepresentation

isValid

public boolean isValid()

check is the data of this element is Dicom compliant

Returns:

true is dicom compliant

read

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

Read data from a stream

Parameters:

aStream - the stream

aLength - the length of data to read

Throws:

IOException

DicomException

read

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

Throws:

IOException

DicomException

removeValues

public void removeValues()
                  throws DicomException

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

Throws:

DicomException

setValues

public void setValues(byte[] v)
               throws DicomException

Replace any existing values with the supplied array of byte.

Parameters:

v - the array of new values

Throws:

DicomException - thrown if values of this type are not valid for this concrete attribute class

setValues

public void setValues(float[] v)
               throws DicomException

Replace any existing values with the supplied array of float.

Parameters:

v - the array of new values

Throws:

DicomException - thrown if values of this type are not valid for this concrete attribute class

setValues

public void setValues(short[] v)
               throws DicomException

Replace any existing values with the supplied array of short.

Parameters:

v - the array of new values

Throws:

DicomException - thrown if values of this type are not valid for this concrete attribute class

toString

public String toString()

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 Object

Returns:

a single String value

write

public abstract void write(DicomOutputStream o)
                    throws DicomException,
                           IOException

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

Parameters:

o - the output stream

Throws:

IOException

DicomException

isAvailableAsString

public boolean isAvailableAsString()

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

Returns:

true if value is available as a string

Since:

0.0.6