cdac.medinfo.sdk.dcm30_04.baselibs

Class UN

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.DicomValue

cdac.medinfo.sdk.dcm30_04.baselibs.UN

All Implemented Interfaces:

IDicomValue, java.io.Serializable

public class UN
extends DicomValue

UN is used to handle the DataTypes whose strcuture is not known. The UN DataType is used to hold the data in a byte buffer if the DataType is not known

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the value of Attribute as Hidden.
long	getMaxLength() Retrieves the max length for UL DataType
int	getValueLength() Retrieves the actual value length of UL
boolean	read(IDicomStream objIDicomStream, int iUNLength) Reads the unknown data from the stream and stores it in a byte buffer Note : It could throw OutOfMemoryException if length exceeds from allowed Heap Space.
void	setValue(java.lang.Object objValue) Sets the value in the DicomValue after performing validation on the value.
boolean	validate() Validates UN DataType according to the rules specified in the DICOM Standard
boolean	validate(java.lang.Object objValue) Validates UN DataType according to the rules specified in the DICOM Standard
int	write(IDicomStream objIDicomStream) Writes the unknown data to the stream from the byte buffer This function writes the Data Value to the Stream

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.DicomValue

clone, getIVRType, getValue, getValueMultiplicity, setIVRType

Methods inherited from class java.lang.Object

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

Method Detail

getMaxLength

public long getMaxLength()

Retrieves the max length for UL DataType

Returns:

long - max length for FD DataType

read

public boolean read(IDicomStream objIDicomStream,
           int iUNLength)
             throws InvalidDataTypeException,
                    java.io.IOException

Reads the unknown data from the stream and stores it in a byte buffer Note : It could throw OutOfMemoryException if length exceeds from allowed Heap Space.

Specified by:

read in interface IDicomValue

Specified by:

read in class DicomValue

Parameters:

objIDicomStream - stream from which the DataType is to be written

iUNLength - length of the DicomValue to be read from the stream

Returns:

integer - returns status success/failure

Throws:

InvalidDataTypeException - If data type validation fails.

java.io.IOException - If Input/Output operation fails.

write

public int write(IDicomStream objIDicomStream)
          throws java.io.IOException

Writes the unknown data to the stream from the byte buffer This function writes the Data Value to the Stream

Specified by:

write in interface IDicomValue

Specified by:

write in class DicomValue

Parameters:

objIDicomStream - stream onto which the FD DataType is to serialized

Returns:

int - status indicating success/failure of write method

Throws:

java.io.IOException - If Input/Output operation fails.

validate

public boolean validate(java.lang.Object objValue)
                 throws InvalidValueException,
                        LengthLimitException

Validates UN DataType according to the rules specified in the DICOM Standard

Specified by:

validate in interface IDicomValue

Specified by:

validate in class DicomValue

Parameters:

objValue - instance of base Object class.

Returns:

boolean - status indicating success/failure of validation

Throws:

InvalidValueException - If dataType value validation fails.

LengthLimitException - If value length exceeds the limit.

validate

public boolean validate()
                 throws InvalidValueException,
                        LengthLimitException

Validates UN DataType according to the rules specified in the DICOM Standard

Specified by:

validate in interface IDicomValue

Specified by:

validate in class DicomValue

Returns:

boolean - status indicating success/failure of validation

Throws:

InvalidValueException - If dataType value validation fails.

LengthLimitException - If value length exceeds the limit.

getValueLength

public int getValueLength()

Retrieves the actual value length of UL

Specified by:

getValueLength in interface IDicomValue

Specified by:

getValueLength in class DicomValue

Returns:

integer - actual value length of UN

setValue

public void setValue(java.lang.Object objValue)
              throws InvalidDataTypeException

Sets the value in the DicomValue after performing validation on the value. After setting the value this method returns the errorcode indicating whether the validation of value was successful or failing

Specified by:

setValue in interface IDicomValue

Overrides:

setValue in class DicomValue

Parameters:

objValue - value that is to be set into the DicomValue

Throws:

InvalidDataTypeException - If data type validation fails.

dumpDICOMInfo

public void dumpDICOMInfo(IDicomStream objIDicomStream)
                   throws java.io.IOException

Dumps the value of Attribute as Hidden.

Parameters:

objIDicomStream - - the Stream on which the Data is to be written.

Throws:

java.io.IOException - - Exception is thrown indicating runtime failure of writing operation.