cdac.medinfo.sdk.dcm30_04.commoninterface

Interface IDicomFileHeader

All Superinterfaces:

ICollectionIterable<IDataElement>, java.lang.Iterable<IDataElement>

All Known Implementing Classes:

DicomFileHeader

public interface IDicomFileHeader
extends ICollectionIterable<IDataElement>

This interface needs to be implemented by all classes which implements the necessary functionality for the Dicom File Header.

Method Summary

Methods

Modifier and Type	Method and Description
int	addDataElement(IDataElement objIDataElement) Adds the Data element in the header.
void	createDefaultHeader() Creates the default header.
IDataElement	getDataFromTag(int iGroupNumber, int iElementNumber) Retrieves the data for given tag.
byte[]	getHeader() Retrieves the header value for the file.
byte[]	getPreAmble() Retrieves Preamble value for file.
ITransferSyntax	getTransferSyntax() Retrieves the TransferSyntax for file.
java.lang.String	getTransferSyntaxUID() Retrieves the TransferSyntax unique ID.
void	populate(byte[] header) Populate the header value.
int	serialize(IDicomStream objIDicomStream) Serializes the Data Element from the given Stream
void	setPreAmble(byte[] bytePreamble) Sets the Preamble value for file.
void	setTransferSyntaxUID(java.lang.String strTransferSyntaxUID) Sets the TransferSyntax unique ID.

Methods inherited from interface cdac.medinfo.sdk.dcm30_04.utils.ICollectionIterable

iterator

Method Detail

setPreAmble

void setPreAmble(byte[] bytePreamble)

Sets the Preamble value for file. Preamble is the 128 bytes value contains information about user,company and etc.

Parameters:

bytePreamble - byte array containing preamble value.

getPreAmble

byte[] getPreAmble()

Retrieves Preamble value for file.

Returns:

byte[] - byte array containing preamble value.

populate

void populate(byte[] header)
              throws InvalidHeaderException,
                     java.io.IOException

Populate the header value.

Parameters:

header - byte array containing header value.

Throws:

InvalidHeaderException - if validation of header fails.

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

getTransferSyntax

ITransferSyntax getTransferSyntax()

Retrieves the TransferSyntax for file.

Returns:

ITransferSyntax - instance of TransferSyntax.

getHeader

byte[] getHeader()
                 throws InvalidHeaderException,
                        java.io.IOException

Retrieves the header value for the file.

Returns:

byte[] - Byte array containing header value.

Throws:

InvalidHeaderException - if Header validation fails.

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

getDataFromTag

IDataElement getDataFromTag(int iGroupNumber,
                          int iElementNumber)

Retrieves the data for given tag.

Parameters:

iGroupNumber - integer value of group number.

iElementNumber - integer value of element number.

Returns:

IDataElement - instance of DataElement.

createDefaultHeader

void createDefaultHeader()
                         throws InvalidHeaderException

Creates the default header.

Throws:

InvalidHeaderException - if Header validation fails.

serialize

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

Serializes the Data Element 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.

setTransferSyntaxUID

void setTransferSyntaxUID(java.lang.String strTransferSyntaxUID)

Sets the TransferSyntax unique ID.

Parameters:

strTransferSyntaxUID - string value of TransferSyntax.

getTransferSyntaxUID

java.lang.String getTransferSyntaxUID()

Retrieves the TransferSyntax unique ID.

Returns:

String - string value of TransferSyntax unique ID

addDataElement

int addDataElement(IDataElement objIDataElement)

Adds the Data element in the header.

Parameters:

objIDataElement - instance of DataElement.

Returns:

int - shows status as success or failure.