|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pentaho.di.trans.step.BaseStepMeta
public class BaseStepMeta
Constructor Summary | |
---|---|
BaseStepMeta()
|
Method Summary | |
---|---|
void |
analyseImpact(List<DatabaseImpact> impact,
TransMeta transMeta,
StepMeta stepMeta,
org.pentaho.di.core.row.RowMetaInterface prev,
String[] input,
String[] output,
org.pentaho.di.core.row.RowMetaInterface info)
Each step must be able to report on the impact it has on a database, table field, etc. |
void |
cancelQueries()
Call this to cancel trailing database queries (too long running, etc) |
boolean |
chosesTargetSteps()
|
Object |
clone()
|
boolean |
excludeFromRowLayoutVerification()
This method is added to exclude certain steps from layout checking. |
String |
exportResources(org.pentaho.di.core.variables.VariableSpace space,
Map<String,ResourceDefinition> definitions,
ResourceNamingInterface resourceNamingInterface,
Repository repository)
|
String |
getDialogClassName()
This returns the expected name for the dialog that edits a job entry. |
void |
getFields(org.pentaho.di.core.row.RowMetaInterface inputRowMeta,
String name,
org.pentaho.di.core.row.RowMetaInterface[] info,
StepMeta nextStep,
org.pentaho.di.core.variables.VariableSpace space)
|
long |
getID()
|
String[] |
getInfoSteps()
|
org.pentaho.di.core.row.RowMetaInterface |
getRequiredFields()
Deprecated. |
org.pentaho.di.core.row.RowMetaInterface |
getRequiredFields(org.pentaho.di.core.variables.VariableSpace space)
The natural way of data flow in a transformation is source-to-target. |
List<ResourceReference> |
getResourceDependencies(TransMeta transMeta,
StepMeta stepInfo)
Get a list of all the resource dependencies that the step is depending on. |
org.pentaho.di.core.SQLStatement |
getSQLStatements(TransMeta transMeta,
StepMeta stepMeta,
org.pentaho.di.core.row.RowMetaInterface prev)
Standard method to return one or more SQLStatement objects that the step needs in order to work correctly. |
org.pentaho.di.core.row.RowMetaInterface |
getTableFields()
|
String[] |
getTargetSteps()
|
Map<String,String> |
getUsedArguments()
Default a step doesn't use any arguments. |
org.pentaho.di.core.database.DatabaseMeta[] |
getUsedDatabaseConnections()
This method returns all the database connections that are used by the step. |
String[] |
getUsedLibraries()
|
String |
getXML()
Produces the XML string that describes this step's information. |
boolean |
hasChanged()
|
void |
searchInfoAndTargetSteps(List<StepMeta> steps)
|
void |
setChanged()
|
void |
setChanged(boolean ch)
|
void |
setID(long id)
|
void |
setInfoSteps(StepMeta[] infoSteps)
|
void |
setTargetSteps(StepMeta[] targetSteps)
|
boolean |
supportsErrorHandling()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BaseStepMeta()
Method Detail |
---|
public long getID()
public void setID(long id)
public Object clone()
clone
in class Object
public void setChanged(boolean ch)
public void setChanged()
public boolean hasChanged()
public org.pentaho.di.core.row.RowMetaInterface getTableFields()
public void searchInfoAndTargetSteps(List<StepMeta> steps)
steps
- optionally search the info step in a list of stepspublic boolean chosesTargetSteps()
public String[] getTargetSteps()
public String[] getInfoSteps()
public void setInfoSteps(StepMeta[] infoSteps)
infoSteps
- The info step(s) to setpublic void setTargetSteps(StepMeta[] targetSteps)
targetSteps
- The target step(s) to setpublic String getXML() throws org.pentaho.di.core.exception.KettleException
org.pentaho.di.core.exception.KettleValueException
- in case there is an XML conversion or encoding error
org.pentaho.di.core.exception.KettleException
public void getFields(org.pentaho.di.core.row.RowMetaInterface inputRowMeta, String name, org.pentaho.di.core.row.RowMetaInterface[] info, StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space) throws org.pentaho.di.core.exception.KettleStepException
org.pentaho.di.core.exception.KettleStepException
public void analyseImpact(List<DatabaseImpact> impact, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info) throws org.pentaho.di.core.exception.KettleStepException
impact
- The list of impacts @see org.pentaho.di.transMeta.DatabaseImpacttransMeta
- The transformation informationstepMeta
- The step informationprev
- The fields entering this stepinput
- The previous step namesoutput
- The output step namesinfo
- The fields used as information by this step
org.pentaho.di.core.exception.KettleStepException
public org.pentaho.di.core.SQLStatement getSQLStatements(TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev) throws org.pentaho.di.core.exception.KettleStepException
transMeta
- TransInfo object containing the complete transformationstepMeta
- StepMeta object containing the complete stepprev
- Row containing meta-data for the input fields (no data)
org.pentaho.di.core.exception.KettleStepException
public void cancelQueries() throws org.pentaho.di.core.exception.KettleDatabaseException
org.pentaho.di.core.exception.KettleDatabaseException
public Map<String,String> getUsedArguments()
public org.pentaho.di.core.row.RowMetaInterface getRequiredFields() throws org.pentaho.di.core.exception.KettleException
org.pentaho.di.core.exception.KettleException
- in case the required fields can't be determinedpublic org.pentaho.di.core.row.RowMetaInterface getRequiredFields(org.pentaho.di.core.variables.VariableSpace space) throws org.pentaho.di.core.exception.KettleException
space
- the variable space to use to do variable substitution.
org.pentaho.di.core.exception.KettleException
- in case the required fields can't be determinedpublic org.pentaho.di.core.database.DatabaseMeta[] getUsedDatabaseConnections()
public String[] getUsedLibraries()
public boolean supportsErrorHandling()
public boolean excludeFromRowLayoutVerification()
public List<ResourceReference> getResourceDependencies(TransMeta transMeta, StepMeta stepInfo)
public String exportResources(org.pentaho.di.core.variables.VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository) throws org.pentaho.di.core.exception.KettleException
org.pentaho.di.core.exception.KettleException
public String getDialogClassName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |