Class ScriptValuesMetaMod
java.lang.Object
org.pentaho.di.trans.step.BaseStepMeta
org.pentaho.di.trans.steps.scriptvalues_mod.ScriptValuesMetaMod
- All Implemented Interfaces:
Cloneable
,StepAttributesInterface
,StepMetaInterface
@Step(id="ScriptValuesMod",
i18nPackageName="org.pentaho.di.trans.steps.scriptvalues_mod",
name="ScriptValuesMod.Name",
description="ScriptValuesMod.Description",
categoryDescription="i18n:org.pentaho.di.trans.step:BaseStep.Category.Scripting")
public class ScriptValuesMetaMod
extends BaseStepMeta
implements StepMetaInterface
-
Field Summary
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
attributes, databases, log, loggingObject, parentStepMeta, repository, STEP_ATTRIBUTES_FILE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
void
allocate
(int nrfields) 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, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Checks the settings of this step and puts the findings in a remarks List.clone()
Make an exact copy of this step, make sure to explicitly copy Collections etc.This returns the expected name for the dialog that edits a job entry.String[]
void
getFields
(org.pentaho.di.core.row.RowMetaInterface row, String originStepname, org.pentaho.di.core.row.RowMetaInterface[] info, StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Gets the fields.getFunctionFromScript
(String strFunction, String strScript) String[]
int[]
int
int[]
String[]
boolean[]
getStep
(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans) Get the executing step, needed by Trans to launch a step.Get a new instance of the appropriate data class.int[]
getType()
boolean
getValue
(org.mozilla.javascript.Scriptable scope, int i, org.pentaho.di.compatibility.Value res, StringBuilder message) getXML()
Produces the XML string that describes this step's information.boolean
void
loadXML
(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) Load the values for this step from an XML Nodevoid
void
readRep
(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases) Read the steps information from a Kettle repositoryvoid
saveRep
(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step) Save the steps data into a Kettle repositoryvoid
setCompatible
(boolean compatible) void
Set default valuesvoid
setFieldname
(String[] fieldname) void
setJSScripts
(ScriptValuesScript[] jsScripts) void
setLength
(int[] length) void
setOptimizationLevel
(String optimizationLevel) void
setPrecision
(int[] precision) void
void
setReplace
(boolean[] replace) void
setType
(int[] type) boolean
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, analyseImpact, cancelQueries, check, check, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isReferencedObjectEnabled, isRowLevel, loadReferencedObject, loadReferencedObject, loadStepAttributes, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta, setStepIOMeta
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface
analyseImpact, analyseImpact, cancelQueries, check, cleanAfterHopFromRemove, cleanAfterHopFromRemove, cleanAfterHopToRemove, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, fetchTransMeta, getActiveReferencedObjectDescription, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, passDataToServletOutput, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setParentStepMeta
-
Field Details
-
OPTIMIZATION_LEVEL_DEFAULT
- See Also:
-
-
Constructor Details
-
ScriptValuesMetaMod
public ScriptValuesMetaMod()
-
-
Method Details
-
getLength
public int[] getLength()- Returns:
- Returns the length.
-
setLength
public void setLength(int[] length) - Parameters:
length
- The length to set.
-
getFieldname
- Returns:
- Returns the name.
-
setFieldname
- 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
- Returns:
- Returns the rename.
-
setRename
- Parameters:
rename
- The rename to set.
-
getType
public int[] getType()- Returns:
- Returns the type.
-
afterInjection
public void afterInjection() -
setType
public void setType(int[] type) - Parameters:
type
- The type to set.
-
getNumberOfJSScripts
public int getNumberOfJSScripts() -
getJSScriptNames
-
getJSScripts
-
setJSScripts
-
loadXML
public void loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleXMLException Description copied from interface:StepMetaInterface
Load the values for this step from an XML Node- Specified by:
loadXML
in interfaceStepMetaInterface
- Overrides:
loadXML
in classBaseStepMeta
- Parameters:
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tometaStore
- the metastore to optionally load external reference metadata from- Throws:
org.pentaho.di.core.exception.KettleXMLException
- When an unexpected XML error occurred. (malformed etc.)
-
allocate
public void allocate(int nrfields) -
clone
Description copied from interface:StepMetaInterface
Make an exact copy of this step, make sure to explicitly copy Collections etc.- Specified by:
clone
in interfaceStepMetaInterface
- Overrides:
clone
in classBaseStepMeta
- Returns:
- an exact copy of this step
-
setDefault
public void setDefault()Description copied from interface:StepMetaInterface
Set default values- Specified by:
setDefault
in interfaceStepMetaInterface
-
getFields
public void getFields(org.pentaho.di.core.row.RowMetaInterface row, String originStepname, org.pentaho.di.core.row.RowMetaInterface[] info, StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleStepException Description copied from class:BaseStepMeta
Gets the fields.- Specified by:
getFields
in interfaceStepMetaInterface
- Overrides:
getFields
in classBaseStepMeta
- Parameters:
row
- the input row meta that is modified in this method to reflect the output row metadata of the steporiginStepname
- Name of the step to use as input for the origin field in the valuesinfo
- Fields used as extra lookup informationnextStep
- the next step that is targetedspace
- the space The variable space to use to replace variablesrepository
- the repository to use to load Kettle metadata objects impacting the output fieldsmetaStore
- the MetaStore to use to load additional external data or metadata impacting the output fields- Throws:
org.pentaho.di.core.exception.KettleStepException
- the kettle step exception
-
getXML
Description copied from class:BaseStepMeta
Produces the XML string that describes this step's information.- Specified by:
getXML
in interfaceStepMetaInterface
- Overrides:
getXML
in classBaseStepMeta
- Returns:
- String containing the XML describing this step.
-
readRep
public void readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases) throws org.pentaho.di.core.exception.KettleException Description copied from interface:StepMetaInterface
Read the steps information from a Kettle repository- Specified by:
readRep
in interfaceStepMetaInterface
- Overrides:
readRep
in classBaseStepMeta
- Parameters:
rep
- The repository to read frommetaStore
- The MetaStore to read external information fromid_step
- The step IDdatabases
- The databases to reference- Throws:
org.pentaho.di.core.exception.KettleException
- When an unexpected error occurred (database, network, etc)
-
saveRep
public void saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step) throws org.pentaho.di.core.exception.KettleException Description copied from interface:StepMetaInterface
Save the steps data into a Kettle repository- Specified by:
saveRep
in interfaceStepMetaInterface
- Overrides:
saveRep
in classBaseStepMeta
- Parameters:
rep
- The Kettle repository to save tometaStore
- the metaStore to optionally write toid_transformation
- The transformation IDid_step
- The step ID- Throws:
org.pentaho.di.core.exception.KettleException
- When an unexpected error occurred (database, network, etc)
-
check
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, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Description copied from interface:StepMetaInterface
Checks the settings of this step and puts the findings in a remarks List.- Specified by:
check
in interfaceStepMetaInterface
- Overrides:
check
in classBaseStepMeta
- Parameters:
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 stepspace
- the variable space to resolve variable expressions withrepository
- the repository to use to load Kettle metadata objects impacting the output fieldsmetaStore
- the MetaStore to use to load additional external data or metadata impacting the output fields
-
getFunctionFromScript
-
getValue
public boolean getValue(org.mozilla.javascript.Scriptable scope, int i, org.pentaho.di.compatibility.Value res, StringBuilder 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 interfaceStepMetaInterface
- Parameters:
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 transformation
-
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 interfaceStepMetaInterface
- Returns:
- The appropriate StepDataInterface class.
-
parseXmlForAdditionalClasses
public void parseXmlForAdditionalClasses() throws org.pentaho.di.core.exception.KettleException- Throws:
org.pentaho.di.core.exception.KettleException
-
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 interfaceStepMetaInterface
- Overrides:
supportsErrorHandling
in classBaseStepMeta
- Returns:
- true if this step supports error "reporting" on rows: the ability to send rows to a certain target step.
-
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 interfaceStepMetaInterface
- Overrides:
getDialogClassName
in classBaseStepMeta
- 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
-
getOptimizationLevel
-