com.aspc.remote.task.extdbsync

Class ExtDBSyncTableDef

java.lang.Object

com.aspc.remote.task.extdbsync.ExtDBSyncTableDef

public class ExtDBSyncTableDef
extends java.lang.Object

Updates an external database with changes made to stSoftware data in real time
THREAD MODE: NON-MUTABLE

Since:

23 September 2005

Author:

Jason McGrath

Constructor Summary

Constructors

Constructor and Description
ExtDBSyncTableDef(java.lang.String srcName, java.lang.String destName, DataBase database, java.lang.String mode, java.lang.String updateHandlerName, java.lang.String filter) constructor

Method Summary

Modifier and Type	Method and Description
void	addField(java.lang.String srcPath, java.lang.String destName, boolean isKey, boolean isString, java.lang.String dependentClasses) add a field
void	addField(java.lang.String srcPath, java.lang.String destName, boolean isKey, boolean isString, java.lang.String dependentClasses, java.lang.String dateFormat) add a field
void	addField(java.lang.String srcValue, java.lang.String srcPath, java.lang.String destName, boolean isKey, boolean isString, java.lang.String dependentClasses) add a field
void	addField(java.lang.String srcValue, java.lang.String srcPath, java.lang.String destName, boolean isKey, boolean isString, java.lang.String dependentClasses, java.lang.String dateFormat, ExtDBSyncFieldValidation... validations) add a field
DataBase	getDataBase() the destination database
java.lang.String	getDestName() the dest name
ExtDBSyncFieldDef	getFieldDef(java.lang.String srcFieldName) get the field def
java.lang.String[]	getFieldNames() list the fields
java.lang.String	getFilter() the filter
ExtDBSyncFieldDef	getKeyFieldDef() The field def
java.lang.String	getMode() the transaction mode
java.lang.String	getSrcName() the source name
java.lang.String	getUpdateHandlerName() Retrieves the name of the class that will be used to perform the updates

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtDBSyncTableDef

public ExtDBSyncTableDef(java.lang.String srcName,
                         java.lang.String destName,
                         DataBase database,
                         java.lang.String mode,
                         java.lang.String updateHandlerName,
                         java.lang.String filter)

constructor

Parameters:

filter - filter name

srcName - source name

destName - dest name

mode - the transaction mode

database - the destination database object

updateHandlerName - class name of class to perform updates

Method Detail

getKeyFieldDef

public ExtDBSyncFieldDef getKeyFieldDef()

The field def

Returns:

the def

getFieldDef

public ExtDBSyncFieldDef getFieldDef(java.lang.String srcFieldName)

get the field def

Parameters:

srcFieldName - the source field

Returns:

the def

getSrcName

public java.lang.String getSrcName()

the source name

Returns:

the name

getDestName

public java.lang.String getDestName()

the dest name

Returns:

the name

getDataBase

public DataBase getDataBase()

the destination database

Returns:

the name

getMode

public java.lang.String getMode()

the transaction mode

Returns:

the name

getFilter

public java.lang.String getFilter()

the filter

Returns:

the filter

addField

public void addField(java.lang.String srcPath,
                     java.lang.String destName,
                     boolean isKey,
                     boolean isString,
                     java.lang.String dependentClasses)

add a field

Parameters:

srcPath - the src path

destName - the dest name

isKey - a key

isString - a string

dependentClasses - classes that should be processed that contain data that this field value may refer to

addField

public void addField(java.lang.String srcValue,
                     java.lang.String srcPath,
                     java.lang.String destName,
                     boolean isKey,
                     boolean isString,
                     java.lang.String dependentClasses)

add a field

Parameters:

srcValue - the fixed src value

srcPath - the src path

destName - the dest name

isKey - a key

isString - a string

dependentClasses - classes that should be processed that contain data that this field value may refer to

addField

public void addField(java.lang.String srcPath,
                     java.lang.String destName,
                     boolean isKey,
                     boolean isString,
                     java.lang.String dependentClasses,
                     java.lang.String dateFormat)

add a field

Parameters:

srcPath - the src path

destName - the dest name

isKey - a key

isString - a string

dependentClasses - classes that should be processed that contain data that this field value may refer to

dateFormat - date format

addField

public void addField(java.lang.String srcValue,
                     java.lang.String srcPath,
                     java.lang.String destName,
                     boolean isKey,
                     boolean isString,
                     java.lang.String dependentClasses,
                     java.lang.String dateFormat,
                     ExtDBSyncFieldValidation... validations)

add a field

Parameters:

srcValue - the src value

srcPath - the src path

destName - the dest name

isKey - a key

isString - a string

dependentClasses - classes that should be processed that contain data that this field value may refer to

dateFormat - date format

validations - the list of validations

getFieldNames

public java.lang.String[] getFieldNames()

list the fields

Returns:

a list of fields

getUpdateHandlerName

public java.lang.String getUpdateHandlerName()

Retrieves the name of the class that will be used to perform the updates

Returns:

the name of the class