org.pentaho.di.job.entries.exportrepository

Class JobEntryExportRepository

java.lang.Object

org.pentaho.di.job.entry.JobEntryBase

org.pentaho.di.job.entries.exportrepository.JobEntryExportRepository

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 JobEntryExportRepository
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines a 'Export repository' job entry. Its main use would be export repository objects to a XML file that can be used to control the flow in ETL cycles.

Since:

04-06-2008

Author:

Samatar

Field Summary

Fields

Modifier and Type	Field and Description
String	Export_All
String	Export_By_Folder
String	Export_Jobs
String	Export_One_Folder
String	Export_Trans
String	If_FileExists_Fail
String	If_FileExists_Overwrite
String	If_FileExists_Skip
String	If_FileExists_Uniquename
String	SUCCESS_IF_ERRORS_LESS
String	SUCCESS_IF_NO_ERRORS

Constructor Summary

Constructors

Constructor and Description
JobEntryExportRepository()
JobEntryExportRepository(String n)

Method Summary

Methods

Modifier and Type	Method and Description
String	buildFilename(String filename)
String	buildUniqueFilename(String filename)
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.
String	getDateTimeFormat()
String	getDirectory()
String	getExportType()
String	getIfFileExists()
String	getNrLimit()
String	getPassword()
String	getRepositoryname()
String	getSuccessCondition()
String	getTargetfilename()
String	getUsername()
String	getXML() This method is called by PDI whenever a job entry needs to serialize its settings to XML.
boolean	isAddDate()
boolean	isAddresultfilesname()
boolean	isAddTime()
boolean	isCreateFolder()
boolean	isNewFolder()
boolean	isSpecifyFormat()
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.
static void	main(String[] args)
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	setAddDate(boolean adddate)
void	setAddresultfilesname(boolean add_result_filesnamein)
void	setAddTime(boolean addtime)
void	setCreateFolder(boolean createfolder)
void	setDateTimeFormat(String date_time_format)
void	setDirectory(String directoryPath)
void	setExportType(String export_type)
void	setIfFileExists(String iffileexists)
void	setNewFolder(boolean newfolder)
void	setNrLimit(String nr_errors_less_than)
void	setPassword(String password)
void	setRepositoryname(String repositoryname)
void	setSpecifyFormat(boolean SpecifyFormat)
void	setSuccessCondition(String success_condition)
void	setTargetfilename(String targetfilename)
void	setUsername(String username)

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, getResourceDependencies, getSQLStatements, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, hasChanged, 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, 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, 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, setPluginId, setRepository

Field Detail

If_FileExists_Skip

public String If_FileExists_Skip

If_FileExists_Fail

public String If_FileExists_Fail

If_FileExists_Overwrite

public String If_FileExists_Overwrite

If_FileExists_Uniquename

public String If_FileExists_Uniquename

Export_All

public String Export_All

Export_Jobs

public String Export_Jobs

Export_Trans

public String Export_Trans

Export_By_Folder

public String Export_By_Folder

Export_One_Folder

public String Export_One_Folder

SUCCESS_IF_ERRORS_LESS

public String SUCCESS_IF_ERRORS_LESS

SUCCESS_IF_NO_ERRORS

public String SUCCESS_IF_NO_ERRORS

Constructor Detail

JobEntryExportRepository

public JobEntryExportRepository(String n)

JobEntryExportRepository

public JobEntryExportRepository()

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

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<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

setSuccessCondition

public void setSuccessCondition(String success_condition)

getSuccessCondition

public String getSuccessCondition()

setRepositoryname

public void setRepositoryname(String repositoryname)

getRepositoryname

public String getRepositoryname()

setUsername

public void setUsername(String username)

getUsername

public String getUsername()

setExportType

public void setExportType(String export_type)

getExportType

public String getExportType()

setIfFileExists

public void setIfFileExists(String iffileexists)

getIfFileExists

public String getIfFileExists()

setTargetfilename

public void setTargetfilename(String targetfilename)

getTargetfilename

public String getTargetfilename()

getPassword

public String getPassword()

Returns:

Returns the password.

setPassword

public void setPassword(String password)

Parameters:

password - The password to set.

getDirectory

public String getDirectory()

getDateTimeFormat

public String getDateTimeFormat()

setDateTimeFormat

public void setDateTimeFormat(String date_time_format)

isSpecifyFormat

public boolean isSpecifyFormat()

setSpecifyFormat

public void setSpecifyFormat(boolean SpecifyFormat)

setAddTime

public void setAddTime(boolean addtime)

isAddTime

public boolean isAddTime()

isCreateFolder

public boolean isCreateFolder()

setCreateFolder

public void setCreateFolder(boolean createfolder)

setNewFolder

public void setNewFolder(boolean newfolder)

isNewFolder

public boolean isNewFolder()

setDirectory

public void setDirectory(String directoryPath)

setAddDate

public void setAddDate(boolean adddate)

isAddDate

public boolean isAddDate()

setAddresultfilesname

public void setAddresultfilesname(boolean add_result_filesnamein)

isAddresultfilesname

public boolean isAddresultfilesname()

setNrLimit

public void setNrLimit(String nr_errors_less_than)

getNrLimit

public String getNrLimit()

buildFilename

public String buildFilename(String filename)

buildUniqueFilename

public String buildUniqueFilename(String filename)

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

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<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

main

public static void main(String[] args)