cdac.medinfo.sdk.dcm30_04.baselibs

Class DataTypeByte

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.DicomValue

cdac.medinfo.sdk.dcm30_04.baselibs.DataTypeByte

All Implemented Interfaces:

IDicomValue, java.io.Serializable

public class DataTypeByte
extends DicomValue

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataTypeByte()

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the value of Data Type Byte 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 iOBLength) Reads the data value from the stream of specified length of bytes.
void	setMaxLength(long lMaxLength) Sets the length of the value in DicomValue.
boolean	validate() Validates the data value object as per the encoding rules provided in the DICOM Standard.
boolean	validate(java.lang.Object value) Validates the data value object as per the encoding rules provided in the DICOM Standard.
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, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

DataTypeByte

public DataTypeByte()

Method Detail

setMaxLength

public void setMaxLength(long lMaxLength)

Sets the length of the value in DicomValue. This length represents the actual value length and not the one which includes padding bytes' length.

Parameters:

lMaxLength - max length of Dicomdata

getMaxLength

public long getMaxLength()

Retrieves maximum allowed length by this datatype.

Returns:

long - max length of Datatype

validate

public boolean validate(java.lang.Object value)

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:

value - 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()

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:

value - object representing value to be validated.

Returns:

boolean - status indicating success/failure of the validation.

Throws:

ValidationException - If validation fails according to Dicom rules.

read

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

Reads 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.

iOBLength - 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.

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

dumpDICOMInfo

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

Dumps the value of Data Type Byte 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.