Atalasoft MobileImage API Reference
Public Member Functions | List of all members
com.kofax.kmc.ken.engines.data.ImagePerfectionProfile Class Reference

The ImagePerfectionProfile object encapsulates advanced image processing settings. This object is serializable. More...

Inheritance diagram for com.kofax.kmc.ken.engines.data.ImagePerfectionProfile:

Public Member Functions

 ImagePerfectionProfile ()
 
ImagePerfectionProfile clone ()
 Performs a field-for-field copy of instances of this class. More...
 
String getName ()
 Gets the application-defined name for this ImagePerfectionProfile object. More...
 
void setName (String name)
 Sets the application-defined name for this ImagePerfectionProfile object. More...
 
String getIpOperations ()
 Gets the image processing operations string. More...
 
void setIpOperations (String ipOperations)
 Sets the image processing operations string. More...
 
String getIpOperationsFilePath ()
 Gets the image processing settings file. More...
 
void setIpOperationsFilePath (String ipOperationsFilePath)
 Sets the image processing settings file. More...
 

Detailed Description

The ImagePerfectionProfile object encapsulates advanced image processing settings. This object is serializable.

Use this ImagePerfectionProfile object to specify advanced image processing settings to the ImageProcessor. These advanced image processing settings may have originated from a KFS Server, a TotalAgility Server or the application itself. The ImagePerfectionProfile allows for two ways of specifying those settings:

ImageProcessor operations string (ipOperations)
ImageProcessor operations XML file (ipOperationsFilePath)

If both ipOperations and ipOperationsFilePath are specified as non-blank, the ipOperations string is used and the other one is ignored.

ImagePerfectionProfile objects support serialization in a similar way to Image objects. The Image object documentation provides code examples for serialization and deserialization.

Constructor & Destructor Documentation

com.kofax.kmc.ken.engines.data.ImagePerfectionProfile.ImagePerfectionProfile ( )
inline

Member Function Documentation

ImagePerfectionProfile com.kofax.kmc.ken.engines.data.ImagePerfectionProfile.clone ( )
inline

Performs a field-for-field copy of instances of this class.

String com.kofax.kmc.ken.engines.data.ImagePerfectionProfile.getIpOperations ( )
inline

Gets the image processing operations string.

This specifies the image processing operations to be performed by the ImageProcessor. Please refer to the developers guide for a list of image processing operations tokens.

String com.kofax.kmc.ken.engines.data.ImagePerfectionProfile.getIpOperationsFilePath ( )
inline

Gets the image processing settings file.

This specifies the file containing image processing operations to be performed by the ImageProcessor.

String com.kofax.kmc.ken.engines.data.ImagePerfectionProfile.getName ( )
inline

Gets the application-defined name for this ImagePerfectionProfile object.

An application could use the name to describe the purpose of the image processing settings in this object.

void com.kofax.kmc.ken.engines.data.ImagePerfectionProfile.setIpOperations ( String  ipOperations)
inline

Sets the image processing operations string.

This specifies the image processing operations to be performed by the ImageProcessor. Please refer to the developers guide for a list of image processing operations tokens.

Exceptions
NullPointerException(ipOperations parameter is null).
void com.kofax.kmc.ken.engines.data.ImagePerfectionProfile.setIpOperationsFilePath ( String  ipOperationsFilePath)
inline

Sets the image processing settings file.

This specifies the file containing image processing operations to be performed by the ImageProcessor.

Exceptions
NullPointerException(ipOperationsFilePath parameter is null).
void com.kofax.kmc.ken.engines.data.ImagePerfectionProfile.setName ( String  name)
inline

Sets the application-defined name for this ImagePerfectionProfile object.

An application could use the name to describe the purpose of the image processing settings in this object.

Exceptions
NullPointerException(name parameter is null).

The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.