org.pentaho.di.trans.steps.selectvalues

Class SelectValuesMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.selectvalues.SelectValuesMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class SelectValuesMeta
extends BaseStepMeta
implements StepMetaInterface

Meta Data class for the Select Values Step. Created on 02-jun-2003

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SelectValuesMeta.SelectField

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNDEFINED

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

attributes, databases, log, loggingObject, parentStepMeta, repository, STEP_ATTRIBUTES_FILE

Constructor Summary

Constructors

Constructor and Description
SelectValuesMeta()

Method Summary

Modifier and Type	Method and Description
void	allocate(int nrFields, int nrRemove, int nrMeta)
void	check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) 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	getDeleteFields(RowMetaInterface inputRowMeta)
String[]	getDeleteName()
List<FieldnameLineage>	getFieldnameLineage() We will describe in which way the field names change between input and output in this step.
void	getFields(RowMetaInterface inputRowMeta, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Gets the fields.
SelectMetadataChange[]	getMeta()
void	getMetadataFields(RowMetaInterface inputRowMeta, String name) Deprecated.
void	getMetadataFields(RowMetaInterface inputRowMeta, String name, VariableSpace space)
SelectValuesMeta.SelectField[]	getSelectFields()
void	getSelectFields(RowMetaInterface inputRowMeta, String name)
int[]	getSelectLength()
String[]	getSelectName()
int[]	getSelectPrecision()
String[]	getSelectRename()
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.
String	getXML() Produces the XML string that describes this step's information.
boolean	isSelectingAndSortingUnspecifiedFields()
void	loadXML(Node stepnode, List<DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) Load the values for this step from an XML Node
void	readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_step, List<DatabaseMeta> databases) Read the steps information from a Kettle repository
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_transformation, ObjectId id_step) Save the steps data into a Kettle repository
void	setDefault() Set default values
void	setDeleteName(String[] deleteName)
void	setMeta(SelectMetadataChange[] meta)
void	setSelectFields(SelectValuesMeta.SelectField[] selectFields)
void	setSelectingAndSortingUnspecifiedFields(boolean selectingAndSortingUnspecifiedFields)
void	setSelectLength(int[] selectLength)
void	setSelectName(String[] selectName)
void	setSelectPrecision(int[] selectPrecision)
void	setSelectRename(String[] selectRename)
boolean	supportsErrorHandling()

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, getDialogClassName, 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, getDialogClassName, 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 Detail

UNDEFINED

public static final int UNDEFINED

See Also:

Constant Field Values

Constructor Detail

SelectValuesMeta

public SelectValuesMeta()

Method Detail

getDeleteName

public String[] getDeleteName()

Returns:

Returns the deleteName.

setDeleteName

public void setDeleteName(String[] deleteName)

Parameters:

deleteName - The deleteName to set.

setSelectName

public void setSelectName(String[] selectName)

Parameters:

selectName - The selectName to set.

getSelectName

public String[] getSelectName()

setSelectRename

public void setSelectRename(String[] selectRename)

Parameters:

selectRename - The selectRename to set.

getSelectRename

public String[] getSelectRename()

setSelectLength

public void setSelectLength(int[] selectLength)

Parameters:

selectLength - The selectLength to set.

getSelectLength

public int[] getSelectLength()

setSelectPrecision

public void setSelectPrecision(int[] selectPrecision)

Parameters:

selectPrecision - The selectPrecision to set.

getSelectPrecision

public int[] getSelectPrecision()

loadXML

public void loadXML(Node stepnode,
                    List<DatabaseMeta> databases,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws KettleXMLException

Description copied from interface: StepMetaInterface

Load the values for this step from an XML Node

Specified by:

loadXML in interface StepMetaInterface

Overrides:

loadXML in class BaseStepMeta

Parameters:

stepnode - the Node to get the info from

databases - The available list of databases to reference to

metaStore - the metastore to optionally load external reference metadata from

Throws:

KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

allocate

public void allocate(int nrFields,
                     int nrRemove,
                     int nrMeta)

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

getSelectFields

public void getSelectFields(RowMetaInterface inputRowMeta,
                            String name)
                     throws KettleStepException

Throws:

KettleStepException

getDeleteFields

public void getDeleteFields(RowMetaInterface inputRowMeta)
                     throws KettleStepException

Throws:

KettleStepException

getMetadataFields

@Deprecated
public void getMetadataFields(RowMetaInterface inputRowMeta,
                                          String name)
                                   throws KettlePluginException

Deprecated.

Throws:

KettlePluginException

getMetadataFields

public void getMetadataFields(RowMetaInterface inputRowMeta,
                              String name,
                              VariableSpace space)
                       throws KettlePluginException

Throws:

KettlePluginException

getFields

public void getFields(RowMetaInterface inputRowMeta,
                      String name,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space,
                      Repository repository,
                      org.pentaho.metastore.api.IMetaStore metaStore)
               throws KettleStepException

Description copied from class: BaseStepMeta

Gets the fields.

Specified by:

getFields in interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

inputRowMeta - the input row meta that is modified in this method to reflect the output row metadata of the step

name - Name of the step to use as input for the origin field in the values

info - Fields used as extra lookup information

nextStep - the next step that is targeted

space - the space The variable space to use to replace variables

repository - the repository to use to load Kettle metadata objects impacting the output fields

metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

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,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_step,
                    List<DatabaseMeta> databases)
             throws KettleException

Description copied from interface: StepMetaInterface

Read the steps information from a Kettle repository

Specified by:

readRep in interface StepMetaInterface

Overrides:

readRep in class BaseStepMeta

Parameters:

rep - The repository to read from

metaStore - The MetaStore to read external information from

id_step - The step ID

databases - The databases to reference

Throws:

KettleException - When an unexpected error occurred (database, network, etc)

saveRep

public void saveRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    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

Overrides:

saveRep in class BaseStepMeta

Parameters:

rep - The Kettle repository to save to

metaStore - the metaStore to optionally write 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 stepMeta,
                  RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  RowMetaInterface info,
                  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 interface StepMetaInterface

Overrides:

check in class BaseStepMeta

Parameters:

remarks - The list to put the remarks in @see org.pentaho.di.core.CheckResult

stepMeta - 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

space - the variable space to resolve variable expressions with

repository - the repository to use to load Kettle metadata objects impacting the output fields

metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

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.

isSelectingAndSortingUnspecifiedFields

public boolean isSelectingAndSortingUnspecifiedFields()

Returns:

the selectingAndSortingUnspecifiedFields

setSelectingAndSortingUnspecifiedFields

public void setSelectingAndSortingUnspecifiedFields(boolean selectingAndSortingUnspecifiedFields)

Parameters:

selectingAndSortingUnspecifiedFields - the selectingAndSortingUnspecifiedFields to set

getMeta

public SelectMetadataChange[] getMeta()

Returns:

the meta

setMeta

public void setMeta(SelectMetadataChange[] meta)

Parameters:

meta - the meta 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.

getSelectFields

public SelectValuesMeta.SelectField[] getSelectFields()

setSelectFields

public void setSelectFields(SelectValuesMeta.SelectField[] selectFields)

getFieldnameLineage

public List<FieldnameLineage> getFieldnameLineage()

We will describe in which way the field names change between input and output in this step.

Returns:

The list of field name lineage objects