cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class PrintRequestModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.PrintRequestModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class PrintRequestModule
extends Module

\* This module specifies the Attributes that identify the print request.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
PrintRequestModule(IDataSet objIDataSet) Instantiates a new prints the request module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAnnotationFlag() Retrieves Flag describing how printers that do not support Annotation Content Sequence (2130,0050) shall react if it is contained in the Stored Print IOD.
java.lang.String	getCollationFlag() Retrieves Flag indicating that the films of the print request shall be collated.
java.lang.String	getColorImagePrintingFlag() Retrieves Flag describing how grayscale printers shall print color images.
java.lang.String	getConfigurationInformation() Retrieves character string that contains either the ID of the printer configuration table that contains a set of values for implementation specific print parameters (e.g.
java.lang.String	getFilmDestination() Retrieves Film destination.
java.lang.String	getFilmSessionLabel() Retrieves Human readable label that identifies the film session.
short	getIllumination() Retrieves luminance of lightbox illuminating a piece of transmissive film, or for the case of reflective media, luminance obtainable from diffuse reflection of the illumination present.
java.lang.String	getImageBoxPresentationLUTFlag() Retrieves Image Box Presentation LUT Flag.
java.lang.String	getImageOverlayFlag() Retrieves Flag describing how printers that do not support Image Overlay Box Content Sequence (2130,0060) shall react if it is contained in the Stored Print IOD.
java.lang.String	getMediumType() Retrieves type of medium on which the print job will be printed.
java.lang.String	getMemoryAllocation() Retrieves Amount of memory allocated for the film session expressed in KB.
java.lang.String	getNumberOfCopies() Retrieves number of copies to be printed for each film of the film session.
java.lang.String	getOwnerID() Retrieves identification of the owner of the film session.
java.lang.String	getPresentationLUTFlag() Retrieves Flag describing how printers that do not support Presentation LUT Content Sequence (2130,0080) shall react if it is contained in the Stored Print IOD.
java.lang.String	getPrintPriority() Retrieves the priority of the print job.
ReferencedStoredPrintSequence	getReferencedStoredPrintSequence() Retrieves pre-initialized object of Referenced Stored Print Sequence.
short	getReflectedAmbientLight() Retrieves luminance contribution due to reflected ambient light.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setAnnotationFlag(EnumAnnotationFlag enumAnnotationFlag) Sets Flag describing how printers that do not support Annotation Content Sequence (2130,0050) shall react if it is contained in the Stored Print IOD.
void	setCollationFlag(EnumCollationFlag enumCollationFlag) Sets Flag indicating that the films of the print request shall be collated.
void	setColorImagePrintingFlag(EnumColorImagePrintingFlag enumColorImagePrintingFlag) Sets Flag describing how grayscale printers shall print color images.
void	setConfigurationInformation(EnumConfigurationInformation enumConfigurationInformation) Sets character string that contains either the ID of the printer configuration table that contains a set of values for implementation specific print parameters (e.g.
void	setFilmDestination(EnumFilmDestination enumFilmDestination) Sets Film destination.
void	setFilmSessionLabel(java.lang.String strFilmSessionLabel) Sets Human readable label that identifies the film session.
void	setIllumination(short shIllumination) Sets luminance of lightbox illuminating a piece of transmissive film, or for the case of reflective media, luminance obtainable from diffuse reflection of the illumination present.
void	setImageBoxPresentationLUTFlag(EnumImageBoxPresentationLUTFlag enumImageBoxPresentationLUTFlag) Sets Flag describing how printers that do not support Presentation LUT Content Sequence (2130,0080) at the Image Box level shall react if a Presentation LUT is contained in Image Box Content Sequence (2130,0040).
void	setImageOverlayFlag(EnumImageOverlayFlag enumImageOverlayFlag) Sets Flag describing how printers that do not support Image Overlay Box Content Sequence (2130,0060) shall react if it is contained in the Stored Print IOD.
void	setMediumType(EnumMediumType enumMediumType) Sets type of medium on which the print job will be printed.
void	setMemoryAllocation(java.lang.String strMemoryAllocation) Sets Amount of memory allocated for the film session expressed in KB.
void	setNumberOfCopies(java.lang.String strNumberOfCopies) Sets number of copies to be printed for each film of the film session.
void	setOwnerID(java.lang.String strOwnerID) Sets Identification of the owner of the film session.
void	setPresentationLUTFlag(EnumImageOverlayFlag enumPresentationLUTFlag) Sets Flag describing how printers that do not support Presentation LUT Content Sequence (2130,0080) shall react if it is contained in the Stored Print IOD.
void	setPrintPriority(EnumPrintPriority enumPrintPriority) Sets the priority of the print job.
void	setReflectedAmbientLight(short shReflectedAmbientLight) Sets luminance contribution due to reflected ambient light.
boolean	validateModule() Validates each Attribute in the Module according to the Type of the Attribute.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

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

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

PrintRequestModule

public PrintRequestModule(IDataSet objIDataSet)

Instantiates a new prints the request module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

Validates each Attribute in the Module according to the Type of the Attribute. Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

Boolean - status indicating success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setNumberOfCopies

public void setNumberOfCopies(java.lang.String strNumberOfCopies)

Sets number of copies to be printed for each film of the film session.

Parameters:

strNumberOfCopies - String value of Number Of Copies.

getNumberOfCopies

public java.lang.String getNumberOfCopies()

Retrieves number of copies to be printed for each film of the film session.

Returns:

String - String value of Number Of Copies.

setPrintPriority

public void setPrintPriority(EnumPrintPriority enumPrintPriority)

Sets the priority of the print job. Enumerated Values: HIGH, MED, LOW.

Parameters:

enumPrintPriority - the enum print priority

getPrintPriority

public java.lang.String getPrintPriority()

Retrieves the priority of the print job.

Returns:

String - String value of Print Priority.

setMediumType

public void setMediumType(EnumMediumType enumMediumType)

Sets type of medium on which the print job will be printed. Defined Terms: PAPER, CLEAR FILM, BLUE FILM, MAMMO CLEAR FILM, MAMMO BLUE FILM.

Parameters:

enumMediumType - Enum value of Medium Type.

getMediumType

public java.lang.String getMediumType()

Retrieves type of medium on which the print job will be printed.

Returns:

String - String value of Medium Type.

setFilmDestination

public void setFilmDestination(EnumFilmDestination enumFilmDestination)

Sets Film destination. Defined Terms: MAGAZINE = the exposed film is stored in film magazine. PROCESSOR = the exposed film is developed in film processor. BIN_i = the exposed film is deposited in a sorter bin where I represents the bin number. Film sorter BINs shall be numbered sequentially starting from one and no maxiumu is placed on the number of BINs. The encoding of the BIN number shall not contain leading zeros.

Parameters:

enumFilmDestination - Enum value of Film Destination.

getFilmDestination

public java.lang.String getFilmDestination()

Retrieves Film destination.

Returns:

String - String value of Film destination.

setFilmSessionLabel

public void setFilmSessionLabel(java.lang.String strFilmSessionLabel)

Sets Human readable label that identifies the film session.

Parameters:

strFilmSessionLabel - String value of Film Session Label.

getFilmSessionLabel

public java.lang.String getFilmSessionLabel()

Retrieves Human readable label that identifies the film session.

Returns:

String - String value of Film Session Label.

setMemoryAllocation

public void setMemoryAllocation(java.lang.String strMemoryAllocation)

Sets Amount of memory allocated for the film session expressed in KB.

Parameters:

strMemoryAllocation - String value of Memory Allocation.

getMemoryAllocation

public java.lang.String getMemoryAllocation()

Retrieves Amount of memory allocated for the film session expressed in KB.

Returns:

String - String value of Memory Allocation.

setColorImagePrintingFlag

public void setColorImagePrintingFlag(EnumColorImagePrintingFlag enumColorImagePrintingFlag)

Sets Flag describing how grayscale printers shall print color images. Enumerated Values: BESTFIT = attempt to print color image pixel data on a grayscale printer. REJECT = do not attempt to print color image pixel data on a grayscale printer

Parameters:

enumColorImagePrintingFlag - Enum value of Color Image Printing Flag.

getColorImagePrintingFlag

public java.lang.String getColorImagePrintingFlag()

Retrieves Flag describing how grayscale printers shall print color images.

Returns:

String - String value of Color Image Printing Flag.

setCollationFlag

public void setCollationFlag(EnumCollationFlag enumCollationFlag)

Sets Flag indicating that the films of the print request shall be collated. Enumerated Values: YES, NO

Parameters:

enumCollationFlag - Enum value of Collation Flag.

getCollationFlag

public java.lang.String getCollationFlag()

Retrieves Flag indicating that the films of the print request shall be collated.

Returns:

String - String value of Collation Flag.

setAnnotationFlag

public void setAnnotationFlag(EnumAnnotationFlag enumAnnotationFlag)

Sets Flag describing how printers that do not support Annotation Content Sequence (2130,0050) shall react if it is contained in the Stored Print IOD. Enumerated Values: BESTFIT = print images without Annotation, REJECT = do not attempt to print images

Parameters:

enumAnnotationFlag - Enum value of Annotation Flag.

getAnnotationFlag

public java.lang.String getAnnotationFlag()

Retrieves Flag describing how printers that do not support Annotation Content Sequence (2130,0050) shall react if it is contained in the Stored Print IOD.

Returns:

String - String value of Annotation Flag.

setImageOverlayFlag

public void setImageOverlayFlag(EnumImageOverlayFlag enumImageOverlayFlag)

Sets Flag describing how printers that do not support Image Overlay Box Content Sequence (2130,0060) shall react if it is contained in the Stored Print IOD. Enumerated Values: BESTFIT = print images without the Overlay(s), REJECT = do not attempt to print images

Parameters:

enumImageOverlayFlag - Enum value of Image Overlay Flag.

getImageOverlayFlag

public java.lang.String getImageOverlayFlag()

Retrieves Flag describing how printers that do not support Image Overlay Box Content Sequence (2130,0060) shall react if it is contained in the Stored Print IOD.

Returns:

String - String value of Image Overlay Flag.

setPresentationLUTFlag

public void setPresentationLUTFlag(EnumImageOverlayFlag enumPresentationLUTFlag)

Sets Flag describing how printers that do not support Presentation LUT Content Sequence (2130,0080) shall react if it is contained in the Stored Print IOD. Enumerated Values: BESTFIT = print images without a Presentation LUT, REJECT = do not attempt to print images

Parameters:

enumPresentationLUTFlag - Enum value of Presentation LUT Flag.

getPresentationLUTFlag

public java.lang.String getPresentationLUTFlag()

Retrieves Flag describing how printers that do not support Presentation LUT Content Sequence (2130,0080) shall react if it is contained in the Stored Print IOD.

Returns:

String - String value of Presentation LUT Flag.

setImageBoxPresentationLUTFlag

public void setImageBoxPresentationLUTFlag(EnumImageBoxPresentationLUTFlag enumImageBoxPresentationLUTFlag)

Sets Flag describing how printers that do not support Presentation LUT Content Sequence (2130,0080) at the Image Box level shall react if a Presentation LUT is contained in Image Box Content Sequence (2130,0040). Enumerated Values: BESTFIT = print image with the Presentation LUT specified in Film Box Content Sequence (2130,0030). REJECT = do not attempt to print images

Parameters:

enumImageBoxPresentationLUTFlag - Enum value of Image Box Presentation LUT Flag.

getImageBoxPresentationLUTFlag

public java.lang.String getImageBoxPresentationLUTFlag()

Retrieves Image Box Presentation LUT Flag.

Returns:

String - String value of Image Box Presentation LUT Flag.

setConfigurationInformation

public void setConfigurationInformation(EnumConfigurationInformation enumConfigurationInformation)

Sets character string that contains either the ID of the printer configuration table that contains a set of values for implementation specific print parameters (e.g. perception LUT related parameters) or one or more configuration data values, encoded as characters.

Parameters:

enumConfigurationInformation - Enum value of Configuration Information.

getConfigurationInformation

public java.lang.String getConfigurationInformation()

Retrieves character string that contains either the ID of the printer configuration table that contains a set of values for implementation specific print parameters (e.g. perception LUT related parameters) or one or more configuration data values, encoded as characters.

Returns:

String - String value of Configuration Information.

setIllumination

public void setIllumination(short shIllumination)

Sets luminance of lightbox illuminating a piece of transmissive film, or for the case of reflective media, luminance obtainable from diffuse reflection of the illumination present.

Parameters:

shIllumination - short value of Illumination.

getIllumination

public short getIllumination()

Retrieves luminance of lightbox illuminating a piece of transmissive film, or for the case of reflective media, luminance obtainable from diffuse reflection of the illumination present.

Returns:

short - short value of Illumination.

setReflectedAmbientLight

public void setReflectedAmbientLight(short shReflectedAmbientLight)

Sets luminance contribution due to reflected ambient light.

Parameters:

shReflectedAmbientLight - the sh reflected ambient light

getReflectedAmbientLight

public short getReflectedAmbientLight()

Retrieves luminance contribution due to reflected ambient light.

Returns:

short - short value of Reflected Ambient Light.

setOwnerID

public void setOwnerID(java.lang.String strOwnerID)

Sets Identification of the owner of the film session.

Parameters:

strOwnerID - String value of Owner ID.

getOwnerID

public java.lang.String getOwnerID()

Retrieves identification of the owner of the film session.

Returns:

String - String value of Owner ID.

getReferencedStoredPrintSequence

public ReferencedStoredPrintSequence getReferencedStoredPrintSequence()

Retrieves pre-initialized object of Referenced Stored Print Sequence. If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

ReferencedStoredPrintSequence - instance of Referenced Stored Print Sequence.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

Collection of tags - returns the vector containing the collection of tags.