org.pentaho.di.trans.steps.scriptvalues_mod
Class ScriptValuesMetaMod

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

public class ScriptValuesMetaMod
extends BaseStepMeta
implements StepMetaInterface


Field Summary
static String OPTIMIZATION_LEVEL_DEFAULT
           
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
ScriptValuesMetaMod()
           
 
Method Summary
 void allocate(int nrfields)
           
 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.
 ScriptValuesAddClasses[] getAddClasses()
           
 String getDialogClassName()
          This returns the expected name for the dialog that edits a job entry.
 String[] getFieldname()
           
 void getFields(RowMetaInterface row, String originStepname, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Gets the fields.
 String getFunctionFromScript(String strFunction, String strScript)
           
 String[] getJSScriptNames()
           
 ScriptValuesScript[] getJSScripts()
           
 int[] getLength()
           
 int getNumberOfJSScripts()
           
 String getOptimizationLevel()
           
 int[] getPrecision()
           
 String[] getRename()
           
 boolean[] getReplace()
           
 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.
 int[] getType()
           
 boolean getValue(org.mozilla.javascript.Scriptable scope, int i, Value res, StringBuffer message)
           
 String getXML()
          Produces the XML string that describes this step's information.
 boolean isCompatible()
           
 void loadXML(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters)
          Load the values for this step from an XML Node
 void parseXmlForAdditionalClasses()
           
 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 setCompatible(boolean compatible)
           
 void setDefault()
          Set default values
 void setFieldname(String[] fieldname)
           
 void setJSScripts(ScriptValuesScript[] jsScripts)
           
 void setLength(int[] length)
           
 void setOptimizationLevel(String optimizationLevel)
           
 void setPrecision(int[] precision)
           
 void setRename(String[] rename)
           
 void setReplace(boolean[] replace)
           
 void setType(int[] type)
           
 boolean supportsErrorHandling()
           
 
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, findAttribute, findParent, getDescription, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, 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, searchInfoAndTargetSteps, 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, excludeFromRowLayoutVerification, exportResources, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta
 

Field Detail

OPTIMIZATION_LEVEL_DEFAULT

public static final String OPTIMIZATION_LEVEL_DEFAULT
See Also:
Constant Field Values
Constructor Detail

ScriptValuesMetaMod

public ScriptValuesMetaMod()
Method Detail

getLength

public int[] getLength()
Returns:
Returns the length.

setLength

public void setLength(int[] length)
Parameters:
length - The length to set.

getFieldname

public String[] getFieldname()
Returns:
Returns the name.

setFieldname

public void setFieldname(String[] fieldname)
Parameters:
fieldname - The name to set.

getPrecision

public int[] getPrecision()
Returns:
Returns the precision.

setPrecision

public void setPrecision(int[] precision)
Parameters:
precision - The precision to set.

getRename

public String[] getRename()
Returns:
Returns the rename.

setRename

public void setRename(String[] rename)
Parameters:
rename - The rename to set.

getType

public int[] getType()
Returns:
Returns the type.

setType

public void setType(int[] type)
Parameters:
type - The type to set.

getNumberOfJSScripts

public int getNumberOfJSScripts()

getJSScriptNames

public String[] getJSScriptNames()

getJSScripts

public ScriptValuesScript[] getJSScripts()

setJSScripts

public void setJSScripts(ScriptValuesScript[] jsScripts)

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

allocate

public void allocate(int nrfields)

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

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

getFunctionFromScript

public String getFunctionFromScript(String strFunction,
                                    String strScript)

getValue

public boolean getValue(org.mozilla.javascript.Scriptable scope,
                        int i,
                        Value res,
                        StringBuffer message)

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.

parseXmlForAdditionalClasses

public void parseXmlForAdditionalClasses()
                                  throws KettleException
Throws:
KettleException

getAddClasses

public ScriptValuesAddClasses[] getAddClasses()

isCompatible

public boolean isCompatible()
Returns:
the compatible

setCompatible

public void setCompatible(boolean compatible)
Parameters:
compatible - the compatible to set

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.

getDialogClassName

public String getDialogClassName()
Description copied from class: BaseStepMeta
This returns the expected name for the dialog that edits a job entry. The expected name is in the org.pentaho.di.ui tree and has a class name that is the name of the job entry with 'Dialog' added to the end. e.g. if the job entry is org.pentaho.di.job.entries.zipfile.JobEntryZipFile the dialog would be org.pentaho.di.ui.job.entries.zipfile.JobEntryZipFileDialog If the dialog class for a job entry does not match this pattern it should override this method and return the appropriate class name

Specified by:
getDialogClassName in interface StepMetaInterface
Overrides:
getDialogClassName in class BaseStepMeta
Returns:
full class name of the dialog

getReplace

public boolean[] getReplace()
Returns:
the replace

setReplace

public void setReplace(boolean[] replace)
Parameters:
replace - the replace to set

setOptimizationLevel

public void setOptimizationLevel(String optimizationLevel)

getOptimizationLevel

public String getOptimizationLevel()