org.pentaho.di.job.entries.folderscompare

Class JobEntryFoldersCompare

java.lang.Object

org.pentaho.di.job.entry.JobEntryBase

org.pentaho.di.job.entries.folderscompare.JobEntryFoldersCompare

All Implemented Interfaces:

Cloneable, AttributesInterface, CheckResultSourceInterface, ExtensionDataInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntryFoldersCompare
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines a 'folder compare' job entry. It will compare 2 folders, and will either follow the true flow upon the files being the same or the false flow otherwise.

Since:

25-11-2007

Author:

Samatar Hassan

Field Summary

Fields inherited from class org.pentaho.di.job.entry.JobEntryBase

attributesMap, containerObjectId, entryStepSetVariablesMap, extensionDataMap, log, metaStore, parentJob, parentJobMeta, rep, variables

Constructor Summary

Constructors

Constructor and Description
JobEntryFoldersCompare()
JobEntryFoldersCompare(String n)

Method Summary

Modifier and Type	Method and Description
void	check(List<CheckResultInterface> remarks, JobMeta jobMeta, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Allows JobEntry objects to check themselves for consistency
Object	clone() This method is called when a job entry is duplicated in Spoon.
protected boolean	equalFileContents(org.apache.commons.vfs2.FileObject file1, org.apache.commons.vfs2.FileObject file2) Check whether 2 files have the same contents.
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	getCompareOnly()
String	getFilename1()
String	getFilename2()
String	getRealFilename1()
String	getRealFilename2()
String	getRealWildcard()
String	getWildcard()
String	getXML() This method is called by PDI whenever a job entry needs to serialize its settings to XML.
boolean	isCompareFileContent()
boolean	isCompareFileSize()
boolean	isIncludeSubfolders()
void	loadRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, 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, org.pentaho.metastore.api.IMetaStore metaStore) This method is called by PDI whenever a job entry needs to read its settings from XML.
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_job) This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.
void	setCompareFileContent(boolean comparefilecontent)
void	setCompareFileSize(boolean comparefilesize)
void	setCompareOnly(String comparevalue)
void	setFilename1(String filename)
void	setFilename2(String filename)
void	setIncludeSubfolders(boolean includeSubfolders)
void	setWildcard(String wildcard)

Methods inherited from class org.pentaho.di.job.entry.JobEntryBase

check, clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, exportResources, fieldSubstitute, getAttribute, getAttributes, getAttributesMap, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getEntryStepSetVariable, getEntryStepSetVariablesMap, getExtensionDataMap, getFilename, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getMetaStore, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentJobMeta, getParentVariableSpace, getPluginId, getRealFilename, getReferencedObjectDescriptions, getRegistrationDate, getRepository, getRepositoryDirectory, getResourceDependencies, getSQLStatements, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, getVariables, hasChanged, hashCode, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isForcingSeparateLogging, isFTP, isGatheringMetrics, isHTTP, isJob, isMail, isReferencedObjectEnabled, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, isUnconditional, listVariables, loadReferencedObject, loadReferencedObject, loadRep, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, resetErrorsBeforeExecution, saveRep, setAttribute, setAttributes, setAttributesMap, setChanged, setChanged, setContainerObjectId, setDescription, setEntryStepSetVariable, setForcingSeparateLogging, setGatheringMetrics, setID, setLogLevel, setMetaStore, setName, setObjectId, setParentJob, setParentJobMeta, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface

check, clear, exportResources, exportResources, getDescription, getDialogClassName, getFilename, getLogChannel, getName, getObjectId, getParentJob, getParentJobMeta, getPluginId, getRealFilename, getReferencedObjectDescriptions, getResourceDependencies, getSQLStatements, getSQLStatements, getSQLStatements, getTypeId, getUsedDatabaseConnections, hasChanged, hasRepositoryReferences, isDummy, isEvaluation, isJob, isMail, isReferencedObjectEnabled, isShell, isSpecial, isStart, isTransformation, isUnconditional, loadReferencedObject, loadReferencedObject, loadRep, loadXML, lookupRepositoryReferences, resetErrorsBeforeExecution, saveRep, setChanged, setChanged, setDescription, setMetaStore, setName, setObjectId, setParentJob, setParentJobMeta, setPluginId, setRepository

Constructor Detail

JobEntryFoldersCompare

public JobEntryFoldersCompare(String n)

JobEntryFoldersCompare

public JobEntryFoldersCompare()

Method Detail

setCompareOnly

public void setCompareOnly(String comparevalue)

getCompareOnly

public String getCompareOnly()

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

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,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             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

Overrides:

loadXML in class JobEntryBase

Parameters:

entrynode - the top-level XML node

databases - the list of databases

slaveServers - the list of slave servers

rep - the repository object

metaStore - The metaStore to optionally load from.

Throws:

KettleXMLException - if any errors occur during the loading of the XML

loadRep

public void loadRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_jobentry,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws KettleException

Description copied from interface: JobEntryInterface

This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. The job entry id given in the arguments should be used as the identifier when using the repository's serialization methods.

Specified by:

loadRep in interface JobEntryInterface

Overrides:

loadRep in class JobEntryBase

Parameters:

rep - the repository object

metaStore - the MetaStore to use

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

saveRep

public void saveRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_job)
             throws KettleException

Description copied from interface: JobEntryInterface

This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. The repository object passed in as the first argument provides a convenient set of methods for serializing job entry settings. When calling repository serialization methods, job id and job entry id are required. The job id is passed in to saveRep() as an argument, and the job entry id can be obtained by a call to getObjectId() inherited from the base class.

Specified by:

saveRep in interface JobEntryInterface

Overrides:

saveRep in class JobEntryBase

Parameters:

rep - the repository

metaStore - the MetaStore to use

id_job - the id_job

Throws:

KettleException - if any errors occur during the save

setIncludeSubfolders

public void setIncludeSubfolders(boolean includeSubfolders)

isIncludeSubfolders

public boolean isIncludeSubfolders()

setCompareFileContent

public void setCompareFileContent(boolean comparefilecontent)

isCompareFileContent

public boolean isCompareFileContent()

setCompareFileSize

public void setCompareFileSize(boolean comparefilesize)

isCompareFileSize

public boolean isCompareFileSize()

getRealWildcard

public String getRealWildcard()

getRealFilename1

public String getRealFilename1()

getRealFilename2

public String getRealFilename2()

equalFileContents

protected boolean equalFileContents(org.apache.commons.vfs2.FileObject file1,
                                    org.apache.commons.vfs2.FileObject file2)
                             throws KettleFileException

Check whether 2 files have the same contents.

Parameters:

file1 - first file to compare

file2 - second file to compare

Returns:

true if files are equal, false if they are not

Throws:

IOException - upon IO problems

KettleFileException

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

setWildcard

public void setWildcard(String wildcard)

getWildcard

public String getWildcard()

setFilename1

public void setFilename1(String filename)

getFilename1

public String getFilename1()

setFilename2

public void setFilename2(String filename)

getFilename2

public String getFilename2()

check

public void check(List<CheckResultInterface> remarks,
                  JobMeta jobMeta,
                  VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)

Description copied from class: JobEntryBase

Allows JobEntry objects to check themselves for consistency

Specified by:

check in interface JobEntryInterface

Overrides:

check in class JobEntryBase

Parameters:

remarks - List of CheckResult objects indicating consistency status

jobMeta - the metadata object for the job entry

space - the variable space to resolve string expressions with variables with

repository - the repository to load Kettle objects from

metaStore - the MetaStore to load common elements from