cdac.medinfo.sdk.dcm30_04.baselibs

Class DicomFileHeader

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.DicomFileHeader

All Implemented Interfaces:

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

public class DicomFileHeader
extends java.lang.Object
implements IDicomFileHeader

This class represents the part-10 compliant Dicom File. It provides the functionality of populating itself from the byte buffer containing header information It also provides the functionality of serializing itself onto the stream

Constructor Summary

Constructors

Constructor and Description
DicomFileHeader() Constructs DicomFileHeader by initializing headerlength to zero

Method Summary

Methods

Modifier and Type	Method and Description
int	addDataElement(IDataElement objIDataElement) Adds DataElements in the Header.
void	createDefaultHeader() This method creates default header with MetaGroupLengthElement and TransferSyntaxUID
IDataElement	getDataFromTag(int iGroupNumber, int iElementNumber) This method retrieves the data for specified Tag.
ISingleCollection<byte[]>	getFileMetaInformationVersion() Gets the File Meta Information Version.
byte[]	getHeader() This method serializes the FileMetaElements which are populated in the DicomFileHeader
java.lang.String	getImplementationClassUID() Retrieves Implementation Class UID.
java.lang.String	getImplementationVersionName() Retrieves a version for an Implementation Class UID using up to 16 characters of the repertoire.
int	getLength() This function gets the length of Dicom File Header.
java.lang.String	getMediaStorageSOPClassUID() Retrieves the SOP Class associated with the Data Set.
java.lang.String	getMediaStorageSOPInstanceUID() Retrieves the SOP Instance associated with the Data Set placed in the file and following the File Meta Information.
byte[]	getPreAmble() This method is used to get the preamble to be written before the header part
ISingleCollection<byte[]>	getPrivateInformation() This function gets the Private Information placed in the File Meta Information.
java.lang.String	getPrivateInformationCreatorUID() This function gets the The UID of the creator of the private information
java.lang.String	getSourceApplicationEntityTitle() Retrieves The DICOM Application Entity (AE) Title of the AE which wrote this file's content.
ITransferSyntax	getTransferSyntax() This method checks the UID for TransferSyntax and returns the appropriate TransferSyntax object
java.lang.String	getTransferSyntaxUID() This is the accessor method for TransferSyntax unique ID
ICollectionIterator<IDataElement>	iterator() Provides iterator over the collection of DataElements
void	populate(byte[] header) This method gets the byte buffer containing header part of a dicom file and populates itself with the DataElements present in the header
int	serialize(IDicomStream objIDicomStream) This method serializes Dicom File Header onto the stream attached to the header
void	setFileMetaInformationVersion(ISingleCollection<byte[]> objFileMetaInformationVersion) This is a two byte field where each bit identifies a version of this File Meta Information header.
void	setImplementationClassUID(java.lang.String strImplementationClassUID) Uniquely identifies the implementation which wrote this file and its content.
void	setImplementationVersionName(java.lang.String strImplementationVersionName) Sets a version for an Implementation Class UID using up to 16 characters of the repertoire.
void	setMediaStorageSOPClassUID(java.lang.String strMediaStorageSOPClassUID) Sets the SOP Class associated with the Data Set.
void	setMediaStorageSOPInstanceUID(java.lang.String strMediaStorageSOPInstanceUID) Sets the SOP Instance associated with the Data Set placed in the file and following the File Meta Information.
void	setPreAmble(byte[] bytePreamble) This method sets the 128 byte preamble in the dicom file header
void	setPrivateInformation(ISingleCollection<byte[]> objPrivateInformation) This function sets the Private Information placed in the File Meta Information.
void	setPrivateInformationCreatorUID(java.lang.String strPrivateInformationCreatorUID) This function sets the The UID of the creator of the private information
void	setSourceApplicationEntityTitle(java.lang.String strSourceApplicationEntityTitle) Sets the DICOM Application Entity (AE) Title of the AE which wrote this file's content.
void	setTransferSyntaxUID(java.lang.String strTransferSyntaxUID) This method sets the transfersyntax unique ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

DicomFileHeader

public DicomFileHeader()

Constructs DicomFileHeader by initializing headerlength to zero

Method Detail

setPreAmble

public void setPreAmble(byte[] bytePreamble)

This method sets the 128 byte preamble in the dicom file header

Specified by:

setPreAmble in interface IDicomFileHeader

Parameters:

bytePreamble - : 128 byte buffer containing preamble data

getPreAmble

public byte[] getPreAmble()

This method is used to get the preamble to be written before the header part

Specified by:

getPreAmble in interface IDicomFileHeader

Returns:

byte array containing preamble value.

populate

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

This method gets the byte buffer containing header part of a dicom file and populates itself with the DataElements present in the header

Specified by:

populate in interface IDicomFileHeader

Parameters:

header - byte array containing header value.

Throws:

InvalidHeaderException - if validation of header fails.

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

getTransferSyntax

public ITransferSyntax getTransferSyntax()

This method checks the UID for TransferSyntax and returns the appropriate TransferSyntax object

Specified by:

getTransferSyntax in interface IDicomFileHeader

Returns:

objITransferSyntax - object populated with appropriate transfersyntax from header

getHeader

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

This method serializes the FileMetaElements which are populated in the DicomFileHeader

Specified by:

getHeader in interface IDicomFileHeader

Returns:

byte[] - Byte array containing header value.

Throws:

InvalidHeaderException - if Header validation fails.

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

iterator

public ICollectionIterator<IDataElement> iterator()

Provides iterator over the collection of DataElements

Specified by:

iterator in interface ICollectionIterable<IDataElement>

Specified by:

iterator in interface java.lang.Iterable<IDataElement>

Returns:

Iterator - custom iterator over the collection of DataElements

getDataFromTag

public IDataElement getDataFromTag(int iGroupNumber,
                          int iElementNumber)

This method retrieves the data for specified Tag.

Specified by:

getDataFromTag in interface IDicomFileHeader

Parameters:

iGroupNumber - integer value of group number.

iElementNumber - integer value of element number.

Returns:

IDataElement - instance of DataElement.

createDefaultHeader

public void createDefaultHeader()
                         throws InvalidHeaderException

This method creates default header with MetaGroupLengthElement and TransferSyntaxUID

Specified by:

createDefaultHeader in interface IDicomFileHeader

Throws:

InvalidHeaderException - if Header validation fails.

serialize

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

This method serializes Dicom File Header onto the stream attached to the header

Specified by:

serialize in interface IDicomFileHeader

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

public void setTransferSyntaxUID(java.lang.String strTransferSyntaxUID)

This method sets the transfersyntax unique ID.

Specified by:

setTransferSyntaxUID in interface IDicomFileHeader

Parameters:

strTransferSyntaxUID - string value of transfersyntax.

getTransferSyntaxUID

public java.lang.String getTransferSyntaxUID()

This is the accessor method for TransferSyntax unique ID

Specified by:

getTransferSyntaxUID in interface IDicomFileHeader

Returns:

String - string value of transfersyntax unique ID

addDataElement

public int addDataElement(IDataElement objIDataElement)
                   throws InvalidHeaderException

Adds DataElements in the Header.

Specified by:

addDataElement in interface IDicomFileHeader

Parameters:

objIDataElement - specifies the Data Element to be added.

Returns:

int - shows status as success or failure.

Throws:

InvalidHeaderException - throws when the DataElement to be added does not obey increasing order of the Header DataElements

setFileMetaInformationVersion

public void setFileMetaInformationVersion(ISingleCollection<byte[]> objFileMetaInformationVersion)

This is a two byte field where each bit identifies a version of this File Meta Information header.

Parameters:

objFileMetaInformationVersion - - value of File Meta Information Version.

getFileMetaInformationVersion

public ISingleCollection<byte[]> getFileMetaInformationVersion()

Gets the File Meta Information Version.

Returns:

ISingleCollection - collection of byte array containing File Meta Information Version.

setMediaStorageSOPClassUID

public void setMediaStorageSOPClassUID(java.lang.String strMediaStorageSOPClassUID)

Sets the SOP Class associated with the Data Set.

Parameters:

strMediaStorageSOPClassUID - String vlaue of Media Storage SOP Class UID

getMediaStorageSOPClassUID

public java.lang.String getMediaStorageSOPClassUID()

Retrieves the SOP Class associated with the Data Set.

Returns:

String - value of Media Storage SOP Class UID

setMediaStorageSOPInstanceUID

public void setMediaStorageSOPInstanceUID(java.lang.String strMediaStorageSOPInstanceUID)

Sets the SOP Instance associated with the Data Set placed in the file and following the File Meta Information.

Parameters:

strMediaStorageSOPInstanceUID - String value of Media Storage SOP Instance UID

getMediaStorageSOPInstanceUID

public java.lang.String getMediaStorageSOPInstanceUID()

Retrieves the SOP Instance associated with the Data Set placed in the file and following the File Meta Information.

Returns:

String - String value of Media Storage SOP Instance UID.

setImplementationClassUID

public void setImplementationClassUID(java.lang.String strImplementationClassUID)

Uniquely identifies the implementation which wrote this file and its content.

Parameters:

strImplementationClassUID - String value of Implementation Class UID.

getImplementationClassUID

public java.lang.String getImplementationClassUID()

Retrieves Implementation Class UID.

Returns:

String - String value of Implementation Class UID.

setImplementationVersionName

public void setImplementationVersionName(java.lang.String strImplementationVersionName)

Sets a version for an Implementation Class UID using up to 16 characters of the repertoire.

Parameters:

strImplementationVersionName - String value of Implementation Version Name.

getImplementationVersionName

public java.lang.String getImplementationVersionName()

Retrieves a version for an Implementation Class UID using up to 16 characters of the repertoire.

Returns:

String - String value of Implementation Version Name.

setSourceApplicationEntityTitle

public void setSourceApplicationEntityTitle(java.lang.String strSourceApplicationEntityTitle)

Sets the DICOM Application Entity (AE) Title of the AE which wrote this file's content.

Parameters:

strSourceApplicationEntityTitle - String value of Source Application Entity Title.

getSourceApplicationEntityTitle

public java.lang.String getSourceApplicationEntityTitle()

Retrieves The DICOM Application Entity (AE) Title of the AE which wrote this file's content.

Returns:

String - String value of Source Application Entity Title.

setPrivateInformationCreatorUID

public void setPrivateInformationCreatorUID(java.lang.String strPrivateInformationCreatorUID)

This function sets the The UID of the creator of the private information

Parameters:

strPrivateInformationCreatorUID - String value of Private Information Creator UID.

getPrivateInformationCreatorUID

public java.lang.String getPrivateInformationCreatorUID()

This function gets the The UID of the creator of the private information

Returns:

String - value of Private Information Creator UID.

setPrivateInformation

public void setPrivateInformation(ISingleCollection<byte[]> objPrivateInformation)

This function sets the Private Information placed in the File Meta Information.

Parameters:

objPrivateInformation - byte array collection containing Private Information placed in the File Meta Information.

getPrivateInformation

public ISingleCollection<byte[]> getPrivateInformation()

This function gets the Private Information placed in the File Meta Information.

Returns:

ISingleCollection - Collection of byte array containing Private Information.

getLength

public int getLength()

This function gets the length of Dicom File Header.

Returns: