cdac.medinfo.sdk.dcm30_04.baselibs

Class DicomValue

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.DicomValue

All Implemented Interfaces:

IDicomValue, java.io.Serializable

Direct Known Subclasses:

AT, DataTypeByte, DatatypeString, FD, FL, OB, OBImageObject, OD, OF, OW, OWImageObject, SL, SQ, SS, UL, UN, US

public abstract class DicomValue
extends java.lang.Object
implements IDicomValue

This is the parent class of all Dicom Data Types. This class encapsulates the basic functionality needed for the Dicom DataTypes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DicomValue()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Create similar object of this class.
int	getIVRType() Retrieves the value representation type of the Dicom Data
java.lang.Object	getValue() Retrieves the value set in the DicomValue
abstract int	getValueLength() Retrieves the actual value length of DicomValue
int	getValueMultiplicity() Retrieves the value multiplicity of DicomValue value
abstract boolean	read(IDicomStream objIDicomStream, int iLength) This method specifies read scenario contract for DicomValue Type
void	setIVRType(int iVRType) Sets the Value Representation type into the DicomValue
void	setValue(java.lang.Object objValue) Sets the value in the DicomValue after performing validation on the value.
abstract boolean	validate() This method specifies validation scenario contract for DicomValue Type
abstract boolean	validate(java.lang.Object objToValidate) This method specifies validation scenario contract for DicomValue Type
abstract int	write(IDicomStream objIDicomStream) This method specifies write scenario contract for DicomValue Type

Methods inherited from class java.lang.Object

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

Methods inherited from interface cdac.medinfo.sdk.dcm30_04.commoninterface.IDicomValue

dumpDICOMInfo, getMaxLength

Constructor Detail

DicomValue

public DicomValue()

Method Detail

getValue

public java.lang.Object getValue()

Retrieves the value set in the DicomValue

Specified by:

getValue in interface IDicomValue

Returns:

object - returns the value set in the DicomValue

getIVRType

public int getIVRType()

Retrieves the value representation type of the Dicom Data

Specified by:

getIVRType in interface IDicomValue

Returns:

intger - returns interger specifying the Value Representation type.

See Also:

DicomConstants

setIVRType

public void setIVRType(int iVRType)

Sets the Value Representation type into the DicomValue

Specified by:

setIVRType in interface IDicomValue

Parameters:

iVRType - integer value specifies the Value Representation type

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

Parameters:

objValue - value that is to be set into the DicomValue

Throws:

InvalidDataTypeException - If data type validation fails.

read

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

This method specifies read scenario contract for DicomValue Type

Specified by:

read in interface IDicomValue

Parameters:

objIDicomStream - stream from which the DataType is to be written

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

Returns:

integer - return status success/failure

Throws:

InvalidDataTypeException - If data type validation fails.

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

write

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

This method specifies write scenario contract for DicomValue Type

Specified by:

write in interface IDicomValue

Parameters:

objIDicomStream - stream from which the DataType is to be written

Returns:

integer - return status success/failure

Throws:

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

validate

public abstract boolean validate(java.lang.Object objToValidate)
                          throws ValidationException

This method specifies validation scenario contract for DicomValue Type

Specified by:

validate in interface IDicomValue

Parameters:

objToValidate - value of Dicom Data Type to be validated

Returns:

boolean - returns status indicating success/failure

Throws:

ValidationException - If validation of of Dicomdata fails.

validate

public abstract boolean validate()
                          throws ValidationException

This method specifies validation scenario contract for DicomValue Type

Specified by:

validate in interface IDicomValue

Returns:

boolean - returns status indicating success/failure

Throws:

ValidationException - If validation of of Dicomdata fails.

getValueLength

public abstract int getValueLength()

Retrieves the actual value length of DicomValue

Specified by:

getValueLength in interface IDicomValue

Returns:

integer - actual value length of Dicom Data

getValueMultiplicity

public int getValueMultiplicity()

Retrieves the value multiplicity of DicomValue value

Specified by:

getValueMultiplicity in interface IDicomValue

Returns:

integer - value multiplicity of the value

clone

public java.lang.Object clone()

Create similar object of this class. This does the deep copy and create a new instance of this class nad return it.

Specified by:

clone in interface IDicomValue

Overrides:

clone in class java.lang.Object

Returns:

a clone of this instance.