Package com.pixelmed.dicom
Class DecimalStringAttribute
- java.lang.Object
-
- com.pixelmed.dicom.Attribute
-
- com.pixelmed.dicom.StringAttribute
-
- com.pixelmed.dicom.DecimalStringAttribute
-
public class DecimalStringAttribute extends StringAttribute
A concrete class specializing
Attributefor Decimal String (DS) attributes.Though an instance of this class may be created using its constructors, there is also a factory class,
AttributeFactory.- See Also:
Attribute,AttributeFactory,AttributeList
-
-
Field Summary
Fields Modifier and Type Field Description protected static intMAX_LENGTH_SINGLE_VALUE-
Fields inherited from class com.pixelmed.dicom.StringAttribute
specificCharacterSet
-
Fields inherited from class com.pixelmed.dicom.Attribute
valueLength, valueMultiplicity
-
-
Constructor Summary
Constructors Constructor Description DecimalStringAttribute(AttributeTag t)Construct an (empty) attribute.DecimalStringAttribute(AttributeTag t, long vl, DicomInputStream i)Read an attribute from an input stream.DecimalStringAttribute(AttributeTag t, java.lang.Long vl, DicomInputStream i)Read an attribute from an input stream.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddValue(double v)Add a(nother) double value after any existing values of this attribute.voidaddValue(float v)Add a(nother) float value after any existing values of this attribute.voidaddValue(long v)Add a(nother) long value after any existing values of this attribute.intgetMaximumLengthOfSingleValue()java.lang.String[]getStringValues(java.text.NumberFormat format)Get the values of this attribute as strings.byte[]getVR()Get the value representation of this attribute (DS).booleanisCharacterInValueValid(int c)booleanrepairValues()Repair any existing values of this attribute to make them comply with standard VR requirements.-
Methods inherited from class com.pixelmed.dicom.StringAttribute
addValue, addValue, addValue, addValue, allowRepairOfIncorrectLength, allowRepairOfInvalidCharacterReplacement, areCharactersInValuesValid, areLengthsOfValuesValid, areValuesWellFormed, flushCachedCopies, getByteValues, getDoubleValues, getFloatValues, getIntegerValues, getInvalidCharacterReplacement, getLongValues, getOriginalStringValues, getPadByte, getPaddedVL, getShortValues, getSpecificCharacterSet, isValid, removeValues, setSpecificCharacterSet, toString, translateByteArrayToString, translateStringToByteArray, write
-
Methods inherited from class com.pixelmed.dicom.Attribute
getByteValues, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDoubleValues, getDoubleValues, getElement, getFloatValues, getFloatValues, getGroup, getIntegerValues, getIntegerValues, getLengthOfBaseOfEncodedAttribute, getLengthOfEncodedValue, getLengthOfEntireEncodedAttribute, getLongValues, getLongValues, 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, getVRAsString, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValues, setValues, setValues, setValues, setValues, setValues, setValues, toString, writeBase
-
-
-
-
Field Detail
-
MAX_LENGTH_SINGLE_VALUE
protected static final int MAX_LENGTH_SINGLE_VALUE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
DecimalStringAttribute
public DecimalStringAttribute(AttributeTag t)
Construct an (empty) attribute.
- Parameters:
t- the tag of the attribute
-
DecimalStringAttribute
public DecimalStringAttribute(AttributeTag t, long vl, DicomInputStream i) throws java.io.IOException, DicomException
Read an attribute from an input stream.
- Parameters:
t- the tag of the attributevl- the value length of the attributei- the input stream- Throws:
java.io.IOException- if an I/O error occursDicomException- if error in DICOM encoding
-
DecimalStringAttribute
public DecimalStringAttribute(AttributeTag t, java.lang.Long vl, DicomInputStream i) throws java.io.IOException, DicomException
Read an attribute from an input stream.
- Parameters:
t- the tag of the attributevl- the value length of the attributei- the input stream- Throws:
java.io.IOException- if an I/O error occursDicomException- if error in DICOM encoding
-
-
Method Detail
-
getMaximumLengthOfSingleValue
public final int getMaximumLengthOfSingleValue()
- Specified by:
getMaximumLengthOfSingleValuein classStringAttribute
-
getVR
public byte[] getVR()
Get the value representation of this attribute (DS).
- Overrides:
getVRin classAttribute- Returns:
- 'D','S' in ASCII as a two byte array; see
ValueRepresentation
-
getStringValues
public java.lang.String[] getStringValues(java.text.NumberFormat format) throws DicomExceptionDescription copied from class:StringAttributeGet the values of this attribute as strings.
The strings are first cleaned up into a canonical form, to remove leading and trailing padding.
- Overrides:
getStringValuesin classStringAttribute- Parameters:
format- the format to use for each numerical or decimal value- Returns:
- the values as an array of
String - Throws:
DicomException- if error in DICOM encoding
-
addValue
public void addValue(long v) throws DicomExceptionDescription copied from class:AttributeAdd a(nother) long value after any existing values of this attribute.- Overrides:
addValuein classStringAttribute- Parameters:
v- value to add- Throws:
DicomException- not thrown
-
addValue
public void addValue(float v) throws DicomExceptionDescription copied from class:AttributeAdd a(nother) float value after any existing values of this attribute.- Overrides:
addValuein classStringAttribute- Parameters:
v- value to add- Throws:
DicomException- not thrown
-
addValue
public void addValue(double v) throws DicomExceptionDescription copied from class:AttributeAdd a(nother) double value after any existing values of this attribute.- Overrides:
addValuein classStringAttribute- Parameters:
v- value to add- Throws:
DicomException- not thrown
-
isCharacterInValueValid
public final boolean isCharacterInValueValid(int c) throws DicomException- Overrides:
isCharacterInValueValidin classStringAttribute- Throws:
DicomException
-
repairValues
public boolean repairValues() throws DicomExceptionDescription copied from class:AttributeRepair any existing values of this attribute to make them comply with standard VR requirements. E.g., truncate them if they are too long. N.B., Not all types of attribute support repair.- Overrides:
repairValuesin classStringAttribute- Returns:
- true if successfully repaired or was already valid
- Throws:
DicomException- if error in DICOM value extraction
-
-