visit Kofax web site
de.softpro.signware.SPCleanParameter

de.softpro.signware.SPCleanParameter Class Reference

Inheritance diagram for de.softpro.signware.SPCleanParameter:

de.softpro.signware.SPSignwareObject List of all members.

Detailed Description

a representation of cleaning parameters
SPCleanParameter is used in SPImage.clean. SPCleanParameters can be serialized and deserialized

Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)


Public Member Functions

void addEnableFlag (String strName) throws SPSignwareException
 Add an enable flag to the end of the list.
void appendEnableFlag (String strName) throws SPSignwareException
 Add an enable flag to the end of the list.
void clearEnableFlags () throws SPSignwareException
 Clear all enable flags.
double getDoubleParameter (String strName) throws SPSignwareException
 Query the content of a property.
String getEnableFlag (int iIndex) throws SPSignwareException
 Query the enable flag at index iIndex.
int getEnableFlagCount () throws SPSignwareException
 Query the count of enable flags.
int getIntParameter (String strName) throws SPSignwareException
 Query the content of a property.
String getStringParameter (String strName) throws SPSignwareException
 Query the content of a property.
void setParameter (String strName, String aValue) throws SPSignwareException
 Set the value of a property.
void setParameter (String strName, double aValue) throws SPSignwareException
 Set the value of a property.
void setParameter (String strName, int aValue) throws SPSignwareException
 Set the value of a property.
 SPCleanParameter (byte[] flatFile) throws SPSignwareException
 Create from flatile.
 SPCleanParameter (SPCleanParameter clone) throws SPSignwareException
 Copy a CleanParameter object.
 SPCleanParameter () throws SPSignwareException
 Create a clean parameter object.

Package Functions

native final int jniFree ()

Constructor & Destructor Documentation

de.softpro.signware.SPCleanParameter.SPCleanParameter (   )  throws SPSignwareException
 

Create a clean parameter object.

Note:
Gray level cleaning is not yet supported
Exceptions:
SPSignwareException on error
  • SP_MEMORYERR out of memory
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPCleanParameterCreate

de.softpro.signware.SPCleanParameter.SPCleanParameter (  SPCleanParameter  clone  )  throws SPSignwareException
 

Copy a CleanParameter object.

The newly created object will be a true copy of the object passed as argument.

Parameters:
clone [i] the object to be copied
Exceptions:
SPSignwareException on error
  • SP_MEMORYERR out of memory
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPCleanParameterClone

de.softpro.signware.SPCleanParameter.SPCleanParameter (  byte[]  flatFile  )  throws SPSignwareException
 

Create from flatile.

Parameters:
flatFile [i] the serialized CleanParameter
Exceptions:
SPSignwareException on error
  • SP_MEMORYERR out of memory
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)

Member Function Documentation

void de.softpro.signware.SPCleanParameter.addEnableFlag (  String  strName  )  throws SPSignwareException
 

Add an enable flag to the end of the list.

Parameters:
strName [i] name of the enable flag that should be added to the list
Exceptions:
SPSignwareException on error
  • SP_PARAMERR illegal parameter, iIndex out of bounds
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPCleanParameterAddEnableFlag, SPImage.clean

void de.softpro.signware.SPCleanParameter.appendEnableFlag (  String  strName  )  throws SPSignwareException
 

Add an enable flag to the end of the list.

Parameters:
strName [i] name of the enable flag that should be added to the list
Exceptions:
SPSignwareException on error
  • SP_PARAMERR illegal parameter, iIndex out of bounds
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPCleanParameterAddEnableFlag, SPImage.clean

void de.softpro.signware.SPCleanParameter.clearEnableFlags (   )  throws SPSignwareException
 

Clear all enable flags.

Exceptions:
SPSignwareException on error
  • SP_PARAMERR illegal parameter, iIndex out of bounds
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPCleanParameterClearEnableFlags, SPImage.clean

double de.softpro.signware.SPCleanParameter.getDoubleParameter (  String  strName  )  throws SPSignwareException
 

Query the content of a property.

Parameters:
strName [i] the name of the property
Returns:
double the contents of the property.
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property, or not an integer and not a double
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPCleanParameterGetDouble

String de.softpro.signware.SPCleanParameter.getEnableFlag (  int  iIndex  )  throws SPSignwareException
 

Query the enable flag at index iIndex.

Parameters:
iIndex [i] index of the requested enable flag
Returns:
String the name of the enable flag at index iIndex
Exceptions:
SPSignwareException on error
  • SP_PARAMERR illegal parameter, iIndex out of bounds
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPCleanParameterGetEnableFlag, SPImage.clean

int de.softpro.signware.SPCleanParameter.getEnableFlagCount (   )  throws SPSignwareException
 

Query the count of enable flags.

Returns:
count of enable flags
Exceptions:
SPSignwareException on error
  • SP_PARAMERR illegal parameter, iIndex out of bounds
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPCleanParameterGetEnableFlag, SPImage.clean

int de.softpro.signware.SPCleanParameter.getIntParameter (  String  strName  )  throws SPSignwareException
 

Query the content of a property.

Parameters:
strName [i] the name of the property
Returns:
int the contents of the property.
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property, or not an integer
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPCleanParameterGetInt

String de.softpro.signware.SPCleanParameter.getStringParameter (  String  strName  )  throws SPSignwareException
 

Query the content of a property.

Parameters:
strName [i] the name of the property
Returns:
String the contents of the property.
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPCleanParameterGetString

native final int de.softpro.signware.SPCleanParameter.jniFree (   )  [package, virtual]
 

Implements de.softpro.signware.SPSignwareObject.

void de.softpro.signware.SPCleanParameter.setParameter (  String  strName,
String  aValue
)  throws SPSignwareException
 

Set the value of a property.

Parameters:
strName [i] the name of the property
aValue [i] the value of the property
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPCleanParameterSetString

void de.softpro.signware.SPCleanParameter.setParameter (  String  strName,
double  aValue
)  throws SPSignwareException
 

Set the value of a property.

Parameters:
strName [i] the name of the property
aValue [i] the value of the property
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPCleanParameterSetDouble

void de.softpro.signware.SPCleanParameter.setParameter (  String  strName,
int  aValue
)  throws SPSignwareException
 

Set the value of a property.

Parameters:
strName [i] the name of the property
aValue [i] the value of the property
Exceptions:
SPSignwareException on error
  • SP_PARAMERR undefined property
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a)
See also:
SPCleanParameterSetInt

The documentation for this class was generated from the following file: