| java.lang.Object
 org.webdocwf.util.loader.Loader
| Loader | | public class Loader (Code) | |
Loader class loads data from source database into target database using
criteria set in XML file which is used as parameter. Also Loader can execute
SQL statements which import from XML file.
All loading rolls are set in XML file. Some capabilities of this loader are:
there could be more then one importDefinition and number of them is not
limited, source and target database could be different, source database could
be ASCII,Excel or Access file too, operator (the person or application which
starts Loader) have to define. Restart mode with second parameter (optional).
There are two possible ways to start Loader. The first is as stand alone
application, the sintaxs is:
java org.webdocwf.util.loader.Loader [-options] urlOfTheXmlFile.xml
urlOfTheXmlFile.xml is URL of the XML file with loading criteria,
The second way is to start Loader as package, the sintax is:
public Loader(String loadJobFileName, String mode, String userID, String logDirName,
String logFileName, boolean restartIndicator, Map variableValues, String vendorFileName,
boolean onErrorContinue, String additionalPaths, int commitCount, int returnCode);
ldr.load();
If we want to execute Loader class without last for parameters, we must put
null as these arguments
When the Loader is started the log file is generated. Log file is txt file
and its name defines date and time when the Loader is started. There are
three Log modes: none - report only begining and finishing the application,
and exceptions if there are any, normal - add to log importing blocks and
full - with detailed report to operator.
Another big adventage of Loader is its possibility to execute any SQL
statements in target database. (creating database; creating, modifying and
deleting tables...)
XML file is the key part for loading criteria. XML tags define how the
loading job will be done.
author:
Milosevic Sinisa
author:
Radoslav Dutina
author:
Zoran Milakovic |
| Constructor Summary | |
| public | Loader(String loadJobFileName, String mode, String userID, String logDirName, String logFileName, boolean restartIndicator, Map variableValues, String vendorFileName, boolean onErrorContinue, String additionalPaths, int commitCount, int returnCode, String[] includeTables, String confJarStructure)
Construct object Loader with an associated parameters.
Parameters:
loadJobFileName - defines xml input file.
Parameters:
mode - defines the default logmode. | | public | Loader(String loadJobFileName, String mode, String userID, String logDirName, String logFileName, boolean restartIndicator, Map variableValues, String vendorFileName, boolean onErrorContinue, String additionalPaths, int commitCount, int returnCode)
Construct object Loader with an associated parameters.
Parameters:
loadJobFileName - defines xml input file.
Parameters:
mode - defines the default logmode. | | public | Loader(String loadJobFileName, String mode, String userID, String logDirName, String logFileName, boolean restartIndicator, Map variableValues, String vendorFileName, boolean onErrorContinue, String additionalPaths, int commitCount, int returnCode, String[] includeTables)
Construct object Loader with an associated parameters.
Parameters:
loadJobFileName - defines xml input file.
Parameters:
mode - defines the default logmode. | | public | Loader(String loadJobFileName, String mode, String userID, String logDirName, String logFileName, boolean restartIndicator, Map variableValues, String vendorFileName, boolean onErrorContinue, String additionalPaths, int commitCount, int returnCode, String confJarStructure)
Construct object Loader with an associated parameters.
Parameters:
loadJobFileName - defines xml input file.
Parameters:
mode - defines the default logmode. | | public | Loader(String loadJobFileName)
Public constructor of Loader class. | | public | Loader(String loadJobFileName, String confJarStructure)
Public constructor of Loader class. |
| Method Summary | |
| public String | getAdditionalPaths()
Read value of additionalPaths attribute. | | public int | getCommitCount()
Read value of commitCount attribute. | | public String | getConfJarStructure()
| | protected java.util.Date | getDateFromString(String date)
| | public String | getDefaultLogMode()
| | public int | getDefaultReturnCode()
Read value of default error return code attribute. | | public String[] | getIncludedJobs()
| | public String | getLoadJobFileName()
Read value of loadJobFileName attribute. | | public String | getLogDirName()
| | public String | getLogFileName()
Read value of logFileName attribute. | | public boolean | getOnErrorContinue()
read value of onErrorContinue attribute. | | public boolean | getRestartIndicator()
Read value of restartIndicator attribute. | | protected String | getSQLRelationString(ResultSet rs)
| | public String | getUserID()
Read value of userID attribute. | | public Map | getVariableValues()
Read value of variableValues attribute. | | public String | getVendorFileName()
Read value of vendorFileName. | | public String | inputToString()
| | public void | load()
Method load is main method in class Loader. | | public static void | main(String argv)
Main method Loader with an associated XML, restart mode (optional) i user
(optional). | | public void | parseInputData(Object readValueObject, Vector vecVektor, ResultSet rsetSource, int i, String columnName, int blobCount, boolean isMicrosoftDriver, Hashtable columnValuesMicrosoft, Hashtable sourceColumnTypes)
| | static void | printUsage()
| | public void | setAdditionalPaths(String additionalPaths)
This method sets value of additionalPaths attribute. | | Vector | setAfter(Vector vecOrder, int iIndexCurrent, int iIndexTarget)
Method setAfter changes order of vecOrder's elements. | | public void | setCommitCount(int commitCount)
This method sets value of commitCount attribute. | | public void | setDefaultReturnCode(int code)
This method sets value of default error return code attribute. | | public void | setIncludedJobs(String include_Tables)
| | public void | setLoadJobFileName(String loadJobFileName)
This method sets value of loadJobFileName attribute. | | public void | setLogDirName(String logDirName)
This method sets value of logDirName attribute. | | public void | setLogFileName(String logFileName)
This method sets value of logFileName attribute. | | public void | setOnErrorContinue(boolean onErrorContinue)
This method sets value of onErrorContinue attribute. | | public void | setRestartIndicator(boolean restartIndicator)
This method sets value of restartIndicator attribute. | | public void | setUserID(String userID)
This method sets value of userID attribute. | | protected void | setValueOnStatement(String value, int javaTypeInt, int i, PreparedStatement pstmt)
| | public void | setVariableValues(Map variableValue)
This method sets value of variableValues attribute. | | public void | setVendorFileName(String vendorFileName)
This method sets value of vendorFileName attribute. |
| ImportDefinitionSourceColumnName | | Vector ImportDefinitionSourceColumnName(Code) | | |
| ImportDefinitionTargetColumnName | | Vector ImportDefinitionTargetColumnName(Code) | | |
| LOGMODE_NORMAL | | final public static String LOGMODE_NORMAL(Code) | | |
| bOnErrorContinue | | boolean bOnErrorContinue(Code) | | |
| bReplaceInData | | boolean bReplaceInData(Code) | | |
| bRestartIndicator | | boolean bRestartIndicator(Code) | | |
| hasRestartCounter | | boolean hasRestartCounter(Code) | | |
| hasUserID | | boolean hasUserID(Code) | | |
| iColumnsInSourceTable | | int iColumnsInSourceTable(Code) | | |
| iConstantColumns | | int iConstantColumns(Code) | | |
| iFirstColumnResult | | int iFirstColumnResult(Code) | | |
| iRelationColumns | | int iRelationColumns(Code) | | |
| iTargetFirstColumnResult | | int iTargetFirstColumnResult(Code) | | |
| iValueColumns | | int iValueColumns(Code) | | |
| isDefaultJdbc | | boolean isDefaultJdbc(Code) | | |
| mapVariableValues | | Map mapVariableValues(Code) | | |
| updateTransformationStatement | | Hashtable updateTransformationStatement(Code) | | |
| userIDExists | | boolean userIDExists(Code) | | |
| vecConstantColumnTargetTableID | | Vector vecConstantColumnTargetTableID(Code) | | |
| vecConstantColumnTargetTableName | | Vector vecConstantColumnTargetTableName(Code) | | |
| vecConstantConstantValue | | Vector vecConstantConstantValue(Code) | | |
| vecConstantTargetColumnName | | Vector vecConstantTargetColumnName(Code) | | |
| vecDefaultRelationValue | | Vector vecDefaultRelationValue(Code) | | |
| vecDefaultVariableValue | | Vector vecDefaultVariableValue(Code) | | |
| vecRelationColumnRelationMode | | Vector vecRelationColumnRelationMode(Code) | | |
| vecRelationColumnSourceColumnName | | Vector vecRelationColumnSourceColumnName(Code) | | |
| vecRelationColumnSourceTableID | | Vector vecRelationColumnSourceTableID(Code) | | |
| vecRelationColumnSourceTableName | | Vector vecRelationColumnSourceTableName(Code) | | |
| vecRelationColumnTargetColumnName | | Vector vecRelationColumnTargetColumnName(Code) | | |
| vecRelationColumnTargetTableID | | Vector vecRelationColumnTargetTableID(Code) | | |
| vecRelationColumnTargetTableName | | Vector vecRelationColumnTargetTableName(Code) | | |
| vecValueColumnsTargetTables | | Vector vecValueColumnsTargetTables(Code) | | |
| vecVariableColumnTargetColumnName | | Vector vecVariableColumnTargetColumnName(Code) | | |
| vecVariableColumnTargetTableID | | Vector vecVariableColumnTargetTableID(Code) | | |
| vecVariableColumnTargetTableName | | Vector vecVariableColumnTargetTableName(Code) | | |
| vecVariableColumnValueMode | | Vector vecVariableColumnValueMode(Code) | | |
| vecVariableTimesColumnName | | Vector vecVariableTimesColumnName(Code) | | |
| vecVariableTimesTableID | | Vector vecVariableTimesTableID(Code) | | |
| vecVariableTimesTableName | | Vector vecVariableTimesTableName(Code) | | |
| vecVariableTimesValueMode | | Vector vecVariableTimesValueMode(Code) | | |
| vecVariableUseIDColumnName | | Vector vecVariableUseIDColumnName(Code) | | |
| vecVariableUseIDTableID | | Vector vecVariableUseIDTableID(Code) | | |
| vecVariableUseIDTableName | | Vector vecVariableUseIDTableName(Code) | | |
| vecVariableUseIDValueMode | | Vector vecVariableUseIDValueMode(Code) | | |
| Loader | | public Loader(String loadJobFileName, String mode, String userID, String logDirName, String logFileName, boolean restartIndicator, Map variableValues, String vendorFileName, boolean onErrorContinue, String additionalPaths, int commitCount, int returnCode, String[] includeTables, String confJarStructure)(Code) | | Construct object Loader with an associated parameters.
Parameters:
loadJobFileName - defines xml input file.
Parameters:
mode - defines the default logmode. Possible values are "none","normal" (is the default) and "full". Is "normal" otherwise -mnone
Parameters:
userID - String which is name of user. This argument is used forwriting userID into variable columns. If it is 'null' there isno define userID columns.
Parameters:
logDirName - defines the logfile directory. The default is the currentworking directory.
Parameters:
logFileName - defines the logfile name. The default is"LoaderLog-YYYY-MM-DD-HH-mm-SS.txt".
Parameters:
restartIndicator - which is true if "restart" mode and false if "new" mode.
Parameters:
variableValues - Map defines variables used in variable columns.
Parameters:
vendorFileName - the filename of the XML DB-vendor configuration file. Thedefault is "OctopusDBVendors.xml".
Parameters:
onErrorContinue - defines to set the default of "onErrorContinue" to "true". Isfalse otherwise.
Parameters:
additionalPaths - Extend the classpath with additional paths.
Parameters:
commitCount - Sets the default commit count. System default is "100".
Parameters:
returnCode - Sets the default error return code. System default is "1".
Parameters:
includeTables - defines tables which will be processed |
| Loader | | public Loader(String loadJobFileName, String mode, String userID, String logDirName, String logFileName, boolean restartIndicator, Map variableValues, String vendorFileName, boolean onErrorContinue, String additionalPaths, int commitCount, int returnCode)(Code) | | Construct object Loader with an associated parameters.
Parameters:
loadJobFileName - defines xml input file.
Parameters:
mode - defines the default logmode. Possible values are "none","normal" (is the default) and "full". Is "normal" otherwise -mnone
Parameters:
userID - String which is name of user. This argument is used forwriting userID into variable columns. If it is 'null' there isno define userID columns.
Parameters:
logDirName - defines the logfile directory. The default is the currentworking directory.
Parameters:
logFileName - defines the logfile name. The default is"LoaderLog-YYYY-MM-DD-HH-mm-SS.txt".
Parameters:
restartIndicator - which is true if "restart" mode and false if "new" mode.
Parameters:
variableValues - Map defines variables used in variable columns.
Parameters:
vendorFileName - the filename of the XML DB-vendor configuration file. Thedefault is "OctopusDBVendors.xml".
Parameters:
onErrorContinue - defines to set the default of "onErrorContinue" to "true". Isfalse otherwise.
Parameters:
additionalPaths - Extend the classpath with additional paths.
Parameters:
commitCount - Sets the default commit count. System default is "100".
Parameters:
returnCode - Sets the default error return code. System default is "1". |
| Loader | | public Loader(String loadJobFileName, String mode, String userID, String logDirName, String logFileName, boolean restartIndicator, Map variableValues, String vendorFileName, boolean onErrorContinue, String additionalPaths, int commitCount, int returnCode, String[] includeTables)(Code) | | Construct object Loader with an associated parameters.
Parameters:
loadJobFileName - defines xml input file.
Parameters:
mode - defines the default logmode. Possible values are "none","normal" (is the default) and "full". Is "normal" otherwise -mnone
Parameters:
userID - String which is name of user. This argument is used forwriting userID into variable columns. If it is 'null' there isno define userID columns.
Parameters:
logDirName - defines the logfile directory. The default is the currentworking directory.
Parameters:
logFileName - defines the logfile name. The default is"LoaderLog-YYYY-MM-DD-HH-mm-SS.txt".
Parameters:
restartIndicator - which is true if "restart" mode and false if "new" mode.
Parameters:
variableValues - Map defines variables used in variable columns.
Parameters:
vendorFileName - the filename of the XML DB-vendor configuration file. Thedefault is "OctopusDBVendors.xml".
Parameters:
onErrorContinue - defines to set the default of "onErrorContinue" to "true". Isfalse otherwise.
Parameters:
additionalPaths - Extend the classpath with additional paths.
Parameters:
commitCount - Sets the default commit count. System default is "100".
Parameters:
returnCode - Sets the default error return code. System default is "1". |
| Loader | | public Loader(String loadJobFileName, String mode, String userID, String logDirName, String logFileName, boolean restartIndicator, Map variableValues, String vendorFileName, boolean onErrorContinue, String additionalPaths, int commitCount, int returnCode, String confJarStructure)(Code) | | Construct object Loader with an associated parameters.
Parameters:
loadJobFileName - defines xml input file.
Parameters:
mode - defines the default logmode. Possible values are "none","normal" (is the default) and "full". Is "normal" otherwise -mnone
Parameters:
userID - String which is name of user. This argument is used forwriting userID into variable columns. If it is 'null' there isno define userID columns.
Parameters:
logDirName - defines the logfile directory. The default is the currentworking directory.
Parameters:
logFileName - defines the logfile name. The default is"LoaderLog-YYYY-MM-DD-HH-mm-SS.txt".
Parameters:
restartIndicator - which is true if "restart" mode and false if "new" mode.
Parameters:
variableValues - Map defines variables used in variable columns.
Parameters:
vendorFileName - the filename of the XML DB-vendor configuration file. Thedefault is "OctopusDBVendors.xml".
Parameters:
onErrorContinue - defines to set the default of "onErrorContinue" to "true". Isfalse otherwise.
Parameters:
additionalPaths - Extend the classpath with additional paths.
Parameters:
commitCount - Sets the default commit count. System default is "100".
Parameters:
returnCode - Sets the default error return code. System default is "1". |
| Loader | | public Loader(String loadJobFileName)(Code) | | Public constructor of Loader class. Constructor set value for
loadJobFileName attribute. Class set all other attributes to the default
values.
Parameters:
loadJobFileName - Name of loadJob import XML file. |
| Loader | | public Loader(String loadJobFileName, String confJarStructure)(Code) | | Public constructor of Loader class. Constructor set value for
loadJobFileName attribute. Class set all other attributes to the default
values.
Parameters:
loadJobFileName - Name of loadJob import XML file. |
| getAdditionalPaths | | public String getAdditionalPaths()(Code) | | Read value of additionalPaths attribute.
value of attribute. |
| getCommitCount | | public int getCommitCount()(Code) | | Read value of commitCount attribute.
value of attribute. |
| getConfJarStructure | | public String getConfJarStructure()(Code) | | This method read value of confJarStructure parameter
value of parameter |
| getDefaultLogMode | | public String getDefaultLogMode()(Code) | | This method read value of defaultLogMode parameter
value of parameter |
| getDefaultReturnCode | | public int getDefaultReturnCode()(Code) | | Read value of default error return code attribute.
value of attribute. |
| getIncludedJobs | | public String[] getIncludedJobs()(Code) | | This method read value of includeJobs parameter
value of parameter |
| getLoadJobFileName | | public String getLoadJobFileName()(Code) | | Read value of loadJobFileName attribute.
String value of loadFileName attribute |
| getLogDirName | | public String getLogDirName()(Code) | | Read value of logDirName attribute
value of attribute |
| getLogFileName | | public String getLogFileName()(Code) | | Read value of logFileName attribute.
value of attribute. |
| getOnErrorContinue | | public boolean getOnErrorContinue()(Code) | | read value of onErrorContinue attribute.
value of attribute. |
| getRestartIndicator | | public boolean getRestartIndicator()(Code) | | Read value of restartIndicator attribute.
value of attribute. |
| getUserID | | public String getUserID()(Code) | | Read value of userID attribute.
value of attribute. |
| getVariableValues | | public Map getVariableValues()(Code) | | Read value of variableValues attribute.
value of attribute. |
| getVendorFileName | | public String getVendorFileName()(Code) | | Read value of vendorFileName.
value of attribute. |
| load | | public void load() throws LoaderException(Code) | | Method load is main method in class Loader. It is used to load data from
the source table into target tables and(or) execute SQL statements.
Loading parameters are set in XML file. During loading, load status is
printed on the screen and also put into log file. If there is an error
Exception "LoaderException" is thrown.
throws:
LoaderException - |
| main | | public static void main(String argv)(Code) | | Main method Loader with an associated XML, restart mode (optional) i user
(optional). Main method controls parameters, it they are OK starts load
method, but if they aren't makes alert. Usage: java
org.webdocwf.util.loader.Loader [options] loadJob_xml_filename");
Options: -m defines the default logmode. Possible values are 'none',
'normal' (is the default) and 'full'. -r starts the Loader in restart
mode after abnormal termination in a prior execution. -u defines the
current UserID used in UserID value columns. -v defines variables used in
variable columns. -l defines the logfile directory. The default is the
current working directory. -f defines the logfile name. The default is
'LoaderLog-YYYY-MM-DD-HH-mm-SS.txt'. -d the filename of the XML DB-vendor
configuration file. The default is 'OctopusDBVendors.xml'. -e defines to
set the default of 'onErrorContinue' to 'true'. Is false otherwise. -p
Extend the classpath with additional paths. -c Sets the default commit
count. System default is '100'. -rc Sets the default error return code.
System default is '1'. -it Sets the table names which will be proccesed
Parameters:
argv - represents input parmeters |
| parseInputData | | public void parseInputData(Object readValueObject, Vector vecVektor, ResultSet rsetSource, int i, String columnName, int blobCount, boolean isMicrosoftDriver, Hashtable columnValuesMicrosoft, Hashtable sourceColumnTypes) throws LoaderException(Code) | | This method read data from source table
Parameters:
readValue - is data value which is reed
Parameters:
vecVektor - defines vector
Parameters:
rsetSource - defines ResultSet object
Parameters:
i - is interger
Parameters:
columnName - defines source column name
Parameters:
blobCount - defines counter for blob object
Parameters:
isMicrosoftDriver - defines if we use microsoft driver
Parameters:
columnValuesMicrosoft - defines column values which is read with microsoft driver |
| printUsage | | static void printUsage()(Code) | | put your documentation comment here
|
| setAdditionalPaths | | public void setAdditionalPaths(String additionalPaths)(Code) | | This method sets value of additionalPaths attribute.
Parameters:
additionalPaths - value of attribute. |
| setAfter | | Vector setAfter(Vector vecOrder, int iIndexCurrent, int iIndexTarget)(Code) | | Method setAfter changes order of vecOrder's elements. Element at
iIndexCurrent position will be removed and inserted after element at
iIndexTarget position.
Parameters:
vecOrder - Vector - order of relation tags
Parameters:
iIndexCurrent - integer - position of element in Vector which changes itsposition.
Parameters:
iIndexTarget - integer - position of 'target' element in Vector . Vector - order of relation tags after changing element'spositions. |
| setCommitCount | | public void setCommitCount(int commitCount)(Code) | | This method sets value of commitCount attribute.
Parameters:
commitCount - value of attribute. |
| setDefaultReturnCode | | public void setDefaultReturnCode(int code)(Code) | | This method sets value of default error return code attribute.
Parameters:
code - is value of attribute. |
| setIncludedJobs | | public void setIncludedJobs(String include_Tables)(Code) | | This method set value of includeJobs parameter
Parameters:
include_Tables - is value of parameter |
| setLoadJobFileName | | public void setLoadJobFileName(String loadJobFileName)(Code) | | This method sets value of loadJobFileName attribute.
Parameters:
loadJobFileName - loadJob XML file name |
| setLogDirName | | public void setLogDirName(String logDirName)(Code) | | This method sets value of logDirName attribute.
Parameters:
logDirName - value of attribute. |
| setLogFileName | | public void setLogFileName(String logFileName)(Code) | | This method sets value of logFileName attribute.
Parameters:
logFileName - value of attribute. |
| setOnErrorContinue | | public void setOnErrorContinue(boolean onErrorContinue)(Code) | | This method sets value of onErrorContinue attribute.
Parameters:
onErrorContinue - value of attribute. |
| setRestartIndicator | | public void setRestartIndicator(boolean restartIndicator)(Code) | | This method sets value of restartIndicator attribute.
Parameters:
restartIndicator - value of attribute. |
| setUserID | | public void setUserID(String userID)(Code) | | This method sets value of userID attribute.
Parameters:
userID - attribute. |
| setVariableValues | | public void setVariableValues(Map variableValue)(Code) | | This method sets value of variableValues attribute.
Parameters:
variableValue - value of attribute. |
| setVendorFileName | | public void setVendorFileName(String vendorFileName)(Code) | | This method sets value of vendorFileName attribute.
Parameters:
vendorFileName - value of attribute. |
|
|