org.pentaho.di.job.entries.msaccessbulkload
Class JobEntryMSAccessBulkLoad

java.lang.Object
  extended by org.pentaho.di.job.entry.JobEntryBase
      extended by org.pentaho.di.job.entries.msaccessbulkload.JobEntryMSAccessBulkLoad
All Implemented Interfaces:
Cloneable, CheckResultSourceInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntryMSAccessBulkLoad
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines a 'MS Access Bulk Load' job entry. It will compare to load data from files into Microsoft Access files

Since:
24-07-2008
Author:
Samatar Hassan

Field Summary
 String[] delimiter
           
 String[] source_filefolder
           
 String[] source_wildcard
           
 String SUCCESS_IF_AT_LEAST
           
 String SUCCESS_IF_ERRORS_LESS
           
 String SUCCESS_IF_NO_ERRORS
           
 String[] target_Db
           
 String[] target_table
           
 
Constructor Summary
JobEntryMSAccessBulkLoad()
           
JobEntryMSAccessBulkLoad(String n)
           
 
Method Summary
 void check(List<CheckResultInterface> remarks, JobMeta jobMeta)
          Support for overrides not having to put in a check method.
 Object clone()
          This method is called when a job entry is duplicated in Spoon.
 boolean evaluates()
          This method must return true if the job entry supports the true/false outgoing hops.
 Result execute(Result previousResult, int nr)
          Execute the job entry.
 String getLimit()
           
 String getSuccessCondition()
           
 String getXML()
          This method is called by PDI whenever a job entry needs to serialize its settings to XML.
 boolean isAddResultFilename()
           
 boolean isArgsFromPrevious()
           
 boolean isIncludeSubFoders()
           
 void loadRep(Repository rep, ObjectId id_jobentry, List<DatabaseMeta> databases, List<SlaveServer> slaveServers)
          This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository.
 void loadXML(Node entrynode, List<DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep)
          This method is called by PDI whenever a job entry needs to read its settings from XML.
 void saveRep(Repository rep, ObjectId id_job)
          This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.
 void setAddResultFilenames(boolean addtoresultfilenames)
           
 void setArgsFromPrevious(boolean isargsfromprevious)
           
 void setIncludeSubFoders(boolean includeSubfolders)
           
 void setLimit(String limit)
           
 void setSuccessCondition(String success_condition)
           
 
Methods inherited from class org.pentaho.di.job.entry.JobEntryBase
clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getFilename, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentVariableSpace, getPluginId, getRealFilename, getRegistrationDate, getRepository, getRepositoryDirectory, getResourceDependencies, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, hasChanged, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isFTP, isHTTP, isJob, isMail, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, isUnconditional, listVariables, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, resetErrorsBeforeExecution, setChanged, setChanged, setContainerObjectId, setDescription, setID, setLogLevel, setName, setObjectId, setParentJob, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface
clear, exportResources, getDescription, getDialogClassName, getFilename, getLogChannel, getName, getObjectId, getParentJob, getPluginId, getRealFilename, getResourceDependencies, getSQLStatements, getSQLStatements, getTypeId, getUsedDatabaseConnections, hasChanged, hasRepositoryReferences, isDummy, isEvaluation, isJob, isMail, isShell, isSpecial, isStart, isTransformation, isUnconditional, lookupRepositoryReferences, resetErrorsBeforeExecution, setChanged, setChanged, setDescription, setName, setObjectId, setParentJob, setPluginId, setRepository
 

Field Detail

source_filefolder

public String[] source_filefolder

source_wildcard

public String[] source_wildcard

delimiter

public String[] delimiter

target_Db

public String[] target_Db

target_table

public String[] target_table

SUCCESS_IF_AT_LEAST

public String SUCCESS_IF_AT_LEAST

SUCCESS_IF_ERRORS_LESS

public String SUCCESS_IF_ERRORS_LESS

SUCCESS_IF_NO_ERRORS

public String SUCCESS_IF_NO_ERRORS
Constructor Detail

JobEntryMSAccessBulkLoad

public JobEntryMSAccessBulkLoad(String n)

JobEntryMSAccessBulkLoad

public JobEntryMSAccessBulkLoad()
Method Detail

clone

public Object clone()
Description copied from class: JobEntryBase
This method is called when a job entry is duplicated in Spoon. It needs to return a deep copy of this job entry object. It is essential that the implementing class creates proper deep copies if the job entry configuration is stored in modifiable objects, such as lists or custom helper objects.

Specified by:
clone in interface JobEntryInterface
Overrides:
clone in class JobEntryBase
Returns:
a clone of the object

setAddResultFilenames

public void setAddResultFilenames(boolean addtoresultfilenames)

isAddResultFilename

public boolean isAddResultFilename()

setIncludeSubFoders

public void setIncludeSubFoders(boolean includeSubfolders)

isIncludeSubFoders

public boolean isIncludeSubFoders()

setArgsFromPrevious

public void setArgsFromPrevious(boolean isargsfromprevious)

isArgsFromPrevious

public boolean isArgsFromPrevious()

getXML

public String getXML()
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to serialize its settings to XML. It is called when saving a job in Spoon. The method returns an XML string, containing the serialized settings. The string contains a series of XML tags, typically one tag per setting. The helper class org.pentaho.di.core.xml.XMLHandler is typically used to construct the XML string.

Specified by:
getXML in interface JobEntryInterface
Overrides:
getXML in class JobEntryBase
Returns:
the xml representation of the job entry

loadXML

public void loadXML(Node entrynode,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep)
             throws KettleXMLException
Description copied from interface: JobEntryInterface
This method is called by PDI whenever a job entry needs to read its settings from XML. The XML node containing the job entry�s settings is passed in as an argument. Again, the helper class org.pentaho.di.core.xml.XMLHandler is typically used to conveniently read the settings from the XML node.

Specified by:
loadXML in interface JobEntryInterface
Parameters:
entrynode - the top-level XML node
databases - the list of databases
slaveServers - the list of slave servers
rep - the repository object
Throws:
KettleXMLException - if any errors occur during the loading of the XML

loadRep

public void loadRep(Repository rep,
                    ObjectId id_jobentry,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws KettleException
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. For JobEntryBase, this method performs no operations.

Specified by:
loadRep in interface JobEntryInterface
Overrides:
loadRep in class JobEntryBase
Parameters:
rep - the repository object
id_jobentry - the id of the job entry
databases - the list of databases
slaveServers - the list of slave servers
Throws:
KettleException - if any errors occur during the load

setLimit

public void setLimit(String limit)

getLimit

public String getLimit()

setSuccessCondition

public void setSuccessCondition(String success_condition)

getSuccessCondition

public String getSuccessCondition()

saveRep

public void saveRep(Repository rep,
                    ObjectId id_job)
             throws KettleException
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. For JobEntryBase, this method performs no operations

Specified by:
saveRep in interface JobEntryInterface
Overrides:
saveRep in class JobEntryBase
Parameters:
rep - the repository object
id_job - the id_job
Throws:
KettleException - if any errors occur during the save

execute

public Result execute(Result previousResult,
                      int nr)
Description copied from interface: JobEntryInterface
Execute the job entry. The previous result and number of rows are provided to the method for the purpose of chaining job entries, transformations, etc.

Specified by:
execute in interface JobEntryInterface
Parameters:
previousResult - the previous result
nr - the number of rows
Returns:
the Result object from execution of this job entry

evaluates

public boolean evaluates()
Description copied from class: JobEntryBase
This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false

Specified by:
evaluates in interface JobEntryInterface
Overrides:
evaluates in class JobEntryBase
Returns:
false

check

public void check(List<CheckResultInterface> remarks,
                  JobMeta jobMeta)
Description copied from class: JobEntryBase
Support for overrides not having to put in a check method. For JobEntryBase, this method performs no operations.

Specified by:
check in interface JobEntryInterface
Overrides:
check in class JobEntryBase
Parameters:
remarks - CheckResults from checking the job entry
jobMeta - JobMeta information letting threading back to the JobMeta possible