IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

com.ibm.db2.wrapper
Class DefaultRemoteFunction

java.lang.Object
  extended bycom.ibm.db2.wrapper.DefaultRemoteFunction

public final class DefaultRemoteFunction
extends java.lang.Object

The DefaultRemoteFunction class represents a simple remote function mapping. It can be used within the UnfencedServer.insertRemoteFunction(DefaultRemoteFunction) method to add a temporary function mapping definition to the UnfencedServer object.

Since:
IBM WebSphere Information Integrator Version 9.1

Constructor Summary
DefaultRemoteFunction()
          Class constructor
DefaultRemoteFunction(java.lang.String localSignature, java.lang.String remoteFunctionName, short remoteResultType, double iosPerInvoke, double instsPerInvoke, double iosPerArgByte, double instsPerArgByte, short percentArgByte, double initialIos, double initialInsts)
          Construct an instance with the specified values.
 
Method Summary
 double getInitialInsts()
          Returns the number of machine instructions executed the first time the function is executed
 double getInitialIos()
          Returns the number of I/O operations the first time the function is executed
 double getInstsPerArgByte()
          Returns the number of machine instructions per byte of argument for one invocation of the function.
 double getInstsPerInvoke()
          Returns the number of machine instructions per invocation of the function.
 double getIosPerArgByte()
          Returns the number of I/O operations per byte of argument for one invocation of the function.
 double getIosPerInvoke()
          Returns the number of I/O operations per invocation of the function.
 java.lang.String getLocalSignature()
          Returns the local signature of the function
 short getPercentArgByte()
          Retruns the precentage of arguments bytes
 java.lang.String getRemoteFunctionName()
          Returns the remote name of the function
 short getRemoteResultType()
          Returns the result type of the function.
 boolean isInitialInstsValid()
          Check to see if a value for the number of machine instructions executed the first time the function is executed was specified
 boolean isInitialIosValid()
          Check to see if a value for the number of I/O operations the first time the function is executed was specified
 boolean isInstsPerArgByteValid()
          Check to see if a value for the number of machine instructions per byte of argument for one invocation was specified
 boolean isInstsPerInvokeValid()
          Check to see if a value for the number of machine instructions per invocation was specified
 boolean isIosPerArgByteValid()
          Check to see if a value for the number of I/O operations per byte of argument for one invocation was specified
 boolean isIosPerInvokeValid()
          Check to see if a value for the number of I/O operations per invocation was specified
 boolean isLocalSignatureValid()
          Check to see if a local function signature was specified
 boolean isPercentArgByteValid()
          Check to see if a value for the percentage of arguments bytes was specified
 boolean isRemoteFunctionNameValid()
          Check to see if a remote function name was specified
 boolean isRemoteResultTypeValid()
          Check to see if a remote result type was specified
 void setInitialInsts(double initialInsts)
          Set the value for the number of machine instructions executed the first time the function is executed
 void setInitialIos(double initialIos)
          Set the value for the number of I/O operations the first time the function is executed
 void setInstsPerArgByte(double instsPerArgByte)
          Set the value for the number of machine instructions per byte of argument for one invocation of the function.
 void setInstsPerInvoke(double instsPerInvoke)
          Set the value for the number of machine instructions per invocation of the function.
 void setIosPerArgByte(double iosPerArgByte)
          Set the value for the number of I/O operations per byte of argument for one invocation of the function.
 void setIosPerInvoke(double iosPerInvoke)
          Set the value for the number of I/O operations per invocation of the function.
 void setLocalSignature(java.lang.String localSignature)
          Set the value for the local signature.
 void setPercentArgByte(short percentArgByte)
          Set the value for the percentage of arguments bytes
 void setRemoteFunctionName(java.lang.String remoteFunctionName)
          Set the value for the remote function name.
 void setRemoteResultType(short remoteResultType)
          Set the value for the result type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultRemoteFunction

public DefaultRemoteFunction()
Class constructor

Since:
IBM WebSphere Information Integrator Version 9.1

DefaultRemoteFunction

public DefaultRemoteFunction(java.lang.String localSignature,
                             java.lang.String remoteFunctionName,
                             short remoteResultType,
                             double iosPerInvoke,
                             double instsPerInvoke,
                             double iosPerArgByte,
                             double instsPerArgByte,
                             short percentArgByte,
                             double initialIos,
                             double initialInsts)
Construct an instance with the specified values.

Parameters:
localSignature - The local signature
remoteFunctionName - The remote function name
remoteResultType - The return type of the function.
iosPerInvoke - number of I/O operations per invocation.
instsPerInvoke - number of machine instructions per invocation.
iosPerArgByte - number of I/O operations per byte of argument.
instsPerArgByte - number of machine instructions per byte of argument.
percentArgByte - precentage of arguments bytes
initialIos - number of I/O operations
initialInsts - number of machine instructions
Since:
IBM WebSphere Information Integrator Version 9.1
Method Detail

getInitialInsts

public double getInitialInsts()
Returns the number of machine instructions executed the first time the function is executed

Returns:
number of machine instructions
Since:
IBM WebSphere Information Integrator Version 9.1

getInitialIos

public double getInitialIos()
Returns the number of I/O operations the first time the function is executed

Returns:
number of I/O operations
Since:
IBM WebSphere Information Integrator Version 9.1

getInstsPerArgByte

public double getInstsPerArgByte()
Returns the number of machine instructions per byte of argument for one invocation of the function.

Returns:
number of machine instructions per byte of argument.
Since:
IBM WebSphere Information Integrator Version 9.1

getInstsPerInvoke

public double getInstsPerInvoke()
Returns the number of machine instructions per invocation of the function.

Returns:
number of machine instructions per invocation.
Since:
IBM WebSphere Information Integrator Version 9.1

getIosPerArgByte

public double getIosPerArgByte()
Returns the number of I/O operations per byte of argument for one invocation of the function.

Returns:
number of I/O operations per byte of argument.
Since:
IBM WebSphere Information Integrator Version 9.1

getIosPerInvoke

public double getIosPerInvoke()
Returns the number of I/O operations per invocation of the function.

Returns:
number of I/O operations per invocation.
Since:
IBM WebSphere Information Integrator Version 9.1

getLocalSignature

public java.lang.String getLocalSignature()
Returns the local signature of the function

Returns:
local signature
Since:
IBM WebSphere Information Integrator Version 9.1

getPercentArgByte

public short getPercentArgByte()
Retruns the precentage of arguments bytes

Returns:
percentage of arguments bytes
Since:
IBM WebSphere Information Integrator Version 9.1

getRemoteFunctionName

public java.lang.String getRemoteFunctionName()
Returns the remote name of the function

Returns:
remote function name
Since:
IBM WebSphere Information Integrator Version 9.1

getRemoteResultType

public short getRemoteResultType()
Returns the result type of the function. This can be any data type defined in Data.

Returns:
result type
Since:
IBM WebSphere Information Integrator Version 9.1

isInitialInstsValid

public boolean isInitialInstsValid()
Check to see if a value for the number of machine instructions executed the first time the function is executed was specified

Returns:
true if a value is specified, false otherwise.
Since:
IBM WebSphere Information Integrator Version 9.1

isInitialIosValid

public boolean isInitialIosValid()
Check to see if a value for the number of I/O operations the first time the function is executed was specified

Returns:
true if a value is specified, false otherwise.
Since:
IBM WebSphere Information Integrator Version 9.1

isInstsPerArgByteValid

public boolean isInstsPerArgByteValid()
Check to see if a value for the number of machine instructions per byte of argument for one invocation was specified

Returns:
true if a value is specified, false otherwise.
Since:
IBM WebSphere Information Integrator Version 9.1

isInstsPerInvokeValid

public boolean isInstsPerInvokeValid()
Check to see if a value for the number of machine instructions per invocation was specified

Returns:
true if a value is specified, false otherwise.
Since:
IBM WebSphere Information Integrator Version 9.1

isIosPerArgByteValid

public boolean isIosPerArgByteValid()
Check to see if a value for the number of I/O operations per byte of argument for one invocation was specified

Returns:
true if a value is specified, false otherwise.
Since:
IBM WebSphere Information Integrator Version 9.1

isIosPerInvokeValid

public boolean isIosPerInvokeValid()
Check to see if a value for the number of I/O operations per invocation was specified

Returns:
true if a value is specified, false otherwise.
Since:
IBM WebSphere Information Integrator Version 9.1

isLocalSignatureValid

public boolean isLocalSignatureValid()
Check to see if a local function signature was specified

Returns:
true if a value is specified, false otherwise.
Since:
IBM WebSphere Information Integrator Version 9.1

isPercentArgByteValid

public boolean isPercentArgByteValid()
Check to see if a value for the percentage of arguments bytes was specified

Returns:
true if a value is specified, false otherwise.
Since:
IBM WebSphere Information Integrator Version 9.1

isRemoteFunctionNameValid

public boolean isRemoteFunctionNameValid()
Check to see if a remote function name was specified

Returns:
true if a value is specified, false otherwise.
Since:
IBM WebSphere Information Integrator Version 9.1

isRemoteResultTypeValid

public boolean isRemoteResultTypeValid()
Check to see if a remote result type was specified

Returns:
true if a value is specified, false otherwise.
Since:
IBM WebSphere Information Integrator Version 9.1

setInitialInsts

public void setInitialInsts(double initialInsts)
Set the value for the number of machine instructions executed the first time the function is executed

Parameters:
initialInsts - number of machine instructions
Since:
IBM WebSphere Information Integrator Version 9.1

setInitialIos

public void setInitialIos(double initialIos)
Set the value for the number of I/O operations the first time the function is executed

Parameters:
initialIos - number of I/O operations
Since:
IBM WebSphere Information Integrator Version 9.1

setInstsPerArgByte

public void setInstsPerArgByte(double instsPerArgByte)
Set the value for the number of machine instructions per byte of argument for one invocation of the function.

Parameters:
instsPerArgByte - number of machine instructions per byte of argument.
Since:
IBM WebSphere Information Integrator Version 9.1

setInstsPerInvoke

public void setInstsPerInvoke(double instsPerInvoke)
Set the value for the number of machine instructions per invocation of the function.

Parameters:
instsPerInvoke - number of machine instructions per invocation.
Since:
IBM WebSphere Information Integrator Version 9.1

setIosPerArgByte

public void setIosPerArgByte(double iosPerArgByte)
Set the value for the number of I/O operations per byte of argument for one invocation of the function.

Parameters:
iosPerArgByte - number of I/O operations per byte of argument.
Since:
IBM WebSphere Information Integrator Version 9.1

setIosPerInvoke

public void setIosPerInvoke(double iosPerInvoke)
Set the value for the number of I/O operations per invocation of the function.

Parameters:
iosPerInvoke - number of I/O operations per invocation.
Since:
IBM WebSphere Information Integrator Version 9.1

setLocalSignature

public void setLocalSignature(java.lang.String localSignature)
Set the value for the local signature. The name consists of the schema and signature of the local function - for example: "SYSIBM.+(FLOAT, FLOAT)"

Parameters:
localSignature - The local signature
Since:
IBM WebSphere Information Integrator Version 9.1

setPercentArgByte

public void setPercentArgByte(short percentArgByte)
Set the value for the percentage of arguments bytes

Parameters:
percentArgByte - precentage of arguments bytes
Since:
IBM WebSphere Information Integrator Version 9.1

setRemoteFunctionName

public void setRemoteFunctionName(java.lang.String remoteFunctionName)
Set the value for the remote function name. The name should be provided in the V-2 style - for example: "LENGTH(1P, 2P)"

Parameters:
remoteFunctionName - The remote function name
Since:
IBM WebSphere Information Integrator Version 9.1

setRemoteResultType

public void setRemoteResultType(short remoteResultType)
Set the value for the result type. This can be any data type defined in Data.

Parameters:
remoteResultType - The return type of the function.
Since:
IBM WebSphere Information Integrator Version 9.1

IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

(C)Copyright IBM Corp. 2002. All rights reserved.

Links on this page are made available for your convenience and may take you to non-IBM sites. IBM does not warrant any sample code provided on these sites.