org.pentaho.di.trans.steps.userdefinedjavaclass
Class UserDefinedJavaClassMeta

java.lang.Object
  org.pentaho.di.trans.step.BaseStepMeta
      org.pentaho.di.trans.steps.userdefinedjavaclass.UserDefinedJavaClassMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class UserDefinedJavaClassMeta
extends BaseStepMeta
implements StepMetaInterface

Nested Class Summary

static class	UserDefinedJavaClassMeta.ElementNames
static class	UserDefinedJavaClassMeta.FieldInfo

Field Summary

Class<TransformClassBase>	cookedTransformClass
List<Exception>	cookErrors

Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

UserDefinedJavaClassMeta()

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.
void	cookClasses()
boolean	excludeFromRowLayoutVerification() This method is added to exclude certain steps from layout checking.
List<UserDefinedJavaClassDef>	getDefinitions()
List<UserDefinedJavaClassMeta.FieldInfo>	getFieldInfo()
void	getFields(RowMetaInterface row, String originStepname, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) Gets the fields.
List<StepDefinition>	getInfoStepDefinitions()
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.
StepIOMetaInterface	getStepIOMeta() Returns the Input/Output metadata for this step.
List<StepDefinition>	getTargetStepDefinitions()
List<UsageParameter>	getUsageParameters()
String	getXML() Produces the XML string that describes this step's information.
boolean	isClearingResultFields()
void	loadXML(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters) Load the values for this step from an XML Node
TransformClassBase	newChildInstance(UserDefinedJavaClass parent, UserDefinedJavaClassMeta meta, UserDefinedJavaClassData data)
void	readRep(Repository rep, ObjectId id_step, List<DatabaseMeta> databases, Map<String,Counter> counters) Read the steps information from a Kettle repository
void	replaceDefinitions(List<UserDefinedJavaClassDef> definitions)
void	replaceFields(List<UserDefinedJavaClassMeta.FieldInfo> fields)
void	saveRep(Repository rep, ObjectId id_transformation, ObjectId id_step) Save the steps data into a Kettle repository
void	searchInfoAndTargetSteps(List<StepMeta> steps) Change step names into step objects to allow them to be name-changed etc.
void	setClearingResultFields(boolean clearingResultFields)
void	setDefault() Set default values
void	setInfoStepDefinitions(List<StepDefinition> infoStepDefinitions)
void	setTargetStepDefinitions(List<StepDefinition> targetStepDefinitions)
void	setUsageParameters(List<UsageParameter> usageParameters)
boolean	supportsErrorHandling()

Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta

analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, exportResources, findAttribute, findParent, getDescription, getDialogClassName, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getStepInjectionMetadataEntries, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isRowLevel, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, resetStepIoMeta, setChanged, setChanged, setParentStepMeta

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, exportResources, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, setParentStepMeta

Field Detail

cookedTransformClass

public Class<TransformClassBase> cookedTransformClass

cookErrors

public List<Exception> cookErrors

Constructor Detail

UserDefinedJavaClassMeta

public UserDefinedJavaClassMeta()

Method Detail

cookClasses

public void cookClasses()

newChildInstance

public TransformClassBase newChildInstance(UserDefinedJavaClass parent,
                                           UserDefinedJavaClassMeta meta,
                                           UserDefinedJavaClassData data)

getFieldInfo

public List<UserDefinedJavaClassMeta.FieldInfo> getFieldInfo()

replaceFields

public void replaceFields(List<UserDefinedJavaClassMeta.FieldInfo> fields)

getDefinitions

public List<UserDefinedJavaClassDef> getDefinitions()

replaceDefinitions

public void replaceDefinitions(List<UserDefinedJavaClassDef> definitions)

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

setDefault

public void setDefault()

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

getStepIOMeta

public StepIOMetaInterface getStepIOMeta()

Description copied from class: BaseStepMeta

Returns the Input/Output metadata for this step. By default, each step produces and accepts optional input.

Specified by:

getStepIOMeta in interface StepMetaInterface

Overrides:

getStepIOMeta in class BaseStepMeta

searchInfoAndTargetSteps

public void searchInfoAndTargetSteps(List<StepMeta> steps)

Description copied from class: BaseStepMeta

Change step names into step objects to allow them to be name-changed etc.

Specified by:

searchInfoAndTargetSteps in interface StepMetaInterface

Overrides:

searchInfoAndTargetSteps in class BaseStepMeta

Parameters:

steps - the steps to reference

getFields

public void getFields(RowMetaInterface row,
                      String originStepname,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)
               throws KettleStepException

Description copied from class: BaseStepMeta

Gets the fields.

Specified by:

getFields in interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

row - the input row meta

originStepname - the name

info - the info

nextStep - the next step

space - the space

Throws:

KettleStepException - the kettle step exception

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)

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

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

supportsErrorHandling

public boolean supportsErrorHandling()

Specified by:

supportsErrorHandling in interface StepMetaInterface

Overrides:

supportsErrorHandling in class BaseStepMeta

Returns:

true if this step supports error "reporting" on rows: the ability to send rows to a certain target step.

isClearingResultFields

public boolean isClearingResultFields()

Returns:

the clearingResultFields

setClearingResultFields

public void setClearingResultFields(boolean clearingResultFields)

Parameters:

clearingResultFields - the clearingResultFields to set

getInfoStepDefinitions

public List<StepDefinition> getInfoStepDefinitions()

Returns:

the infoStepDefinitions

setInfoStepDefinitions

public void setInfoStepDefinitions(List<StepDefinition> infoStepDefinitions)

Parameters:

infoStepDefinitions - the infoStepDefinitions to set

getTargetStepDefinitions

public List<StepDefinition> getTargetStepDefinitions()

Returns:

the targetStepDefinitions

setTargetStepDefinitions

public void setTargetStepDefinitions(List<StepDefinition> targetStepDefinitions)

Parameters:

targetStepDefinitions - the targetStepDefinitions to set

excludeFromRowLayoutVerification

public boolean excludeFromRowLayoutVerification()

Description copied from class: BaseStepMeta

This method is added to exclude certain steps from layout checking.

Specified by:

excludeFromRowLayoutVerification in interface StepMetaInterface

Overrides:

excludeFromRowLayoutVerification in class BaseStepMeta

getUsageParameters

public List<UsageParameter> getUsageParameters()

Returns:

the usageParameters

setUsageParameters

public void setUsageParameters(List<UsageParameter> usageParameters)

Parameters:

usageParameters - the usageParameters to set