org.pentaho.di.trans.steps.switchcase

Class SwitchCaseMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.switchcase.SwitchCaseMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class SwitchCaseMeta
extends BaseStepMeta
implements StepMetaInterface

Field Summary

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

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

Constructors

Constructor and Description
SwitchCaseMeta()

Method Summary

Methods

Modifier and Type	Method and Description
void	allocate()
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.
Object	clone() Make an exact copy of this step, make sure to explicitly copy Collections etc.
boolean	excludeFromCopyDistributeVerification() This method is added to exclude certain steps from copy/distribute checking.
List<SwitchCaseTarget>	getCaseTargets()
String	getCaseValueDecimal()
String	getCaseValueFormat()
String	getCaseValueGroup()
int	getCaseValueType()
StepMeta	getDefaultTargetStep()
String	getDefaultTargetStepname()
String	getFieldname()
void	getFields(org.pentaho.di.core.row.RowMetaInterface rowMeta, String origin, 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.
List<StreamInterface>	getOptionalStreams()
StepInterface	getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, 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.
String	getXML() Produces the XML string that describes this step's information.
void	handleStreamSelection(StreamInterface stream) When an optional stream is selected, this method is called to handled the ETL metadata implications of that.
boolean	isContains()
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 Node
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 repository
void	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 repository
void	searchInfoAndTargetSteps(List<StepMeta> steps) Change step names into step objects to allow them to be name-changed etc.
void	setCaseTargets(List<SwitchCaseTarget> caseTargets)
void	setCaseValueDecimal(String caseValueDecimal)
void	setCaseValueFormat(String caseValueFormat)
void	setCaseValueGroup(String caseValueGroup)
void	setCaseValueType(int caseValueType)
void	setContains(boolean isContains)
void	setDefault() Set default values
void	setDefaultTargetStep(StepMeta defaultTargetStep)
void	setDefaultTargetStepname(String defaultTargetStepname)
void	setFieldname(String fieldname)

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

analyseImpact, analyseImpact, cancelQueries, check, check, excludeFromRowLayoutVerification, exportResources, exportResources, findAttribute, findParent, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isReferencedObjectEnabled, isRowLevel, loadReferencedObject, loadReferencedObject, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, resetStepIoMeta, saveRep, setChanged, setChanged, setParentStepMeta, supportsErrorHandling

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, analyseImpact, cancelQueries, check, excludeFromRowLayoutVerification, exportResources, exportResources, getDialogClassName, getFields, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, readRep, resetStepIoMeta, saveRep, setChanged, setParentStepMeta, supportsErrorHandling

Constructor Detail

SwitchCaseMeta

public SwitchCaseMeta()

Method Detail

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

org.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

allocate

public void allocate()

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

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.

setDefault

public void setDefault()

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

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

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

org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

getFields

public void getFields(org.pentaho.di.core.row.RowMetaInterface rowMeta,
             String origin,
             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 interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

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

origin - 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:

org.pentaho.di.core.exception.KettleStepException - the kettle step exception

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

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

getFieldname

public String getFieldname()

Returns:

the fieldname

setFieldname

public void setFieldname(String fieldname)

Parameters:

fieldname - the fieldname to set

getCaseValueFormat

public String getCaseValueFormat()

Returns:

the caseValueFormat

setCaseValueFormat

public void setCaseValueFormat(String caseValueFormat)

Parameters:

caseValueFormat - the caseValueFormat to set

getCaseValueDecimal

public String getCaseValueDecimal()

Returns:

the caseValueDecimal

setCaseValueDecimal

public void setCaseValueDecimal(String caseValueDecimal)

Parameters:

caseValueDecimal - the caseValueDecimal to set

getCaseValueGroup

public String getCaseValueGroup()

Returns:

the caseValueGroup

setCaseValueGroup

public void setCaseValueGroup(String caseValueGroup)

Parameters:

caseValueGroup - the caseValueGroup to set

getCaseValueType

public int getCaseValueType()

Returns:

the caseValueType

setCaseValueType

public void setCaseValueType(int caseValueType)

Parameters:

caseValueType - the caseValueType to set

getDefaultTargetStepname

public String getDefaultTargetStepname()

Returns:

the defaultTargetStepname

setDefaultTargetStepname

public void setDefaultTargetStepname(String defaultTargetStepname)

Parameters:

defaultTargetStepname - the defaultTargetStepname to set

getDefaultTargetStep

public StepMeta getDefaultTargetStep()

Returns:

the defaultTargetStep

setDefaultTargetStep

public void setDefaultTargetStep(StepMeta defaultTargetStep)

Parameters:

defaultTargetStep - the defaultTargetStep to set

isContains

public boolean isContains()

setContains

public void setContains(boolean isContains)

getStepIOMeta

public StepIOMetaInterface getStepIOMeta()

Returns the Input/Output metadata for this step.

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

getOptionalStreams

public List<StreamInterface> getOptionalStreams()

Specified by:

getOptionalStreams in interface StepMetaInterface

Overrides:

getOptionalStreams in class BaseStepMeta

Returns:

The list of optional input streams. It allows the user to select from a list of possible actions like "New target step"

handleStreamSelection

public void handleStreamSelection(StreamInterface stream)

Description copied from class: BaseStepMeta

When an optional stream is selected, this method is called to handled the ETL metadata implications of that.

Specified by:

handleStreamSelection in interface StepMetaInterface

Overrides:

handleStreamSelection in class BaseStepMeta

Parameters:

stream - The optional stream to handle.

getCaseTargets

public List<SwitchCaseTarget> getCaseTargets()

Returns:

the caseTargets

setCaseTargets

public void setCaseTargets(List<SwitchCaseTarget> caseTargets)

Parameters:

caseTargets - the caseTargets to set

excludeFromCopyDistributeVerification

public boolean excludeFromCopyDistributeVerification()

This method is added to exclude certain steps from copy/distribute checking.

Specified by:

excludeFromCopyDistributeVerification in interface StepMetaInterface

Overrides:

excludeFromCopyDistributeVerification in class BaseStepMeta

Since:

4.0.0