org.dicom4j.modules.media
Class FileMetaInformation

java.lang.Object
  org.dicom4j.data.DataSet
      org.dicom4j.modules.AbstractModule
          org.dicom4j.modules.media.FileMetaInformation

public class FileMetaInformation
extends AbstractModule

File Meta Information Module

Since:

0.0.8

Author:

Laurent Lecomte

Constructor Summary

FileMetaInformation()
Creates a new module

FileMetaInformation(DataSet aDataSet)
Creates a wrapper for data contains in the DataSet Modify data with an instance of this class will modify also data of the DataSet, IT'S NOT A COPY

Method Summary

void	addElements() add all Module Elements if not present in the DataSet
void	addModuleElements() add all module's element.
UnsignedLong	getFileMetaInformationGroupLength() Retrun the File Meta Information Group Length
UnsignedLong	getFileMetaInformationGroupLengthOrNull() Retrun the File Meta Information Group Length or null if doesn't exits
OtherByteString	getFileMetaInformationVersion() Retrun the File Meta Information Version
OtherByteString	getFileMetaInformationVersionOrNull() Retrun the File Meta Information Version or null if doesn't exits
UniqueIdentifier	getImplementationClassUID() Retrun the Implementation Class UID
UniqueIdentifier	getImplementationClassUIDOrNull() Retrun the Implementation Class UID or null if doesn't exits
UniqueIdentifier	getMediaStorageSOPClassUID() Retrun the Media Storage SOP Class UID
UniqueIdentifier	getMediaStorageSOPClassUIDOrNull() Retrun the Media Storage SOP Class UID or null if doesn't exits
UniqueIdentifier	getMediaStorageSOPInstanceUID() Retrun the Media Storage SOP Instance UID
UniqueIdentifier	getMediaStorageSOPInstanceUIDOrNull() Retrun the Media Storage SOP Instance UID or null if doesn't exits
String	getName() Return the name of the module
OtherByteString	getPrivateInformation() Retrun the Private Information
UniqueIdentifier	getPrivateInformationCreatorUID() Retrun the Private Information Creator UID
UniqueIdentifier	getPrivateInformationCreatorUIDOrNull() Retrun the Private Information Creator UID or null if doesn't exits
OtherByteString	getPrivateInformationOrNull() Retrun the Private Information or null if doesn't exits
ApplicationEntity	getSourceApplicationEntityTitle() Retrun the Source Application Entity Title
ApplicationEntity	getSourceApplicationEntityTitleOrNull() Retrun the Source Application Entity Title or null if doesn't exits
UniqueIdentifier	getTransferSyntaxUID() Retrun the Transfer Syntax UID
UniqueIdentifier	getTransferSyntaxUIDOrNull() Retrun the Transfer Syntax UID or null if doesn't exits
boolean	hasFileMetaInformationGroupLength() return true if the module has the File Meta Information Group Length element
boolean	hasFileMetaInformationVersion() return true if the module has the File Meta Information Version element
boolean	hasImplementationClassUID() return true if the module has the Implementation Class UID element
boolean	hasMediaStorageSOPClassUID() return true if the module has the Media Storage SOP Class UID element
boolean	hasMediaStorageSOPInstanceUID() return true if the module has the Media Storage SOP Instance UID element
boolean	hasPrivateInformation() return true if the module has the Private Information element
boolean	hasPrivateInformationCreatorUID() return true if the module has the Private Information Creator UID element
boolean	hasSourceApplicationEntityTitle() return true if the module has the Source Application Entity Title element
boolean	hasTransferSyntaxUID() return true if the module has the Transfer Syntax UID element

Methods inherited from class org.dicom4j.data.DataSet

addApplicationEntity, addCodeString, addDataSet, addElement, addIntegerString, addModule, addPersonName, addPersonName, addShortString, addUniqueIdentifier, clear, count, getApplicationEntity, getApplicationEntityOrNull, getAttribute, getCodeString, getDataElementsOfSameGroup, getDate, getDoubleValues, getElement, getElementOrNull, getIntegerString, getIterator, getLongString, getLongStringOrNull, getLongText, getLongTextOrNull, getOtherByteString, getOtherByteStringOrNull, getPersonName, getPersonNameOrNull, getSequenceOfItems, getSequenceOfItemsOrNull, getShortString, getTime, getUniqueIdentifier, getUniqueIdentifierOrNull, getUnsignedLong, getUnsignedLongOrNull, getUnsignedShort, hasElement, read, read, removeAll, removeElement, removeElement, toArray, toBytes, toString, write

Methods inherited from class java.lang.Object

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

Constructor Detail

FileMetaInformation

public FileMetaInformation()

Creates a new module

FileMetaInformation

public FileMetaInformation(DataSet aDataSet)

Creates a wrapper for data contains in the DataSet Modify data with an instance of this class will modify also data of the DataSet, IT'S NOT A COPY

Parameters:

aDataSet -

Method Detail

addElements

public void addElements()
                 throws Exception

add all Module Elements if not present in the DataSet

Throws:

Exception

getFileMetaInformationGroupLength

public UnsignedLong getFileMetaInformationGroupLength()
                                               throws NoSuchElementException,
                                                      WrongDataElementTypeException

Retrun the File Meta Information Group Length

Returns:

the File Meta Information Group Length

Throws:

NoSuchElementException

WrongDataElementTypeException

getFileMetaInformationGroupLengthOrNull

public UnsignedLong getFileMetaInformationGroupLengthOrNull()

Retrun the File Meta Information Group Length or null if doesn't exits

Returns:

the File Meta Information Group Length or null

getFileMetaInformationVersion

public OtherByteString getFileMetaInformationVersion()
                                              throws NoSuchElementException,
                                                     WrongDataElementTypeException

Retrun the File Meta Information Version

Returns:

the File Meta Information Version

Throws:

NoSuchElementException

WrongDataElementTypeException

getFileMetaInformationVersionOrNull

public OtherByteString getFileMetaInformationVersionOrNull()

Retrun the File Meta Information Version or null if doesn't exits

Returns:

the File Meta Information Version or null

getImplementationClassUID

public UniqueIdentifier getImplementationClassUID()
                                           throws NoSuchElementException,
                                                  WrongDataElementTypeException

Retrun the Implementation Class UID

Returns:

the Implementation Class UID

Throws:

NoSuchElementException

WrongDataElementTypeException

getImplementationClassUIDOrNull

public UniqueIdentifier getImplementationClassUIDOrNull()

Retrun the Implementation Class UID or null if doesn't exits

Returns:

the Implementation Class UID or null

getMediaStorageSOPClassUID

public UniqueIdentifier getMediaStorageSOPClassUID()
                                            throws NoSuchElementException,
                                                   WrongDataElementTypeException

Retrun the Media Storage SOP Class UID

Returns:

the Media Storage SOP Class UID

Throws:

NoSuchElementException

WrongDataElementTypeException

getMediaStorageSOPClassUIDOrNull

public UniqueIdentifier getMediaStorageSOPClassUIDOrNull()

Retrun the Media Storage SOP Class UID or null if doesn't exits

Returns:

the Media Storage SOP Class UID or null

getMediaStorageSOPInstanceUID

public UniqueIdentifier getMediaStorageSOPInstanceUID()
                                               throws NoSuchElementException,
                                                      WrongDataElementTypeException

Retrun the Media Storage SOP Instance UID

Returns:

the Media Storage SOP Instance UID

Throws:

NoSuchElementException

WrongDataElementTypeException

getMediaStorageSOPInstanceUIDOrNull

public UniqueIdentifier getMediaStorageSOPInstanceUIDOrNull()

Retrun the Media Storage SOP Instance UID or null if doesn't exits

Returns:

the Media Storage SOP Instance UID or null

getName

public String getName()

Description copied from class: AbstractModule

Return the name of the module

Specified by:

getName in class AbstractModule

Returns:

the name

getPrivateInformation

public OtherByteString getPrivateInformation()
                                      throws NoSuchElementException,
                                             WrongDataElementTypeException

Retrun the Private Information

Returns:

the Private Information

Throws:

NoSuchElementException

WrongDataElementTypeException

getPrivateInformationCreatorUID

public UniqueIdentifier getPrivateInformationCreatorUID()
                                                 throws NoSuchElementException,
                                                        WrongDataElementTypeException

Retrun the Private Information Creator UID

Returns:

the Private Information Creator UID

Throws:

NoSuchElementException

WrongDataElementTypeException

getPrivateInformationCreatorUIDOrNull

public UniqueIdentifier getPrivateInformationCreatorUIDOrNull()

Retrun the Private Information Creator UID or null if doesn't exits

Returns:

the Private Information Creator UID or null

getPrivateInformationOrNull

public OtherByteString getPrivateInformationOrNull()

Retrun the Private Information or null if doesn't exits

Returns:

the Private Information or null

getSourceApplicationEntityTitle

public ApplicationEntity getSourceApplicationEntityTitle()
                                                  throws NoSuchElementException,
                                                         WrongDataElementTypeException

Retrun the Source Application Entity Title

Returns:

the Source Application Entity Title

Throws:

NoSuchElementException

WrongDataElementTypeException

getSourceApplicationEntityTitleOrNull

public ApplicationEntity getSourceApplicationEntityTitleOrNull()

Retrun the Source Application Entity Title or null if doesn't exits

Returns:

the Source Application Entity Title or null

getTransferSyntaxUID

public UniqueIdentifier getTransferSyntaxUID()
                                      throws NoSuchElementException,
                                             WrongDataElementTypeException

Retrun the Transfer Syntax UID

Returns:

the Transfer Syntax UID

Throws:

NoSuchElementException

WrongDataElementTypeException

getTransferSyntaxUIDOrNull

public UniqueIdentifier getTransferSyntaxUIDOrNull()

Retrun the Transfer Syntax UID or null if doesn't exits

Returns:

the Transfer Syntax UID or null

hasFileMetaInformationGroupLength

public boolean hasFileMetaInformationGroupLength()

return true if the module has the File Meta Information Group Length element

Returns:

true if present

hasFileMetaInformationVersion

public boolean hasFileMetaInformationVersion()

return true if the module has the File Meta Information Version element

Returns:

true if present

hasImplementationClassUID

public boolean hasImplementationClassUID()

return true if the module has the Implementation Class UID element

Returns:

true if present

hasMediaStorageSOPClassUID

public boolean hasMediaStorageSOPClassUID()

return true if the module has the Media Storage SOP Class UID element

Returns:

true if present

hasMediaStorageSOPInstanceUID

public boolean hasMediaStorageSOPInstanceUID()

return true if the module has the Media Storage SOP Instance UID element

Returns:

true if present

hasPrivateInformation

public boolean hasPrivateInformation()

return true if the module has the Private Information element

Returns:

true if present

hasPrivateInformationCreatorUID

public boolean hasPrivateInformationCreatorUID()

return true if the module has the Private Information Creator UID element

Returns:

true if present

hasSourceApplicationEntityTitle

public boolean hasSourceApplicationEntityTitle()

return true if the module has the Source Application Entity Title element

Returns:

true if present

hasTransferSyntaxUID

public boolean hasTransferSyntaxUID()

return true if the module has the Transfer Syntax UID element

Returns:

true if present

addModuleElements

public void addModuleElements()

Description copied from class: AbstractModule

add all module's element. Added elements depend of the module

Overrides:

addModuleElements in class AbstractModule