com.ibm.nex.odpp
Class ODPP

java.lang.Object
  extended by com.ibm.nex.odpp.ODPP

public class ODPP
extends java.lang.Object


Field Summary
static java.lang.String COPYRIGHT
          Legal copyright notice.
 
Constructor Summary
ODPP()
          Constructs a new ODPP instance.
 
Method Summary
 NativeProvider createProvider(java.lang.String maskDefinition)
          Creates and returns a masking provider described and initialized with the values in the specified mask string.
 RowSet createRowSet(int rowCount, FieldDescriptor[] fieldDescriptors)
          Creates and returns a new row set with the specified number of rows and specified field descriptors.
 void initialize()
          Initializes the ODPP runtime environment.
 void setJNILIBNAME(java.lang.String JNILibName)
          Sets the JNI library name for interfacing with ODPP runtime.
 void shutdown()
          Shuts down the ODPP runtime environment.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Legal copyright notice.

See Also:
Constant Field Values
Constructor Detail

ODPP

public ODPP()
Constructs a new ODPP instance. This class has overall control of the ODPP runtime environment.

Method Detail

createProvider

public NativeProvider createProvider(java.lang.String maskDefinition)
Creates and returns a masking provider described and initialized with the values in the specified mask string.

Parameters:
maskDefinition - The maskDefinition. Cannot be null. Validated by called methods.
Returns:
The provider

createRowSet

public RowSet createRowSet(int rowCount,
                           FieldDescriptor[] fieldDescriptors)
Creates and returns a new row set with the specified number of rows and specified field descriptors. The fields in the rows are initialized with the value "**unassigned**"

Parameters:
rowCount - Number of rows.
fieldDescriptors - The field descriptors for a row.
Returns:
The row set.

initialize

public void initialize()
Initializes the ODPP runtime environment.

Throws:
ODPPException - Error while initializing ODPP framework -- Often due to missing or expired license file
java.lang.UnsatisfiedLinkError - Generally caused by a failure to load the JNI Library

setJNILIBNAME

public void setJNILIBNAME(java.lang.String JNILibName)
Sets the JNI library name for interfacing with ODPP runtime.

Parameters:
JNILibName - The JNI library name.

shutdown

public void shutdown()
Shuts down the ODPP runtime environment.