|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pentaho.di.trans.step.BaseStepMeta
org.pentaho.di.trans.steps.systemdata.SystemDataMeta
public class SystemDataMeta
Constructor Summary | |
---|---|
SystemDataMeta()
|
Method Summary | |
---|---|
void |
allocate(int count)
|
void |
check(List<org.pentaho.di.core.CheckResultInterface> remarks,
TransMeta transMeta,
StepMeta stepMeta,
org.pentaho.di.core.row.RowMetaInterface prev,
String[] input,
String[] output,
org.pentaho.di.core.row.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[] |
getFieldName()
|
void |
getFields(org.pentaho.di.core.row.RowMetaInterface row,
String name,
org.pentaho.di.core.row.RowMetaInterface[] info,
StepMeta nextStep,
org.pentaho.di.core.variables.VariableSpace space)
Get the fields that are emitted by this step |
int[] |
getFieldType()
|
StepInterface |
getStep(StepMeta stepMeta,
StepDataInterface stepDataInterface,
int cnr,
TransMeta transMeta,
Trans trans)
Get the executing step, needed by Trans to launch a step. |
StepDataInterface |
getStepData()
Get a new instance of the appropriate data class. |
static int |
getType(String type)
|
static String |
getTypeDesc(int t)
|
Map<String,String> |
getUsedArguments()
Default a step doesn't use any arguments. |
String |
getXML()
Produces the XML string that describes this step's information. |
void |
loadXML(Node stepnode,
List<org.pentaho.di.core.database.DatabaseMeta> databases,
Map<String,org.pentaho.di.core.Counter> counters)
Load the values for this step from an XML Node |
void |
readRep(Repository rep,
long id_step,
List<org.pentaho.di.core.database.DatabaseMeta> databases,
Map<String,org.pentaho.di.core.Counter> counters)
Read the steps information from a Kettle repository |
void |
saveRep(Repository rep,
long id_transformation,
long id_step)
Save the steps data into a Kettle repository |
void |
setDefault()
Set default values |
void |
setFieldName(String[] fieldName)
|
void |
setFieldType(int[] fieldType)
|
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta |
---|
analyseImpact, cancelQueries, chosesTargetSteps, excludeFromRowLayoutVerification, exportResources, getDialogClassName, getID, getInfoSteps, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getTableFields, getTargetSteps, getUsedDatabaseConnections, getUsedLibraries, hasChanged, searchInfoAndTargetSteps, setChanged, setChanged, setID, setInfoSteps, setTargetSteps, 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, excludeFromRowLayoutVerification, exportResources, getDialogClassName, getInfoSteps, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getTableFields, getTargetSteps, getUsedDatabaseConnections, getUsedLibraries, searchInfoAndTargetSteps, setInfoSteps, setTargetSteps, supportsErrorHandling |
Field Detail |
---|
public static final int TYPE_SYSTEM_INFO_NONE
public static final int TYPE_SYSTEM_INFO_SYSTEM_DATE
public static final int TYPE_SYSTEM_INFO_SYSTEM_START
public static final int TYPE_SYSTEM_INFO_TRANS_DATE_FROM
public static final int TYPE_SYSTEM_INFO_TRANS_DATE_TO
public static final int TYPE_SYSTEM_INFO_JOB_DATE_FROM
public static final int TYPE_SYSTEM_INFO_JOB_DATE_TO
public static final int TYPE_SYSTEM_INFO_PREV_DAY_START
public static final int TYPE_SYSTEM_INFO_PREV_DAY_END
public static final int TYPE_SYSTEM_INFO_THIS_DAY_START
public static final int TYPE_SYSTEM_INFO_THIS_DAY_END
public static final int TYPE_SYSTEM_INFO_NEXT_DAY_START
public static final int TYPE_SYSTEM_INFO_NEXT_DAY_END
public static final int TYPE_SYSTEM_INFO_PREV_MONTH_START
public static final int TYPE_SYSTEM_INFO_PREV_MONTH_END
public static final int TYPE_SYSTEM_INFO_THIS_MONTH_START
public static final int TYPE_SYSTEM_INFO_THIS_MONTH_END
public static final int TYPE_SYSTEM_INFO_NEXT_MONTH_START
public static final int TYPE_SYSTEM_INFO_NEXT_MONTH_END
public static final int TYPE_SYSTEM_INFO_COPYNR
public static final int TYPE_SYSTEM_INFO_TRANS_NAME
public static final int TYPE_SYSTEM_INFO_FILENAME
public static final int TYPE_SYSTEM_INFO_MODIFIED_USER
public static final int TYPE_SYSTEM_INFO_MODIFIED_DATE
public static final int TYPE_SYSTEM_INFO_TRANS_BATCH_ID
public static final int TYPE_SYSTEM_INFO_JOB_BATCH_ID
public static final int TYPE_SYSTEM_INFO_HOSTNAME
public static final int TYPE_SYSTEM_INFO_IP_ADDRESS
public static final int TYPE_SYSTEM_INFO_ARGUMENT_01
public static final int TYPE_SYSTEM_INFO_ARGUMENT_02
public static final int TYPE_SYSTEM_INFO_ARGUMENT_03
public static final int TYPE_SYSTEM_INFO_ARGUMENT_04
public static final int TYPE_SYSTEM_INFO_ARGUMENT_05
public static final int TYPE_SYSTEM_INFO_ARGUMENT_06
public static final int TYPE_SYSTEM_INFO_ARGUMENT_07
public static final int TYPE_SYSTEM_INFO_ARGUMENT_08
public static final int TYPE_SYSTEM_INFO_ARGUMENT_09
public static final int TYPE_SYSTEM_INFO_ARGUMENT_10
public static final int TYPE_SYSTEM_INFO_KETTLE_VERSION
public static final int TYPE_SYSTEM_INFO_KETTLE_BUILD_VERSION
public static final int TYPE_SYSTEM_INFO_KETTLE_BUILD_DATE
public static final int TYPE_SYSTEM_INFO_CURRENT_PID
public static final SystemDataMetaFunction[] functions
Constructor Detail |
---|
public SystemDataMeta()
Method Detail |
---|
public String[] getFieldName()
public void setFieldName(String[] fieldName)
fieldName
- The fieldName to set.public int[] getFieldType()
public void setFieldType(int[] fieldType)
fieldType
- The fieldType to set.public void loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, Map<String,org.pentaho.di.core.Counter> counters) throws org.pentaho.di.core.exception.KettleXMLException
StepMetaInterface
loadXML
in interface StepMetaInterface
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tocounters
- Counters to reference.
org.pentaho.di.core.exception.KettleXMLException
- When an unexpected XML error occurred. (malformed etc.)public void allocate(int count)
public Object clone()
StepMetaInterface
clone
in interface StepMetaInterface
clone
in class BaseStepMeta
public static final int getType(String type)
public static final String getTypeDesc(int t)
public void setDefault()
StepMetaInterface
setDefault
in interface StepMetaInterface
public void getFields(org.pentaho.di.core.row.RowMetaInterface row, 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
StepMetaInterface
getFields
in interface StepMetaInterface
getFields
in class BaseStepMeta
row
- The fields that are entering the step. These are changed to reflect the output metadata.name
- The name of the step to be used as origininfo
- 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
org.pentaho.di.core.exception.KettleStepException
- when an error occurred searching for the fields.public String getXML()
BaseStepMeta
getXML
in interface StepMetaInterface
getXML
in class BaseStepMeta
public void readRep(Repository rep, long id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases, Map<String,org.pentaho.di.core.Counter> counters) throws org.pentaho.di.core.exception.KettleException
StepMetaInterface
readRep
in interface StepMetaInterface
rep
- The repository to read fromid_step
- The step IDdatabases
- The databases to referencecounters
- The counters to reference
org.pentaho.di.core.exception.KettleException
- When an unexpected error occurred (database, network, etc)public void saveRep(Repository rep, long id_transformation, long id_step) throws org.pentaho.di.core.exception.KettleException
StepMetaInterface
saveRep
in interface StepMetaInterface
rep
- The Kettle repository to save toid_transformation
- The transformation IDid_step
- The step ID
org.pentaho.di.core.exception.KettleException
- When an unexpected error occurred (database, network, etc)public void check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info)
StepMetaInterface
check
in interface StepMetaInterface
remarks
- The list to put the remarks in @see org.pentaho.di.core.CheckResultstepMeta
- The stepMeta to help checkingprev
- The fields coming from the previous stepinput
- The input step namesoutput
- The output step namesinfo
- The fields that are used as information by the steppublic Map<String,String> getUsedArguments()
getUsedArguments
in interface StepMetaInterface
getUsedArguments
in class BaseStepMeta
public StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans)
StepMetaInterface
getStep
in interface StepMetaInterface
stepMeta
- The step infostepDataInterface
- the step data interface linked to this step. Here the step can store temporary data, database connections, etc.cnr
- The copy nr to gettransMeta
- The transformation infotrans
- The launching transformationpublic StepDataInterface getStepData()
StepMetaInterface
getStepData
in interface StepMetaInterface
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |