org.pentaho.di.trans.steps.singlethreader
Class SingleThreaderMeta

java.lang.Object
  extended by org.pentaho.di.trans.step.BaseStepMeta
      extended by org.pentaho.di.trans.steps.singlethreader.SingleThreaderMeta
All Implemented Interfaces:
Cloneable, HasRepositoryInterface, StepAttributesInterface, StepMetaInterface

public class SingleThreaderMeta
extends BaseStepMeta
implements StepMetaInterface, HasRepositoryInterface

Meta-data for the Mapping step: contains name of the (sub-)transformation to execute

Since:
22-nov-2005
Author:
Matt

Field Summary
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
SingleThreaderMeta()
           
 
Method Summary
 void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepinfo, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info)
          Checks the settings of this step and puts the findings in a remarks List.
 Object clone()
          Make an exact copy of this step, make sure to explicitly copy Collections etc.
 String exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository)
           
 String getBatchSize()
           
 String getBatchTime()
           
 String getDirectoryPath()
           
 void getFields(RowMetaInterface row, String origin, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Get the fields that are emitted by this step
 String getFileName()
           
 String getInjectStep()
           
 String[] getParameters()
           
 String[] getParameterValues()
           
 Repository getRepository()
           
 List<ResourceReference> getResourceDependencies(TransMeta transMeta, StepMeta stepInfo)
          Get a list of all the resource dependencies that the step is depending on.
 String getRetrieveStep()
           
 ObjectLocationSpecificationMethod getSpecificationMethod()
           
 StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, Trans trans)
          Get the executing step, needed by Trans to launch a step.
 StepDataInterface getStepData()
          Get a new instance of the appropriate data class.
 TransMeta.TransformationType[] getSupportedTransformationTypes()
           
 String getTransName()
           
 ObjectId getTransObjectId()
           
 String getXML()
          Produces the XML string that describes this step's information.
 boolean hasRepositoryReferences()
           
 boolean isPassingAllParameters()
           
static TransMeta loadSingleThreadedTransMeta(SingleThreaderMeta mappingMeta, Repository rep, VariableSpace space)
           
 void loadXML(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters)
          Load the values for this step from an XML Node
 void lookupRepositoryReferences(Repository repository)
          Look up the references after import
 void readRep(Repository rep, ObjectId id_step, List<DatabaseMeta> databases, Map<String,Counter> counters)
          Read the steps information from a Kettle repository
 void saveRep(Repository rep, ObjectId id_transformation, ObjectId id_step)
          Save the steps data into a Kettle repository
 void setBatchSize(String batchSize)
           
 void setBatchTime(String batchTime)
           
 void setDefault()
          Set default values
 void setDirectoryPath(String directoryPath)
           
 void setFileName(String fileName)
           
 void setInjectStep(String injectStep)
           
 void setParameters(String[] parameters)
           
 void setParameterValues(String[] parameterValues)
           
 void setPassingAllParameters(boolean passingAllParameters)
           
 void setRepository(Repository repository)
           
 void setRetrieveStep(String retrieveStep)
           
 void setSpecificationMethod(ObjectLocationSpecificationMethod specificationMethod)
           
 void setTransName(String transName)
           
 void setTransObjectId(ObjectId transObjectId)
           
 
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, findAttribute, findParent, getDescription, getDialogClassName, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepMetaInjectionInterface, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, isBasic, isDebug, isDetailed, isRowLevel, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, resetStepIoMeta, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta, supportsErrorHandling
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta, supportsErrorHandling
 

Constructor Detail

SingleThreaderMeta

public SingleThreaderMeta()
Method Detail

loadXML

public void loadXML(Node stepnode,
                    List<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleXMLException
Description copied from interface: StepMetaInterface
Load the values for this step from an XML Node

Specified by:
loadXML in interface StepMetaInterface
Parameters:
stepnode - the Node to get the info from
databases - The available list of databases to reference to
counters - Counters to reference.
Throws:
KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

clone

public Object clone()
Description copied from interface: StepMetaInterface
Make an exact copy of this step, make sure to explicitly copy Collections etc.

Specified by:
clone in interface StepMetaInterface
Overrides:
clone in class BaseStepMeta
Returns:
an exact copy of this step

getXML

public String getXML()
Description copied from class: BaseStepMeta
Produces the XML string that describes this step's information.

Specified by:
getXML in interface StepMetaInterface
Overrides:
getXML in class BaseStepMeta
Returns:
String containing the XML describing this step.

readRep

public void readRep(Repository rep,
                    ObjectId id_step,
                    List<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleException
Description copied from interface: StepMetaInterface
Read the steps information from a Kettle repository

Specified by:
readRep in interface StepMetaInterface
Parameters:
rep - The repository to read from
id_step - The step ID
databases - The databases to reference
counters - The counters to reference
Throws:
KettleException - When an unexpected error occurred (database, network, etc)

saveRep

public void saveRep(Repository rep,
                    ObjectId id_transformation,
                    ObjectId id_step)
             throws KettleException
Description copied from interface: StepMetaInterface
Save the steps data into a Kettle repository

Specified by:
saveRep in interface StepMetaInterface
Parameters:
rep - The Kettle repository to save to
id_transformation - The transformation ID
id_step - The step ID
Throws:
KettleException - When an unexpected error occurred (database, network, etc)

setDefault

public void setDefault()
Description copied from interface: StepMetaInterface
Set default values

Specified by:
setDefault in interface StepMetaInterface

getFields

public void getFields(RowMetaInterface row,
                      String origin,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)
               throws KettleStepException
Description copied from interface: StepMetaInterface
Get the fields that are emitted by this step

Specified by:
getFields in interface StepMetaInterface
Overrides:
getFields in class BaseStepMeta
Parameters:
row - The fields that are entering the step. These are changed to reflect the output metadata.
origin - The name of the step to be used as origin
info - The input rows metadata that enters the step through the specified channels in the same order as in method getInfoSteps(). The step metadata can then choose what to do with it: ignore it or not. Interesting is also that in case of database lookups, the layout of the target database table is put in info[0]
nextStep - if this is a non-null value, it's the next step in the transformation. The one who's asking, the step where the data is targetted towards.
space - TODO
Throws:
KettleStepException - when an error occurred searching for the fields.

loadSingleThreadedTransMeta

public static final TransMeta loadSingleThreadedTransMeta(SingleThreaderMeta mappingMeta,
                                                          Repository rep,
                                                          VariableSpace space)
                                                   throws KettleException
Throws:
KettleException

check

public void check(List<CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepinfo,
                  RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  RowMetaInterface info)
Description copied from interface: StepMetaInterface
Checks the settings of this step and puts the findings in a remarks List.

Specified by:
check in interface StepMetaInterface
Parameters:
remarks - The list to put the remarks in @see org.pentaho.di.core.CheckResult
stepinfo - The stepMeta to help checking
prev - The fields coming from the previous step
input - The input step names
output - The output step names
info - The fields that are used as information by the step

getStep

public StepInterface getStep(StepMeta stepMeta,
                             StepDataInterface stepDataInterface,
                             int cnr,
                             TransMeta tr,
                             Trans trans)
Description copied from interface: StepMetaInterface
Get the executing step, needed by Trans to launch a step.

Specified by:
getStep in interface StepMetaInterface
Parameters:
stepMeta - The step info
stepDataInterface - the step data interface linked to this step. Here the step can store temporary data, database connections, etc.
cnr - The copy nr to get
tr - The transformation info
trans - The launching transformation

getStepData

public StepDataInterface getStepData()
Description copied from interface: StepMetaInterface
Get a new instance of the appropriate data class. This data class implements the StepDataInterface. It basically contains the persisting data that needs to live on, even if a worker thread is terminated.

Specified by:
getStepData in interface StepMetaInterface
Returns:
The appropriate StepDataInterface class.

getDirectoryPath

public String getDirectoryPath()
Returns:
the directoryPath

setDirectoryPath

public void setDirectoryPath(String directoryPath)
Parameters:
directoryPath - the directoryPath to set

getFileName

public String getFileName()
Returns:
the fileName

setFileName

public void setFileName(String fileName)
Parameters:
fileName - the fileName to set

getTransName

public String getTransName()
Returns:
the transName

setTransName

public void setTransName(String transName)
Parameters:
transName - the transName to set

getResourceDependencies

public List<ResourceReference> getResourceDependencies(TransMeta transMeta,
                                                       StepMeta stepInfo)
Description copied from class: BaseStepMeta
Get a list of all the resource dependencies that the step is depending on.

Specified by:
getResourceDependencies in interface StepMetaInterface
Overrides:
getResourceDependencies in class BaseStepMeta
Returns:
a list of all the resource dependencies that the step is depending on

exportResources

public String exportResources(VariableSpace space,
                              Map<String,ResourceDefinition> definitions,
                              ResourceNamingInterface resourceNamingInterface,
                              Repository repository)
                       throws KettleException
Specified by:
exportResources in interface StepMetaInterface
Overrides:
exportResources in class BaseStepMeta
Parameters:
space - the variable space to use
repository - The repository to optionally load other resources from (to be converted to XML)
Returns:
the filename of the exported resource
Throws:
KettleException

getRepository

public Repository getRepository()
Specified by:
getRepository in interface HasRepositoryInterface
Returns:
the repository

setRepository

public void setRepository(Repository repository)
Specified by:
setRepository in interface HasRepositoryInterface
Parameters:
repository - the repository to set

getTransObjectId

public ObjectId getTransObjectId()
Returns:
the transObjectId

setTransObjectId

public void setTransObjectId(ObjectId transObjectId)
Parameters:
transObjectId - the transObjectId to set

getSpecificationMethod

public ObjectLocationSpecificationMethod getSpecificationMethod()
Returns:
the specificationMethod

setSpecificationMethod

public void setSpecificationMethod(ObjectLocationSpecificationMethod specificationMethod)
Parameters:
specificationMethod - the specificationMethod to set

getSupportedTransformationTypes

public TransMeta.TransformationType[] getSupportedTransformationTypes()
Specified by:
getSupportedTransformationTypes in interface StepMetaInterface
Overrides:
getSupportedTransformationTypes in class BaseStepMeta
Returns:
The supported transformation types that this step supports.

getBatchSize

public String getBatchSize()
Returns:
the batchSize

setBatchSize

public void setBatchSize(String batchSize)
Parameters:
batchSize - the batchSize to set

getInjectStep

public String getInjectStep()
Returns:
the injectStep

setInjectStep

public void setInjectStep(String injectStep)
Parameters:
injectStep - the injectStep to set

getRetrieveStep

public String getRetrieveStep()
Returns:
the retrieveStep

setRetrieveStep

public void setRetrieveStep(String retrieveStep)
Parameters:
retrieveStep - the retrieveStep to set

isPassingAllParameters

public boolean isPassingAllParameters()
Returns:
the passingAllParameters

setPassingAllParameters

public void setPassingAllParameters(boolean passingAllParameters)
Parameters:
passingAllParameters - the passingAllParameters to set

getParameters

public String[] getParameters()
Returns:
the parameters

setParameters

public void setParameters(String[] parameters)
Parameters:
parameters - the parameters to set

getParameterValues

public String[] getParameterValues()
Returns:
the parameterValues

setParameterValues

public void setParameterValues(String[] parameterValues)
Parameters:
parameterValues - the parameterValues to set

getBatchTime

public String getBatchTime()
Returns:
the batchTime

setBatchTime

public void setBatchTime(String batchTime)
Parameters:
batchTime - the batchTime to set

hasRepositoryReferences

public boolean hasRepositoryReferences()
Specified by:
hasRepositoryReferences in interface StepMetaInterface
Overrides:
hasRepositoryReferences in class BaseStepMeta
Returns:
True if the job entry defines one or more references to a repository object.

lookupRepositoryReferences

public void lookupRepositoryReferences(Repository repository)
                                throws KettleException
Description copied from class: BaseStepMeta
Look up the references after import

Specified by:
lookupRepositoryReferences in interface StepMetaInterface
Overrides:
lookupRepositoryReferences in class BaseStepMeta
Parameters:
repository - the repository to reference.
Throws:
KettleException