com.wm.app.tn.doc
Class BizDocAttributeTransform

java.lang.Object
  com.wm.app.tn.doc.BizDocAttributeTransform

All Implemented Interfaces:

com.wm.util.coder.IDataCodable

public class BizDocAttributeTransform
extends java.lang.Object
implements com.wm.util.coder.IDataCodable

This class is used for performing transformation functions on docment attributes. Correct usage is to create a new BizDocAttribute then create a new BizDocAttributeTransform object to associate it with. From there call the apply() method with supplied values to perform the transformation on.

Author:

Floyd West

Field Summary

static int	FN_AVG
static int	FN_CUSTOM
static int	FN_DATEX
static int	FN_DIV
static int	FN_MAX
static int	FN_MESSAGE_FORMAT
static int	FN_MIN
static int	FN_MULT
static int	FN_NONE Currently supported functions
static int	FN_PARTNER_LOOKUP
static int	FN_SUM
static int	FN_TO_LOWERCASE
static int	FN_TO_UPPERCASE

Constructor Summary

BizDocAttributeTransform()

BizDocAttributeTransform(BizDocAttribute bda, int fn, java.lang.String arg)
Creates a BizDocAttributeTransform object

BizDocAttributeTransform(BizDocAttribute bda, int fn, java.lang.String[] args)
Deprecated. As of 6.1, replaced by BizDocAttributeTransform(BizDocAttribute,int,String)

BizDocAttributeTransform(BizDocAttribute bda, int fn, java.lang.String[] args, int preFn, java.lang.String[] preFnArgs)
Deprecated. As of 6.1, replaced by BizDocAttributeTransform(BizDocAttribute,int,String,int,String)

BizDocAttributeTransform(BizDocAttribute bda, int fn, java.lang.String arg, int preFn, java.lang.String preFnArg)
Creates a BizDocAttributeTransform object

BizDocAttributeTransform(BizDocAttribute bda, java.lang.String svc, java.lang.String arg)
Creates a BizDocAttributeTransform object

BizDocAttributeTransform(com.wm.data.IData in)
Creates a BizDocAttributeTransform object

Method Summary

java.lang.Object	apply(java.lang.String[] values) Performs the transformation function on the inputted values
java.lang.Object	applyCustom(java.lang.String[] values, com.wm.data.IData data)
java.sql.Timestamp	applyDate(java.lang.String[] values)
java.sql.Timestamp[]	applyDateList(java.lang.String[] values)
static void	convertEmptyStringsToNull(java.lang.String[] values) For internal use only
java.lang.String	getArg()
java.lang.String[]	getArgs() Deprecated. As of 6.1, replaced by getArg()
BizDocAttribute	getAttribute()
java.lang.String	getCustomSvc()
int	getFunction()
static int	getFunctionCode(java.lang.String name)
java.lang.String	getFunctionName()
static java.lang.String	getFunctionName(int function)
com.wm.data.IData	getIData()
java.lang.String	getPreFnArg()
java.lang.String[]	getPreFnArgs() Deprecated. As of 6.1, replaced by getPreFnArg()
int	getPreFunction()
java.lang.String	getPreFunctionName()
void	setArg(java.lang.String arg)
void	setArgs(java.lang.String[] args) Deprecated. As of 6.1, replaced by setArg(String arg)
void	setAttribute(BizDocAttribute att)
void	setCustomSvc(java.lang.String svc)
void	setFunction(int fn)
void	setIData(com.wm.data.IData idata)
void	setPreFnArg(java.lang.String arg)
void	setPreFnArgs(java.lang.String[] args) Deprecated. As of 6.1, replaced by getPreFnArg()
void	setPreFunction(int fn)
java.lang.String	toString()
static void	validateAndSetReceiver(BizDocEnvelope env, java.lang.String id)
static void	validateAndSetReceiver(BizDocEnvelope env, java.lang.String id, java.lang.String origId)
static void	validateAndSetSender(BizDocEnvelope env, java.lang.String id)
static void	validateAndSetSender(BizDocEnvelope env, java.lang.String id, java.lang.String origId)
static java.lang.String	validatePartnerId(java.lang.String id)

Methods inherited from class java.lang.Object

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

Field Detail

FN_NONE

public static final int FN_NONE

Currently supported functions

See Also:

Constant Field Values

FN_MAX

public static final int FN_MAX

See Also:

Constant Field Values

FN_MIN

public static final int FN_MIN

See Also:

Constant Field Values

FN_SUM

public static final int FN_SUM

See Also:

Constant Field Values

FN_AVG

public static final int FN_AVG

See Also:

Constant Field Values

FN_MULT

public static final int FN_MULT

See Also:

Constant Field Values

FN_DIV

public static final int FN_DIV

See Also:

Constant Field Values

FN_PARTNER_LOOKUP

public static final int FN_PARTNER_LOOKUP

See Also:

Constant Field Values

FN_DATEX

public static final int FN_DATEX

See Also:

Constant Field Values

FN_TO_UPPERCASE

public static final int FN_TO_UPPERCASE

See Also:

Constant Field Values

FN_TO_LOWERCASE

public static final int FN_TO_LOWERCASE

See Also:

Constant Field Values

FN_MESSAGE_FORMAT

public static final int FN_MESSAGE_FORMAT

See Also:

Constant Field Values

FN_CUSTOM

public static final int FN_CUSTOM

See Also:

Constant Field Values

Constructor Detail

BizDocAttributeTransform

public BizDocAttributeTransform()

BizDocAttributeTransform

public BizDocAttributeTransform(BizDocAttribute bda,
                                int fn,
                                java.lang.String[] args)

Deprecated. As of 6.1, replaced by BizDocAttributeTransform(BizDocAttribute,int,String)

BizDocAttributeTransform

public BizDocAttributeTransform(BizDocAttribute bda,
                                int fn,
                                java.lang.String[] args,
                                int preFn,
                                java.lang.String[] preFnArgs)

Deprecated. As of 6.1, replaced by BizDocAttributeTransform(BizDocAttribute,int,String,int,String)

BizDocAttributeTransform

public BizDocAttributeTransform(BizDocAttribute bda,
                                int fn,
                                java.lang.String arg)

Creates a BizDocAttributeTransform object

Parameters:

bda - ignored

fn - transformation function to perform (use constants)

arg - argument to the transformation function

BizDocAttributeTransform

public BizDocAttributeTransform(BizDocAttribute bda,
                                int fn,
                                java.lang.String arg,
                                int preFn,
                                java.lang.String preFnArg)

Creates a BizDocAttributeTransform object

Parameters:

bda - ignored

fn - transformation function to perform (use constants)

arg - argument to the transformation function

preFn - transformation function that needs to be performed prior to fn (use constants)

preFnArg - argument to the pre transformation function

BizDocAttributeTransform

public BizDocAttributeTransform(com.wm.data.IData in)

Creates a BizDocAttributeTransform object

Parameters:

in - IData object containing values for class attributes

BizDocAttributeTransform

public BizDocAttributeTransform(BizDocAttribute bda,
                                java.lang.String svc,
                                java.lang.String arg)

Creates a BizDocAttributeTransform object

Parameters:

in - IData object containing values for class attributes

Method Detail

getAttribute

public BizDocAttribute getAttribute()

Returns:

the attribute associated with this transform.

apply

public java.lang.Object apply(java.lang.String[] values)
                       throws java.lang.Exception

Performs the transformation function on the inputted values

Parameters:

values - data to pass into the transformation function

Returns:

either a Double, String, java.sql.Timestamp, or null

Throws:

java.lang.Exception

applyCustom

public java.lang.Object applyCustom(java.lang.String[] values,
                                    com.wm.data.IData data)
                             throws java.lang.Exception

Throws:

java.lang.Exception

applyDate

public java.sql.Timestamp applyDate(java.lang.String[] values)

applyDateList

public java.sql.Timestamp[] applyDateList(java.lang.String[] values)

getPreFnArgs

public java.lang.String[] getPreFnArgs()

Deprecated. As of 6.1, replaced by getPreFnArg()

getPreFnArg

public java.lang.String getPreFnArg()

Returns:

the associated pre function argument

getPreFunction

public int getPreFunction()

Returns:

the pre transformation function

getArgs

public java.lang.String[] getArgs()

Deprecated. As of 6.1, replaced by getArg()

getArg

public java.lang.String getArg()

Returns:

the associated argument

getCustomSvc

public java.lang.String getCustomSvc()

Returns:

the custom transformation service

getFunction

public int getFunction()

Returns:

the transformation function

getFunctionName

public static java.lang.String getFunctionName(int function)

Returns:

a String name for the function

getFunctionCode

public static int getFunctionCode(java.lang.String name)

getFunctionName

public java.lang.String getFunctionName()

getPreFunctionName

public java.lang.String getPreFunctionName()

setPreFnArgs

public void setPreFnArgs(java.lang.String[] args)

Deprecated. As of 6.1, replaced by getPreFnArg()

setPreFnArg

public void setPreFnArg(java.lang.String arg)

Parameters:

arg - argument for the associated pre function

setPreFunction

public void setPreFunction(int fn)

Parameters:

fn - function to perform prior to the function specified by setFunction (use constants)

setArgs

public void setArgs(java.lang.String[] args)

Deprecated. As of 6.1, replaced by setArg(String arg)

setArg

public void setArg(java.lang.String arg)

Parameters:

arg - argument for the associated function

setCustomSvc

public void setCustomSvc(java.lang.String svc)

Parameters:

svc - fully qualified name of a custom transformation service

setFunction

public void setFunction(int fn)

Parameters:

fn - function to use (use constants)

setAttribute

public void setAttribute(BizDocAttribute att)

Parameters:

att - attribute to use

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

String representation for the class

getIData

public com.wm.data.IData getIData()

Specified by:

getIData in interface com.wm.util.coder.IDataCodable

Returns:

a IData representation of the class

setIData

public void setIData(com.wm.data.IData idata)

Specified by:

setIData in interface com.wm.util.coder.IDataCodable

Parameters:

idata - IData representation of the class

validatePartnerId

public static java.lang.String validatePartnerId(java.lang.String id)

validateAndSetSender

public static void validateAndSetSender(BizDocEnvelope env,
                                        java.lang.String id,
                                        java.lang.String origId)

validateAndSetSender

public static void validateAndSetSender(BizDocEnvelope env,
                                        java.lang.String id)

validateAndSetReceiver

public static void validateAndSetReceiver(BizDocEnvelope env,
                                          java.lang.String id,
                                          java.lang.String origId)

validateAndSetReceiver

public static void validateAndSetReceiver(BizDocEnvelope env,
                                          java.lang.String id)

convertEmptyStringsToNull

public static void convertEmptyStringsToNull(java.lang.String[] values)

For internal use only