org.pentaho.di.job.entries.evaluatetablecontent

Class JobEntryEvalTableContent

java.lang.Object

org.pentaho.di.job.entry.JobEntryBase

org.pentaho.di.job.entries.evaluatetablecontent.JobEntryEvalTableContent

All Implemented Interfaces:

Cloneable, org.pentaho.di.core.AttributesInterface, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.ExtensionDataInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntryEvalTableContent
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines a Table content evaluation job entry

Since:

22-07-2008

Author:

Samatar

Field Summary

Fields

Modifier and Type	Field and Description
static int	SUCCESS_CONDITION_ROWS_COUNT_DIFFERENT
static int	SUCCESS_CONDITION_ROWS_COUNT_EQUAL
static int	SUCCESS_CONDITION_ROWS_COUNT_GREATER
static int	SUCCESS_CONDITION_ROWS_COUNT_GREATER_EQUAL
static int	SUCCESS_CONDITION_ROWS_COUNT_SMALLER
static int	SUCCESS_CONDITION_ROWS_COUNT_SMALLER_EQUAL
static String[]	successConditionsCode
static String[]	successConditionsDesc

Constructor Summary

Constructors

Constructor and Description
JobEntryEvalTableContent()
JobEntryEvalTableContent(String n)

Method Summary

Modifier and Type	Method and Description
void	check(List<org.pentaho.di.core.CheckResultInterface> remarks, JobMeta jobMeta, org.pentaho.di.core.variables.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.
boolean	evaluates() This method must return true if the job entry supports the true/false outgoing hops.
org.pentaho.di.core.Result	execute(org.pentaho.di.core.Result previousResult, int nr) Execute the job entry.
org.pentaho.di.core.database.DatabaseMeta	getConnection()
String	getCustomSQL()
org.pentaho.di.core.database.DatabaseMeta	getDatabase()
String	getLimit()
List<ResourceReference>	getResourceDependencies(JobMeta jobMeta) Gets a list of all the resource dependencies that the step is depending on.
String	getSchemaname()
int	getSuccessCobdition() Deprecated. due to typo. Use getSuccessCondition() instead.
int	getSuccessCondition()
static int	getSuccessConditionByDesc(String tt)
static String	getSuccessConditionDesc(int i)
String	getTablename()
org.pentaho.di.core.database.DatabaseMeta[]	getUsedDatabaseConnections() Gets all the database connections that are used by the job entry.
String	getXML() This method is called by PDI whenever a job entry needs to serialize its settings to XML.
boolean	isAddRowsResult()
boolean	isClearResultList()
boolean	isUnconditional() This method must return true if the job entry supports the unconditional outgoing hop.
boolean	isUseCustomSQL()
boolean	isUseVars()
void	loadRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_jobentry, List<org.pentaho.di.core.database.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<org.pentaho.di.core.database.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, org.pentaho.di.repository.ObjectId id_job) This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.
void	setAddRowsResult(boolean addRowsResult)
void	setClearResultList(boolean clearResultList)
void	setConnection(org.pentaho.di.core.database.DatabaseMeta connection)
void	setCustomSQL(String customSQL)
void	setDatabase(org.pentaho.di.core.database.DatabaseMeta database)
void	setLimit(String limit)
void	setSchemaname(String schemaname)
void	setSuccessCondition(int successCondition)
void	setTablename(String tablename)
void	setUseCustomSQL(boolean useCustomSQL)
void	setUseVars(boolean useVars)

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, getExtensionDataMap, getFilename, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getMetaStore, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentVariableSpace, getPluginId, getRealFilename, getReferencedObjectDescriptions, getRegistrationDate, getRepository, getRepositoryDirectory, getSQLStatements, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getVariable, getVariable, hasChanged, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isForcingSeparateLogging, isFTP, isGatheringMetrics, isHTTP, isJob, isMail, isReferencedObjectEnabled, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, 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, setForcingSeparateLogging, setGatheringMetrics, setID, setLogLevel, setMetaStore, 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

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

Field Detail

successConditionsDesc

public static final String[] successConditionsDesc

successConditionsCode

public static final String[] successConditionsCode

SUCCESS_CONDITION_ROWS_COUNT_EQUAL

public static final int SUCCESS_CONDITION_ROWS_COUNT_EQUAL

See Also:

Constant Field Values

SUCCESS_CONDITION_ROWS_COUNT_DIFFERENT

public static final int SUCCESS_CONDITION_ROWS_COUNT_DIFFERENT

See Also:

Constant Field Values

SUCCESS_CONDITION_ROWS_COUNT_SMALLER

public static final int SUCCESS_CONDITION_ROWS_COUNT_SMALLER

See Also:

Constant Field Values

SUCCESS_CONDITION_ROWS_COUNT_SMALLER_EQUAL

public static final int SUCCESS_CONDITION_ROWS_COUNT_SMALLER_EQUAL

See Also:

Constant Field Values

SUCCESS_CONDITION_ROWS_COUNT_GREATER

public static final int SUCCESS_CONDITION_ROWS_COUNT_GREATER

See Also:

Constant Field Values

SUCCESS_CONDITION_ROWS_COUNT_GREATER_EQUAL

public static final int SUCCESS_CONDITION_ROWS_COUNT_GREATER_EQUAL

See Also:

Constant Field Values

Constructor Detail

JobEntryEvalTableContent

public JobEntryEvalTableContent(String n)

JobEntryEvalTableContent

public JobEntryEvalTableContent()

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

getSuccessCobdition

@Deprecated
public int getSuccessCobdition()

Deprecated. due to typo. Use getSuccessCondition() instead.

Returns:

the successCondition

getSuccessCondition

public int getSuccessCondition()

Returns:

the successCondition

getSuccessConditionByDesc

public static int getSuccessConditionByDesc(String tt)

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

getSuccessConditionDesc

public static String getSuccessConditionDesc(int i)

loadXML

public void loadXML(Node entrynode,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.KettleXMLException - if any errors occur during the loading of the XML

loadRep

public void loadRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_jobentry,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.KettleException - if any errors occur during the load

saveRep

public void saveRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_job)
             throws org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.KettleException - if any errors occur during the save

setDatabase

public void setDatabase(org.pentaho.di.core.database.DatabaseMeta database)

getDatabase

public org.pentaho.di.core.database.DatabaseMeta getDatabase()

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

isUnconditional

public boolean isUnconditional()

Description copied from class: JobEntryBase

This method must return true if the job entry supports the unconditional outgoing hop. For JobEntryBase, this method always returns true

Specified by:

isUnconditional in interface JobEntryInterface

Overrides:

isUnconditional in class JobEntryBase

Returns:

true

execute

public org.pentaho.di.core.Result execute(org.pentaho.di.core.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

getUsedDatabaseConnections

public org.pentaho.di.core.database.DatabaseMeta[] getUsedDatabaseConnections()

Description copied from class: JobEntryBase

Gets all the database connections that are used by the job entry. For JobEntryBase, this method returns an empty (non-null) array

Specified by:

getUsedDatabaseConnections in interface JobEntryInterface

Overrides:

getUsedDatabaseConnections in class JobEntryBase

Returns:

an empty (non-null) array

getResourceDependencies

public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)

Description copied from class: JobEntryBase

Gets a list of all the resource dependencies that the step is depending on. In JobEntryBase, this method returns an empty resource dependency list.

Specified by:

getResourceDependencies in interface JobEntryInterface

Overrides:

getResourceDependencies in class JobEntryBase

Returns:

an empty list of ResourceReferences

See Also:

ResourceReference

check

public void check(List<org.pentaho.di.core.CheckResultInterface> remarks,
                  JobMeta jobMeta,
                  org.pentaho.di.core.variables.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

isAddRowsResult

public boolean isAddRowsResult()

setAddRowsResult

public void setAddRowsResult(boolean addRowsResult)

isClearResultList

public boolean isClearResultList()

setClearResultList

public void setClearResultList(boolean clearResultList)

isUseVars

public boolean isUseVars()

setUseVars

public void setUseVars(boolean useVars)

isUseCustomSQL

public boolean isUseCustomSQL()

setUseCustomSQL

public void setUseCustomSQL(boolean useCustomSQL)

getCustomSQL

public String getCustomSQL()

setCustomSQL

public void setCustomSQL(String customSQL)

getConnection

public org.pentaho.di.core.database.DatabaseMeta getConnection()

setConnection

public void setConnection(org.pentaho.di.core.database.DatabaseMeta connection)

getTablename

public String getTablename()

setTablename

public void setTablename(String tablename)

getSchemaname

public String getSchemaname()

setSchemaname

public void setSchemaname(String schemaname)

getLimit

public String getLimit()

setLimit

public void setLimit(String limit)

setSuccessCondition

public void setSuccessCondition(int successCondition)