cdac.medinfo.sdk.dcm30_04.baselibs

Class DatatypeString

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.DicomValue

cdac.medinfo.sdk.dcm30_04.baselibs.DatatypeString

All Implemented Interfaces:

IDicomValue, java.io.Serializable

Direct Known Subclasses:

AE, AS, CS, DA, DS, DT, IS, LO, LT, PN, SH, ST, TM, UC, UI, UR, UT

public class DatatypeString
extends DicomValue

This class is the Super Class of all the String Datatypes. It provides implementation for read from stream and write to stream functions for all its sub classes.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the value of Data Type String in readable form to the specified Stream.
long	getMaxLength() Retrieves maximum allowed length by this datatype.
int	getValueLength() Retrieves the actual value length set in the DataTypeString.
boolean	read(IDicomStream objIDicomStream, int iLength) Reads and validates the data value from the stream of specified length of bytes.
void	setValue(java.lang.Object objValue) Sets the value in the DicomValue after performing validation on the value.
java.lang.String	toString() This function returns the String value of Data Type String.
boolean	validate() Validates the data value object as per the encoding rules provided in the DICOM Standard.
boolean	validate(java.lang.Object objToValidate) Validates the data value object as per the encoding rules provided in the DICOM Standard.
int	validateLength(int iLengthToValidate) This method checks for the length of string read from stream to be less or equal to max allowed length by the datatype of the value.
int	write(IDicomStream objIDicomStream) This method writes the Data Value to the given 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, wait, wait, wait

Method Detail

getMaxLength

public long getMaxLength()

Retrieves maximum allowed length by this datatype.

Returns:

long - max length of Datatype

read

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

Reads and validates the data value from the stream of specified length of bytes.

Specified by:

read in interface IDicomValue

Specified by:

read in class DicomValue

Parameters:

objIDicomStream - isntance of class implementing the IDicomStream interface.

iLength - Number of bytes to be read from the Stream.

Returns:

boolean - status if read was successful.

Throws:

InvalidDataTypeException - If DataType validation fails.

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

validateLength

public int validateLength(int iLengthToValidate)
                   throws LengthLimitException

This method checks for the length of string read from stream to be less or equal to max allowed length by the datatype of the value.

Parameters:

iLengthToValidate - length of the value to be validated.

Returns:

int - status indicating success/failure of length validation.

Throws:

LengthLimitException - If length exceeds from allowed length.

validate

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

Validates the data value object as per the encoding rules provided in the DICOM Standard.

Specified by:

validate in interface IDicomValue

Specified by:

validate in class DicomValue

Parameters:

objToValidate - object representing value to be validated.

Returns:

boolean - status indicating success/failure of the validation.

Throws:

ValidationException - If validation fails according to Dicom rules.

validate

public boolean validate()
                 throws ValidationException

Validates the data value object as per the encoding rules provided in the DICOM Standard.

Specified by:

validate in interface IDicomValue

Specified by:

validate in class DicomValue

Returns:

boolean - status indicating success/failure of the validation.

Throws:

ValidationException - If validation fails according to Dicom rules.

write

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

This method writes the Data Value to the given Stream.

Specified by:

write in interface IDicomValue

Specified by:

write in class DicomValue

Parameters:

objIDicomStream - object of the stream onto which the DataTypeString is to be written.

Returns:

integer - status indicating success/failure of the write method.

Throws:

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

getValueLength

public int getValueLength()

Retrieves the actual value length set in the DataTypeString. This length doesn't include the padding bytes.

Specified by:

getValueLength in interface IDicomValue

Specified by:

getValueLength in class DicomValue

Returns:

int - length of Dicomdata

setValue

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

Sets the value in the DicomValue after performing validation on the value.

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 DataType validation fails.

toString

public java.lang.String toString()

This function returns the String value of Data Type String.

Overrides:

toString in class java.lang.Object

dumpDICOMInfo

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

Dumps the value of Data Type String in readable form to the specified Stream.

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.