cdac.medinfo.sdk.dcm30_04.services.dicomnetcommons

Interface ICommandSet

All Known Implementing Classes:

CommandSet

public interface ICommandSet

This interface needs to be implemented by all classes which implements the CommandSet alongwith iterability.

Method Summary

Methods

Modifier and Type	Method and Description
int	addCommandElement(ICommandElement objICommandElement) The implementation of this method adds the CommandElement to the command set.
byte[]	getBytes(int iNumberOfBytes) Gets the bytes of Comamnd Set.
int	getCommandSetLength() This function returns the length of Command Set.
ICommandElement	getDataForTag(int iGroupNumber, int iElementNumber) The implementation of this method retrieves the CommandElement for the specified tag.
IDictionaryReader	getDictionaryReader() The implementation of this method retrieves the DictionaryReader.
ITransferSyntax	getTransferSyntax() The implementation of this method retrieves the TransferSyntax set in the DataSet.
java.lang.Object	getValue(int iGroupNumber, int iElementNumber) This method returns value of DicomValue.
boolean	isAvailable() Checks if command set bytes is available.
boolean	isEmpty() The implementation of this method checks that Command set is empty or not.
boolean	isPresent(int iGroupNumber, int iElementNumber) The implementation of this method checks that element is present in Command set or not.
int	parse(IDicomStream objIDicomStream) The implementation of this method parses the CommandSet from the given Stream.
int	serialize(IDicomStream objIDicomStream) The implementation of this method serialize the CommandSet from the given Stream.
boolean	validate() The implementation of this method validates the CommandSet according to the DICOM Rules.

Method Detail

parse

int parse(IDicomStream objIDicomStream)
          throws ParseException,
                 java.io.IOException

The implementation of this method parses the CommandSet from the given Stream.

Parameters:

objIDicomStream - Stream on which the DICOM data is available.

Returns:

int - shows status as success or failure.

Throws:

ParseException - If parsing fails.

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

serialize

int serialize(IDicomStream objIDicomStream)
              throws SerializeException,
                     java.io.IOException

The implementation of this method serialize the CommandSet from the given Stream.

Parameters:

objIDicomStream - Stream on which the DICOM data is available.

Returns:

int - shows status as success or failure.

Throws:

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

SerializeException - the serialize exception

getDataForTag

ICommandElement getDataForTag(int iGroupNumber,
                            int iElementNumber)

The implementation of this method retrieves the CommandElement for the specified tag.

Parameters:

iGroupNumber - integer value of group number.

iElementNumber - integer value of element number.

Returns:

IDataElement - instance of DataElement.

getDictionaryReader

IDictionaryReader getDictionaryReader()

The implementation of this method retrieves the DictionaryReader.

Returns:

IDictionaryReader - instance of DictionaryReader.

addCommandElement

int addCommandElement(ICommandElement objICommandElement)

The implementation of this method adds the CommandElement to the command set.

Parameters:

objICommandElement - the command element to be added to command set.

Returns:

int - shows status as success or failure.

getTransferSyntax

ITransferSyntax getTransferSyntax()

The implementation of this method retrieves the TransferSyntax set in the DataSet.

Returns:

ITransferSyntax - instance of TransferSyntax.

isPresent

boolean isPresent(int iGroupNumber,
                int iElementNumber)

The implementation of this method checks that element is present in Command set or not.

Parameters:

iGroupNumber - integer value of group number.

iElementNumber - integer value of element number.

Returns:

boolean - shows status as success or failure.

isEmpty

boolean isEmpty()

The implementation of this method checks that Command set is empty or not.

Returns:

boolean - shows status as success or failure.

validate

boolean validate()
                 throws InvalidCommandSetException

The implementation of this method validates the CommandSet according to the DICOM Rules.

Returns:

boolean - shows status as success or failure.

Throws:

InvalidDataSetException - if validation of DataSet fails.

InvalidCommandSetException - the invalid command set exception

getCommandSetLength

int getCommandSetLength()

This function returns the length of Command Set.

Returns:

int - Length of Command Set.

isAvailable

boolean isAvailable()

Checks if command set bytes is available.

Returns:

boolean- true if command set bytes is available false if command set bytes is not available

getBytes

byte[] getBytes(int iNumberOfBytes)
                throws java.io.IOException

Gets the bytes of Comamnd Set.

Parameters:

iNumberOfBytes - the number of bytes required.

Returns:

byte[] byte array containing iNumber of bytes if available, else the no of bytes available with Command Set.

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

getValue

java.lang.Object getValue(int iGroupNumber,
                        int iElementNumber)

This method returns value of DicomValue.

Parameters:

iGroupNumber - Group Number of the Command Element

iElementNumber - Element Number of the Command Element

Returns:

Object - instance of IDicomValue.