org.pentaho.di.job.entries.xslt
Class JobEntryXSLT

java.lang.Object
  org.pentaho.di.job.entry.JobEntryBase
      org.pentaho.di.job.entries.xslt.JobEntryXSLT

All Implemented Interfaces:

Cloneable, CheckResultSourceInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntryXSLT
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines a 'xslt' job entry.

Since:

02-03-2007

Author:

Samatar Hassan

Field Summary

static String	FACTORY_JAXP
static String	FACTORY_SAXON
int	iffileexists

Constructor Summary

JobEntryXSLT()

JobEntryXSLT(String n)

Method Summary

void	allocate(int nrParameters, int outputProps)
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	getoutputfilename()
String	getoutputFilename()
String[]	getOutputPropertyName()
String[]	getOutputPropertyValue()
String[]	getParameterField()
String[]	getParameterName()
String	getRealxmlfilename()
String	getRealxslfilename()
List<ResourceReference>	getResourceDependencies(JobMeta jobMeta) Gets a list of all the resource dependencies that the step is depending on.
String	getXML() This method is called by PDI whenever a job entry needs to serialize its settings to XML.
String	getxmlFilename()
String	getxslFilename()
String	getXSLTFactory()
boolean	isAddFileToResult()
boolean	isFilenamesFromPrevious()
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	setAddFileToResult(boolean addfiletoresultin)
void	setFilenamesFromPrevious(boolean filenamesfromprevious)
void	setoutputFilename(String outputfilename)
void	setOutputPropertyName(String[] argumentDirection)
void	setOutputPropertyValue(String[] argumentDirection)
void	setParameterName(String[] argumentDirection)
void	setxmlFilename(String filename)
void	setxslFilename(String filename)
void	setXSLTFactory(String xsltfactoryin)

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

FACTORY_JAXP

public static String FACTORY_JAXP

FACTORY_SAXON

public static String FACTORY_SAXON

iffileexists

public int iffileexists

Constructor Detail

JobEntryXSLT

public JobEntryXSLT(String n)

JobEntryXSLT

public JobEntryXSLT()

Method Detail

allocate

public void allocate(int nrParameters,
                     int outputProps)

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

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

getXSLTFactory

public String getXSLTFactory()

setXSLTFactory

public void setXSLTFactory(String xsltfactoryin)

getRealxmlfilename

public String getRealxmlfilename()

getoutputfilename

public String getoutputfilename()

isFilenamesFromPrevious

public boolean isFilenamesFromPrevious()

setFilenamesFromPrevious

public void setFilenamesFromPrevious(boolean filenamesfromprevious)

getRealxslfilename

public String getRealxslfilename()

execute

public Result execute(Result previousResult,
                      int nr)
               throws KettleException

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

Throws:

KettleException - if any Kettle exceptions occur

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

setxmlFilename

public void setxmlFilename(String filename)

getxmlFilename

public String getxmlFilename()

getoutputFilename

public String getoutputFilename()

setoutputFilename

public void setoutputFilename(String outputfilename)

setxslFilename

public void setxslFilename(String filename)

getxslFilename

public String getxslFilename()

setAddFileToResult

public void setAddFileToResult(boolean addfiletoresultin)

isAddFileToResult

public boolean isAddFileToResult()

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

getOutputPropertyName

public String[] getOutputPropertyName()

Returns:

Returns the OutputPropertyName.

setOutputPropertyName

public void setOutputPropertyName(String[] argumentDirection)

Parameters:

argumentDirection - The OutputPropertyName to set.

getOutputPropertyValue

public String[] getOutputPropertyValue()

Returns:

Returns the OutputPropertyField.

setOutputPropertyValue

public void setOutputPropertyValue(String[] argumentDirection)

Parameters:

argumentDirection - The outputPropertyValue to set.

getParameterName

public String[] getParameterName()

Returns:

Returns the parameterName.

setParameterName

public void setParameterName(String[] argumentDirection)

Parameters:

argumentDirection - The parameterName to set.

getParameterField

public String[] getParameterField()

Returns:

Returns the parameterField.