com.pixelmed.dicom
Class OtherWordAttributeOnDisk

java.lang.Object
  extended by com.pixelmed.dicom.Attribute
      extended by com.pixelmed.dicom.OtherAttributeOnDisk
          extended by com.pixelmed.dicom.OtherWordAttributeOnDisk

public class OtherWordAttributeOnDisk
extends OtherAttributeOnDisk

A concrete class specializing Attribute for Other Word (OW) attributes whose values are not memory resident.

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

See Also:
Attribute, AttributeFactory, AttributeList, OtherByteAttributeOnDisk

Field Summary
protected  boolean bigEndian
           
 
Fields inherited from class com.pixelmed.dicom.OtherAttributeOnDisk
byteOffset, file
 
Fields inherited from class com.pixelmed.dicom.Attribute
valueLength, valueMultiplicity
 
Constructor Summary
OtherWordAttributeOnDisk(AttributeTag t)
          Construct an (empty) attribute.
OtherWordAttributeOnDisk(AttributeTag t, long vl, DicomInputStream i, long byteOffset)
          Read an attribute from an input stream.
OtherWordAttributeOnDisk(AttributeTag t, Long vl, DicomInputStream i, Long byteOffset)
          Read an attribute from an input stream.
 
Method Summary
 short[] getShortValues()
          Get the values of this attribute as a short array.
 byte[] getVR()
          Get the value representation of this attribute (OW).
 boolean isBigEndian()
          Is the data on disk byte order big endian ?
 void write(DicomOutputStream o)
          Write the entire attribute (including values) to the output stream.
 
Methods inherited from class com.pixelmed.dicom.OtherAttributeOnDisk
getByteOffset, getFile, removeValues, setFile, toString
 
Methods inherited from class com.pixelmed.dicom.Attribute
addValue, addValue, addValue, addValue, addValue, addValue, addValue, getByteValues, 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, getPaddedVL, 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, getStringValues, getTag, getVL, getVM, getVRAsString, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValues, setValues, setValues, setValues, toString, writeBase
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

bigEndian

protected boolean bigEndian
Constructor Detail

OtherWordAttributeOnDisk

public OtherWordAttributeOnDisk(AttributeTag t)

Construct an (empty) attribute.

Parameters:
t - the tag of the attribute

OtherWordAttributeOnDisk

public OtherWordAttributeOnDisk(AttributeTag t,
                                long vl,
                                DicomInputStream i,
                                long byteOffset)
                         throws IOException,
                                DicomException

Read an attribute from an input stream.

Parameters:
t - the tag of the attribute
vl - the value length of the attribute
i - the input stream
byteOffset - the byte offset in the input stream of the start of the data
Throws:
IOException
DicomException

OtherWordAttributeOnDisk

public OtherWordAttributeOnDisk(AttributeTag t,
                                Long vl,
                                DicomInputStream i,
                                Long byteOffset)
                         throws IOException,
                                DicomException

Read an attribute from an input stream.

Parameters:
t - the tag of the attribute
vl - the value length of the attribute
i - the input stream
byteOffset - the byte offset in the input stream of the start of the data
Throws:
IOException
DicomException
Method Detail

write

public void write(DicomOutputStream o)
           throws DicomException,
                  IOException
Description copied from class: Attribute

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

Specified by:
write in class Attribute
Parameters:
o -
Throws:
IOException
DicomException

isBigEndian

public boolean isBigEndian()

Is the data on disk byte order big endian ?

Returns:
true if big endian, false if little endian

getShortValues

public short[] getShortValues()
                       throws DicomException

Get the values of this attribute as a short array.

This allocates a new array of sufficient length, which may fail if it is too large, and defeats the point of leaving the byte values on disk in the first place. However, it is a fallback for when the caller does not want to go to the trouble of creating a MappedByteBuffer from the file, or more likely is not even aware that the attribute values have been left on disk, because AttributeFactory silently created an instance of this class rather than an in-memory OtherWordAttribute.

Overrides:
getShortValues in class Attribute
Returns:
the values as an array of short
Throws:
DicomException - thrown if values cannot be read

getVR

public byte[] getVR()

Get the value representation of this attribute (OW).

Overrides:
getVR in class Attribute
Returns:
'O','W' in ASCII as a two byte array; see ValueRepresentation