com.ibm.edms.od

Class ODTransform

java.lang.Object

com.ibm.edms.od.ODTransform

public class ODTransform
extends java.lang.Object

This ODTransform object represents the configuration settings for a single Generic transform to be defined to the ODWEK Java APIs. These objects are created during the ODServer.initialization call, and requires that you specify the XML file with the correct configuration options in the Properties object that is passed in with your ODConfig.
Additional information regarding the implementation of the generic transform can be found here: Content Manager OnDemand Web Enablement Kit (ODWEK) Java APIs: Generic Transform Interface

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AGNAME CmdParm value.
static java.lang.String	APPLNAME CmdParm value.
static java.lang.String	DOCUMENT_CARRIAGE_CONTROL CmdParm value.
static java.lang.String	DOCUMENT_CC_ANSI CmdParm value.
static java.lang.String	DOCUMENT_CC_MACHINE CmdParm value.
static java.lang.String	DOCUMENT_CC_NONE CmdParm value.
static java.lang.String	DOCUMENT_CODEPAGE CmdParm value.
static java.lang.String	DOCUMENT_INPUT_FILE_TYPE
static java.lang.String	DOCUMENT_LINE_DELIMITER CmdParm value.
static java.lang.String	DOCUMENT_PRMODE CmdParm value.
static java.lang.String	DOCUMENT_PRMODENONE CmdParm value.
static java.lang.String	DOCUMENT_PRMODESOSI1 CmdParm value.
static java.lang.String	DOCUMENT_PRMODESOSI2 CmdParm value.
static java.lang.String	DOCUMENT_PRMODESOSI3 CmdParm value.
static java.lang.String	DOCUMENT_RECORD_FORMAT CmdParm value.
static java.lang.String	DOCUMENT_RECORD_LENGTH CmdParm value.
static java.lang.String	DOCUMENT_RECORDFORMAT_FIXED CmdParm value.
static java.lang.String	DOCUMENT_RECORDFORMAT_STREAM CmdParm value.
static java.lang.String	DOCUMENT_RECORDFORMAT_VARIABLE CmdParm value.
static java.lang.String	DOCUMENT_RESOURCES CmdParm value.
static java.lang.String	DOCUMENT_ROTATION CmdParm value.
static java.lang.String	DOCUMENT_TRC_EXIST CmdParm value.
static java.lang.String	DOCUMENT_TRCNO CmdParm value.
static java.lang.String	DOCUMENT_TRCYES CmdParm value.
static java.lang.String	TRANSFORM_CLIENTCLASS If using Client Class interface, full name of the Client Class file to be loaded
static java.lang.String	TRANSFORM_CMDLINEEXE If using EXE interface, fully qualified file name of the transform Executable
static java.lang.String	TRANSFORM_DESC Transform Description
static java.lang.String	TRANSFORM_INPUTFILETYPE Input file type handled the Client Transform
static java.lang.String	TRANSFORM_MIMETYPE Expected output mimetype from the Client Transform call.
static java.lang.String	TRANSFORM_OUTPUTEXT Expected output extension from the Client Transform call.
static java.lang.String	TRANSFORM_PARMS OnDemand specific details as requested.
static java.lang.String	TRANSFORM_PASSTHRU Used to pass details, unrelated to ODWEK, to the Client transform.
static java.lang.String	TRANSFORM_PASSTHRU_CMDLINE Use this in the Passthru sections to pass additional options to the cmdline executable
static java.lang.String	TransformName Transform Name.
static java.lang.String	TransformXML TransformXML
static java.lang.String	TXFRM_INPUT_FILE CmdParm value.
static java.lang.String	TXFRM_REQ_DATA Map Key where the byte[] containing Document Data from OnDemand is stored.
static java.lang.String	TXFRM_REQ_METHOD Request Method.
static java.lang.String	TXFRM_REQ_NAME Map Key Request Name.
static java.lang.String	TXFRM_REQ_PROPS Map Key where the Request Properties is stored.
static java.lang.String	TXFRM_REQ_RES Map Key where the byte[] containing Document Resources from OnDemand is stored.
static java.lang.String	TXFRM_RESP_DATA Map Key Response Data.

Constructor Summary

Constructors

Constructor and Description
ODTransform()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientClass() Get ClientClass.
java.lang.String	getCmdLineExe() Get CmdLineExe.
java.util.Properties	getCmdParms() get Command Parms specified for this ODTransform.
java.util.Properties	getCmdParms(java.lang.String agname, java.lang.String appname) get Command Parms specified for this ODTransform for this Application Group, or this Application Group and Application.
char	getODFileType() Get ODFileType.
java.lang.String	getOutputExtension() Get Output Extension.
java.lang.String	getOutputMimeType() Get Output MimeType.
java.util.Properties	getPassthruParms() get PassThru parms specified for this ODTransform for this Application Group, or this Application Group and Application.
java.util.Properties	getPassthruParms(java.lang.String agname, java.lang.String appname)
java.lang.String	getTransformDescription() Get Transform Description
java.lang.String	getTransformName() Get the Viewer Name.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DOCUMENT_RECORD_FORMAT

public static final java.lang.String DOCUMENT_RECORD_FORMAT

CmdParm value. By specifying this string ("RECORDFORMAT") in the transform.xml, you can request that ODWEK return the relevant value as stored at the OnDemand Server.

DOCUMENT_RECORD_LENGTH

public static final java.lang.String DOCUMENT_RECORD_LENGTH

CmdParm value. By specifying this string ("RECORDLENGTH") in the transform.xml, you can request that ODWEK return the relevant value as stored at the OnDemand Server.

DOCUMENT_CARRIAGE_CONTROL

public static final java.lang.String DOCUMENT_CARRIAGE_CONTROL

CmdParm value. By specifying this string ("CARRIAGECONTROL") in the transform.xml, you can request that ODWEK return the relevant value as stored at the OnDemand Server.

DOCUMENT_TRC_EXIST

public static final java.lang.String DOCUMENT_TRC_EXIST

CmdParm value. By specifying this string ("TRC_EXIST") in the transform.xml, you can request that ODWEK return the relevant value as stored at the OnDemand Server.

DOCUMENT_ROTATION

public static final java.lang.String DOCUMENT_ROTATION

CmdParm value. By specifying this string ("DOCROTATION") in the transform.xml, you can request that ODWEK return the relevant value as stored at the OnDemand Server.

AGNAME

public static final java.lang.String AGNAME

CmdParm value. By specifying this string ("AG_NAME") in the transform.xml, you can request that ODWEK return the relevant value as stored at the OnDemand Server.

APPLNAME

public static final java.lang.String APPLNAME

CmdParm value. By specifying this string ("APPL_NAME") in the transform.xml, you can request that ODWEK return the relevant value as stored at the OnDemand Server.

DOCUMENT_CODEPAGE

public static final java.lang.String DOCUMENT_CODEPAGE

CmdParm value. By specifying this string ("CODEPAGE") in the transform.xml, you can request that ODWEK return the relevant value as stored at the OnDemand Server.

DOCUMENT_PRMODE

public static final java.lang.String DOCUMENT_PRMODE

CmdParm value. By specifying this string ("PRMODE") in the transform.xml, you can request that ODWEK return the relevant value as stored at the OnDemand Server.

DOCUMENT_LINE_DELIMITER

public static final java.lang.String DOCUMENT_LINE_DELIMITER

CmdParm value. By specifying this string ("LINEDELIMITER") in the transform.xml, you can request that ODWEK return the relevant value as stored at the OnDemand Server.

DOCUMENT_RESOURCES

public static final java.lang.String DOCUMENT_RESOURCES

CmdParm value. By specifying this string ("RESOURCES") in the transform.xml, you can request that ODWEK return the path to the AFP resource file.

DOCUMENT_INPUT_FILE_TYPE

public static final java.lang.String DOCUMENT_INPUT_FILE_TYPE

TXFRM_INPUT_FILE

public static final java.lang.String TXFRM_INPUT_FILE

CmdParm value. By specifying this string ("INPUTFILE") in the transform.xml, you can request that ODWEK return the path to the AFP resource file.

DOCUMENT_CC_ANSI

public static final java.lang.String DOCUMENT_CC_ANSI

CmdParm value. By specifying the string "CCANSI" in the transform.xml, you can request ODWEK to set the specified value in the cmdline when the Carriage Control is set to ANSI in the OnDemand Application View parameters.

DOCUMENT_CC_MACHINE

public static final java.lang.String DOCUMENT_CC_MACHINE

CmdParm value. By specifying the string "CCMACHINE" in the transform.xml, you can request ODWEK to set the specified value in the cmdline when the Carriage Control is set to MACHINE in the OnDemand Application View parameters.

DOCUMENT_CC_NONE

public static final java.lang.String DOCUMENT_CC_NONE

CmdParm value. By specifying the string "CCNONE" in the transform.xml, you can request ODWEK to set the specified value in the cmdline when the Carriage Control is set to NONE in the OnDemand Application View parameters.

DOCUMENT_RECORDFORMAT_FIXED

public static final java.lang.String DOCUMENT_RECORDFORMAT_FIXED

CmdParm value. By specifying the string "RECORDFORMATFIXED" in the transform.xml, you can request ODWEK to set the specified value in the cmdline when the Record Format is set to FIXED in the OnDemand Application View parameters.

DOCUMENT_RECORDFORMAT_VARIABLE

public static final java.lang.String DOCUMENT_RECORDFORMAT_VARIABLE

CmdParm value. By specifying the string "RECORDFORMATVARIABLE" in the transform.xml, you can request ODWEK to set the specified value in the cmdline when the Record Format is set to VARIABLE in the OnDemand Application View parameters.

DOCUMENT_RECORDFORMAT_STREAM

public static final java.lang.String DOCUMENT_RECORDFORMAT_STREAM

CmdParm value. By specifying the string "RECORDFORMATSTREAM" in the transform.xml, you can request ODWEK to set the specified value in the cmdline when the Record Format is set to STREAM in the OnDemand Application View parameters.

DOCUMENT_PRMODENONE

public static final java.lang.String DOCUMENT_PRMODENONE

CmdParm value. By specifying the string "PRMODENONE" in the transform.xml, you can request ODWEK to set the specified value in the cmdline when the PRMode is set to NONE in the OnDemand Application View parameters.

DOCUMENT_PRMODESOSI1

public static final java.lang.String DOCUMENT_PRMODESOSI1

CmdParm value. By specifying the string "PRMODESOSI1" in the transform.xml, you can request ODWEK to set the specified value in the cmdline when the PRMode is set to SOSI1 in the OnDemand Application View parameters.

DOCUMENT_PRMODESOSI2

public static final java.lang.String DOCUMENT_PRMODESOSI2

CmdParm value. By specifying the string "PRMODESOSI2" in the transform.xml, you can request ODWEK to set the specified value in the cmdline when the PRMode is set to SOSI2 in the OnDemand Application View parameters.

DOCUMENT_PRMODESOSI3

public static final java.lang.String DOCUMENT_PRMODESOSI3

CmdParm value. By specifying the string "PRMODESOSI3" in the transform.xml, you can request ODWEK to set the specified value in the cmdline when the PRMode is set to SOSI3 in the OnDemand Application View parameters.

DOCUMENT_TRCYES

public static final java.lang.String DOCUMENT_TRCYES

CmdParm value. By specifying the string "TRCYES" in the transform.xml, you can request ODWEK to set the specified value in the cmdline when the TRC is set to YES in the OnDemand Application View parameters.

DOCUMENT_TRCNO

public static final java.lang.String DOCUMENT_TRCNO

CmdParm value. By specifying the string "TRCNO" in the transform.xml, you can request ODWEK to set the specified value in the cmdline when the TRC is set to NO in the OnDemand Application View parameters.

TransformName

public static final java.lang.String TransformName

Transform Name. This value is used to call the transform. ie: This TransformName is passed into ODHit.Retrieve() as the viewer

TRANSFORM_DESC

public static final java.lang.String TRANSFORM_DESC

Transform Description

TRANSFORM_CLIENTCLASS

public static final java.lang.String TRANSFORM_CLIENTCLASS

If using Client Class interface, full name of the Client Class file to be loaded

TRANSFORM_CMDLINEEXE

public static final java.lang.String TRANSFORM_CMDLINEEXE

If using EXE interface, fully qualified file name of the transform Executable

TRANSFORM_INPUTFILETYPE

public static final java.lang.String TRANSFORM_INPUTFILETYPE

Input file type handled the Client Transform

TRANSFORM_MIMETYPE

public static final java.lang.String TRANSFORM_MIMETYPE

Expected output mimetype from the Client Transform call.

TRANSFORM_OUTPUTEXT

public static final java.lang.String TRANSFORM_OUTPUTEXT

Expected output extension from the Client Transform call.

TRANSFORM_PARMS

public static final java.lang.String TRANSFORM_PARMS

OnDemand specific details as requested. See CmdParms options

TRANSFORM_PASSTHRU

public static final java.lang.String TRANSFORM_PASSTHRU

Used to pass details, unrelated to ODWEK, to the Client transform.

TRANSFORM_PASSTHRU_CMDLINE

public static final java.lang.String TRANSFORM_PASSTHRU_CMDLINE

Use this in the Passthru sections to pass additional options to the cmdline executable

TXFRM_RESP_DATA

public static final java.lang.String TXFRM_RESP_DATA

Map Key Response Data. The transform output should be placed in the Map with this tag.

TXFRM_REQ_NAME

public static final java.lang.String TXFRM_REQ_NAME

Map Key Request Name. This will be the client requested Transform Name

TXFRM_REQ_METHOD

public static final java.lang.String TXFRM_REQ_METHOD

Request Method. This method must exist in the custom client class.

TXFRM_REQ_DATA

public static final java.lang.String TXFRM_REQ_DATA

Map Key where the byte[] containing Document Data from OnDemand is stored.

TXFRM_REQ_RES

public static final java.lang.String TXFRM_REQ_RES

Map Key where the byte[] containing Document Resources from OnDemand is stored.

TXFRM_REQ_PROPS

public static final java.lang.String TXFRM_REQ_PROPS

Map Key where the Request Properties is stored.

TransformXML

public static final java.lang.String TransformXML

TransformXML

Constructor Detail

ODTransform

public ODTransform()

Method Detail

getTransformName

public java.lang.String getTransformName()

Get the Viewer Name. This value will be used in calls to ODHit.retrieve(viewer), and also can be displayed to the end user.

Returns:

String Transform Name

getTransformDescription

public java.lang.String getTransformDescription()

Get Transform Description

Returns:

String Transform Description

getClientClass

public java.lang.String getClientClass()

Get ClientClass. This is the class name of the custom client class.

Returns:

String ClientClass

getCmdLineExe

public java.lang.String getCmdLineExe()

Get CmdLineExe. Fully qualified executable file

Returns:

String Executable

getODFileType

public char getODFileType()

Get ODFileType. This is the data type as stored in OnDemand.

Returns:

char

See Also:

ODConstant.FileTypeAFP, ODConstant.FileTypeBMP, ODConstant.FileTypeGIF, ODConstant.FileTypeJFIF, ODConstant.FileTypeLINE, ODConstant.FileTypeMETA, ODConstant.FileTypeNONE, ODConstant.FileTypePCX, ODConstant.FileTypePDF, ODConstant.FileTypePNG, ODConstant.FileTypeTIFF, ODConstant.FileTypeUSRDEF, ODConstant.FileTypeXML

getOutputExtension

public java.lang.String getOutputExtension()

Get Output Extension. This is extension that will output from the transform.

Returns:

String

getOutputMimeType

public java.lang.String getOutputMimeType()

Get Output MimeType.

Returns:

String Mimetype of the transformed document

getCmdParms

public java.util.Properties getCmdParms()

get Command Parms specified for this ODTransform. These parms indicate which document details are required by the transform, and the qualifier used to specify these values to the transform.

Returns:

Properties

getCmdParms

public java.util.Properties getCmdParms(java.lang.String agname,
                                        java.lang.String appname)

get Command Parms specified for this ODTransform for this Application Group, or this Application Group and Application. These parms indicate which document details are required by the transform, and the qualifier used to specify these values to the transform.

For example, if the <transform>.xml file has the following entries

 <transform>
   <CmdParms></CmdParms>
   <Passthru></Passthru>
   <ApplicationGroup name='agname1'>
      <CmdParms></CmdParms>
      <Passthru></Passthru>
      <Application name='appname1'>
         <CmdParms></CmdParms>
         <Passthru></Passthru>
      </Application>
   </ApplicationGroup>
 </transform>
 

and the value for agname is agname1 and appname is appname1, the CmdParms in bold will be returned. If the value for agname is agname1 and the appname value is not matched the CmdParms values beneath the Application Group will be returned. If neither the agname nor the appname is matched, the CmdParms values beneath the transform node will be returned.

Returns:

Properties

getPassthruParms

public java.util.Properties getPassthruParms()

get PassThru parms specified for this ODTransform for this Application Group, or this Application Group and Application. This properties object contains transform specific details and is not parsed by ODWEK.

For example, if the <transform>.xml file has the following entries

 <transform>
   <CmdParms></CmdParms>
   <Passthru></Passthru>
   <ApplicationGroup name='agname1'>
      <CmdParms></CmdParms>
      <Passthru></Passthru>
      <Application name='appname1'>
         <CmdParms></CmdParms>
         <Passthru></Passthru>
      </Application>
   </ApplicationGroup>
 </transform>
 

And the value for agname is agname1 and appname is appname1, the Passthru in bold will be returned. If the value for agname is agname1 and the appname value is null or is not matched the Passthru values beneath the Application Group will be returned. If neither the agname nor the appname is matched, the Passthru values beneath the transform node will be returned.

Returns:

Properties

getPassthruParms

public java.util.Properties getPassthruParms(java.lang.String agname,
                                             java.lang.String appname)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object