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

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

public class SelectValuesMeta
extends BaseStepMeta
implements StepMetaInterface, StepMetaInjectionInterface

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


Field Summary
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
SelectValuesMeta()
           
 
Method Summary
 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)
          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)
          Gets the fields.
 SelectMetadataChange[] getMeta()
           
 void getMetadataFields(RowMetaInterface inputRowMeta, String name)
           
 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.
 List<StepInjectionMetaEntry> getStepInjectionMetadataEntries()
          Describe the metadata attributes that can be injected into this step metadata object.
 StepMetaInjectionInterface getStepMetaInjectionInterface()
           
 String getXML()
          Produces the XML string that describes this step's information.
 void injectStepMetadataEntries(List<StepInjectionMetaEntry> metadata)
           
 boolean isSelectingAndSortingUnspecifiedFields()
           
 void loadXML(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters)
          Load the values for this step from an XML Node
 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 setDefault()
          Set default values
 void setDeleteName(String[] deleteName)
           
 void setMeta(SelectMetadataChange[] meta)
           
 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, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, findAttribute, findParent, getDescription, getDialogClassName, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, 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, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta
 

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.

getSelectLength

public int[] getSelectLength()
Returns:
Returns the selectLength.

setSelectLength

public void setSelectLength(int[] selectLength)
Parameters:
selectLength - The selectLength to set.

getSelectName

public String[] getSelectName()
Returns:
Returns the selectName.

setSelectName

public void setSelectName(String[] selectName)
Parameters:
selectName - The selectName to set.

getSelectPrecision

public int[] getSelectPrecision()
Returns:
Returns the selectPrecision.

setSelectPrecision

public void setSelectPrecision(int[] selectPrecision)
Parameters:
selectPrecision - The selectPrecision to set.

getSelectRename

public String[] getSelectRename()
Returns:
Returns the selectRename.

setSelectRename

public void setSelectRename(String[] selectRename)
Parameters:
selectRename - The selectRename to set.

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

public void getMetadataFields(RowMetaInterface inputRowMeta,
                              String name)

getFields

public void getFields(RowMetaInterface inputRowMeta,
                      String name,
                      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:
inputRowMeta - the input row meta
name - 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 stepMeta,
                  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
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

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.

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

getStepMetaInjectionInterface

public StepMetaInjectionInterface getStepMetaInjectionInterface()
Specified by:
getStepMetaInjectionInterface in interface StepMetaInterface
Overrides:
getStepMetaInjectionInterface in class BaseStepMeta
Returns:
Optional interface that allows an external program to inject step metadata in a standardized fasion. This method will return null if the interface is not available for this step.

getStepInjectionMetadataEntries

public List<StepInjectionMetaEntry> getStepInjectionMetadataEntries()
Describe the metadata attributes that can be injected into this step metadata object.

Specified by:
getStepInjectionMetadataEntries in interface StepMetaInjectionInterface
Returns:
A list of step injection metadata entries. In case the data type of the entry is NONE (0) you will get at least one entry in the details section. You can use this list

injectStepMetadataEntries

public void injectStepMetadataEntries(List<StepInjectionMetaEntry> metadata)
Specified by:
injectStepMetadataEntries in interface StepMetaInjectionInterface