com.pixelmed.dicom
Class OtherWordAttributeOnDisk

java.lang.Object
  com.pixelmed.dicom.Attribute
      com.pixelmed.dicom.OtherWordAttributeOnDisk

public class OtherWordAttributeOnDisk
extends Attribute

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

Field Summary

protected boolean	bigEndian
protected long	byteOffset
protected File	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

long	getByteOffset()
File	getFile()
byte[]	getVR() Get the value representation of this attribute (OW).
boolean	isBigEndian() Is the data on disk byte order big endian ?
void	removeValues() Remove any existing values, making the attribute empty (zero length).
void	setFile(File file) Change the file containing the data, for example if it has been renamed.
String	toString(DicomDictionary dictionary) 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 com.pixelmed.dicom.Attribute

addValue, addValue, addValue, addValue, addValue, addValue, addValue, getByteValues, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrDefault, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrEmptyString, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDelimitedStringValuesOrNull, getDoubleValues, getDoubleValues, getElement, getFloatValues, getGroup, getIntegerValues, getIntegerValues, getLongValues, getLongValues, getOriginalStringValues, getPaddedVL, getShortValues, getSingleDoubleValueOrDefault, getSingleDoubleValueOrDefault, getSingleIntegerValueOrDefault, getSingleIntegerValueOrDefault, getSingleLongValueOrDefault, getSingleLongValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrDefault, getSingleStringValueOrEmptyString, getSingleStringValueOrEmptyString, getSingleStringValueOrEmptyString, getSingleStringValueOrEmptyString, getSingleStringValueOrNull, getSingleStringValueOrNull, getSingleStringValueOrNull, getSingleStringValueOrNull, getStringValues, getStringValues, getStringValues, getStringValues, getTag, getVL, getVM, getVRAsString, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValues, setValues, setValues, toString, writeBase

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

byteOffset

protected long byteOffset

file

protected File file

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

toString

public String toString(DicomDictionary dictionary)

Description copied from class: Attribute

Dump the contents of the attribute as a human-readable string.

No new line is appended.

The result is of the form:

 (0xgggg,0xeeee) Name VR=<XX> VL=<0xnnnn> <...>
 

For example:

 (0x0018,0x0020) ScanningSequence VR=<CS> VL=<0x2> <GR>
 

Overrides:

toString in class Attribute

Parameters:

dictionary - the dictionary to use to look up the name

Returns:

a single String value

getByteOffset

public long getByteOffset()

Returns:

the offset from the start of the object in bytes

getFile

public File getFile()

Returns:

the file containing the data

setFile

public void setFile(File file)

Change the file containing the data, for example if it has been renamed.

Parameters:

file - the new file containing the data

isBigEndian

public boolean isBigEndian()

Is the data on disk byte order big endian ?

Returns:

true if big endian, false if little endian

removeValues

public void removeValues()

Description copied from class: Attribute

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

Specified by:

removeValues in class Attribute

Throws:

DicomException

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