org.webdocwf.util.loader
Class Loader

java.lang.Object
  |
  +--org.webdocwf.util.loader.Loader

public class Loader
extends java.lang.Object

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 the key part for loading criteria. XML tags define how the loading job will be done.


Field Summary
static java.lang.String LOGMODE_FULL
           
static java.lang.String LOGMODE_NONE
           
static java.lang.String LOGMODE_NORMAL
           
 
Constructor Summary
Loader(java.lang.String loadJobFileName)
          Public constructor of Loader class.
Loader(java.lang.String loadJobFileName, java.lang.String mode, java.lang.String userID, java.lang.String logDirName, java.lang.String logFileName, boolean restartIndicator, java.util.Map variableValues, java.lang.String vendorFileName, boolean onErrorContinue, java.lang.String additionalPaths, int commitCount, int returnCode)
          Construct object Loader with an associated parameters.
 
Method Summary
 java.lang.String getAdditionalPaths()
          Read value of additionalPaths attribute.
 int getCommitCount()
          Read value of commitCount attribute.
 int getDefaultReturnCode()
          Read value of default error return code attribute.
 java.lang.String getLoadJobFileName()
          Read value of loadJobFileName attribute.
 java.lang.String getLogDirName()
          Read value of logDirName attribute
 java.lang.String getLogFileName()
          Read value of logFileName attribute.
 java.lang.String getMode()
          Read value of Mode(LogMode) attribute.
 boolean getOnErrorContinue()
          read value of onErrorContinue attribute.
 boolean getRestartIndicator()
          Read value of restartIndicator attribute.
 java.lang.String getUserID()
          Read value of userID attribute.
 java.util.Map getVariableValues()
          Read value of variableValues attribute.
 java.lang.String getVendorFileName()
          Read value of vendorFileName.
 void load()
          Method load is main method in class Loader.
static void main(java.lang.String[] argv)
          Main method Loader with an associated XML, restart mode (optional) i user (optional).
 void setAdditionalPaths(java.lang.String additionalPaths)
          This method sets value of additionalPaths attribute.
 void setCommitCount(int commitCount)
          This method sets value of commitCount attribute.
 void setDefaultReturnCode(int code)
          This method sets value of default error return code attribute.
 void setLoadJobFileName(java.lang.String loadJobFileName)
          This method sets value of loadJobFileName attribute.
 void setLogDirName(java.lang.String logDirName)
          This method sets value of logDirName attribute.
 void setLogFileName(java.lang.String logFileName)
          This method sets value of logFileName attribute.
 void setMode(java.lang.String mode)
          This method sets value of Mode attribute.
 void setOnErrorContinue(boolean onErrorContinue)
          This method sets value of onErrorContinue attribute.
 void setRestartIndicator(boolean restartIndicator)
          This method sets value of restartIndicator attribute.
 void setUserID(java.lang.String userID)
          This method sets value of userID attribute.
 void setVariableValues(java.util.Map variableValue)
          This method sets value of variableValues attribute.
 void setVendorFileName(java.lang.String vendorFileName)
          This method sets value of vendorFileName attribute.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOGMODE_NONE

public static final java.lang.String LOGMODE_NONE
See Also:
Constant Field Values

LOGMODE_NORMAL

public static final java.lang.String LOGMODE_NORMAL
See Also:
Constant Field Values

LOGMODE_FULL

public static final java.lang.String LOGMODE_FULL
See Also:
Constant Field Values
Constructor Detail

Loader

public Loader(java.lang.String loadJobFileName,
              java.lang.String mode,
              java.lang.String userID,
              java.lang.String logDirName,
              java.lang.String logFileName,
              boolean restartIndicator,
              java.util.Map variableValues,
              java.lang.String vendorFileName,
              boolean onErrorContinue,
              java.lang.String additionalPaths,
              int commitCount,
              int returnCode)
Construct object Loader with an associated parameters.


Loader

public Loader(java.lang.String loadJobFileName)
Public constructor of Loader class. Constructor set value for loadJobFileName attribute. Class set all other attributes to the default values.

Method Detail

getLoadJobFileName

public java.lang.String getLoadJobFileName()
Read value of loadJobFileName attribute.

Returns:
String value of loadFileName attribute

setLoadJobFileName

public void setLoadJobFileName(java.lang.String loadJobFileName)
This method sets value of loadJobFileName attribute.

Parameters:
loadJobFileName - loadJob XML file name

getMode

public java.lang.String getMode()
Read value of Mode(LogMode) attribute.

Returns:
value of attribute.

setMode

public void setMode(java.lang.String mode)
This method sets value of Mode attribute.


getUserID

public java.lang.String getUserID()
Read value of userID attribute.

Returns:
value of attribute.

setUserID

public void setUserID(java.lang.String userID)
This method sets value of userID attribute.


getLogDirName

public java.lang.String getLogDirName()
Read value of logDirName attribute

Returns:
value of attribute

setLogDirName

public void setLogDirName(java.lang.String logDirName)
This method sets value of logDirName attribute.

Parameters:
logDirName - value of attribute.

getLogFileName

public java.lang.String getLogFileName()
Read value of logFileName attribute.

Returns:
value of attribute.

setLogFileName

public void setLogFileName(java.lang.String logFileName)
This method sets value of logFileName attribute.

Parameters:
logFileName - value of attribute.

getRestartIndicator

public boolean getRestartIndicator()
Read value of restartIndicator attribute.

Returns:
value of attribute.

setRestartIndicator

public void setRestartIndicator(boolean restartIndicator)
This method sets value of restartIndicator attribute.

Parameters:
restartIndicator - value of attribute.

getVariableValues

public java.util.Map getVariableValues()
Read value of variableValues attribute.

Returns:
value of attribute.

setVariableValues

public void setVariableValues(java.util.Map variableValue)
This method sets value of variableValues attribute.


getVendorFileName

public java.lang.String getVendorFileName()
Read value of vendorFileName.

Returns:
value of attribute.

setVendorFileName

public void setVendorFileName(java.lang.String vendorFileName)
This method sets value of vendorFileName attribute.

Parameters:
vendorFileName - value of attribute.

getOnErrorContinue

public boolean getOnErrorContinue()
read value of onErrorContinue attribute.

Returns:
value of attribute.

setOnErrorContinue

public void setOnErrorContinue(boolean onErrorContinue)
This method sets value of onErrorContinue attribute.

Parameters:
onErrorContinue - value of attribute.

getAdditionalPaths

public java.lang.String getAdditionalPaths()
Read value of additionalPaths attribute.

Returns:
value of attribute.

setAdditionalPaths

public void setAdditionalPaths(java.lang.String additionalPaths)
This method sets value of additionalPaths attribute.

Parameters:
additionalPaths - value of attribute.

getCommitCount

public int getCommitCount()
Read value of commitCount attribute.

Returns:
value of attribute.

setCommitCount

public void setCommitCount(int commitCount)
This method sets value of commitCount attribute.

Parameters:
commitCount - value of attribute.

getDefaultReturnCode

public int getDefaultReturnCode()
Read value of default error return code attribute.

Returns:
value of attribute.

setDefaultReturnCode

public void setDefaultReturnCode(int code)
This method sets value of default error return code attribute.


main

public static void main(java.lang.String[] argv)
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'.


load

public void load()
          throws LoaderException
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.
LoaderException


Copyright © 2002-2003 Together - the Workgroup. All Rights Reserved.