org.pentaho.di.trans.steps.fieldsplitter

Class FieldSplitterMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.fieldsplitter.FieldSplitterMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class FieldSplitterMeta
extends BaseStepMeta
implements StepMetaInterface

Example1:

-------------

DATUM;VALUES

20031031;500,300,200,100

|| delimiter = ,

\||/ field[] = SALES1, SALES2, SALES3, SALES4

\/ id[] =

idrem[] = no, no, no, no

type[] = Number, Number, Number, Number

format[] = ###.##, ###.##, ###.##, ###.##

group[] =

decimal[] = .

currency[] =

length[] = 3, 3, 3, 3

precision[] = 0, 0, 0, 0

DATUM;SALES1;SALES2;SALES3;SALES4

20031031;500;300;200;100

Example2:

-----------

20031031;Sales2=310.50, Sales4=150.23

|| delimiter = ,

\||/ field[] = SALES1, SALES2, SALES3, SALES4

\/ id[] = Sales1, Sales2, Sales3, Sales4

idrem[] = yes, yes, yes, yes (remove ID's from split field)

type[] = Number, Number, Number, Number

format[] = ###.##, ###.##, ###.##, ###.##

group[] =

decimal[] = .

currency[] =

length[] = 3, 3, 3, 3

precision[] = 0, 0, 0, 0

DATUM;SALES1;SALES2;SALES3;SALES4

20031031;310,50;150,23

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
FieldSplitterMeta()

Method Summary

Modifier and Type	Method and Description
void	afterInjectionSynchronization() If we use injection we can have different arrays lengths.
void	allocate(int nrfields)
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.
String	getDelimiter()
String	getEnclosure()
String[]	getFieldCurrency()
String[]	getFieldDecimal()
String[]	getFieldFormat()
String[]	getFieldGroup()
String[]	getFieldID()
String[]	getFieldIfNull()
int[]	getFieldLength()
String[]	getFieldName()
String[]	getFieldNullIf()
int[]	getFieldPrecision()
boolean[]	getFieldRemoveID()
void	getFields(RowMetaInterface r, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Gets the fields.
int	getFieldsCount()
int[]	getFieldTrimType()
int[]	getFieldType()
String	getSplitField()
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.
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	setDelimiter(String delimiter)
void	setEnclosure(String enclosure)
void	setFieldCurrency(String[] fieldCurrency)
void	setFieldDecimal(String[] fieldDecimal)
void	setFieldFormat(String[] fieldFormat)
void	setFieldGroup(String[] fieldGroup)
void	setFieldID(String[] fieldID)
void	setFieldIfNull(String[] fieldIfNull)
void	setFieldLength(int[] fieldLength)
void	setFieldName(String[] fieldName)
void	setFieldNullIf(String[] fieldNullIf)
void	setFieldPrecision(int[] fieldPrecision)
void	setFieldRemoveID(boolean[] fieldRemoveID)
void	setFieldTrimType(int[] fieldTrimType)
void	setFieldType(int[] fieldType)
void	setSplitField(String splitField)

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

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, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, 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, supportsErrorHandling

Constructor Detail

FieldSplitterMeta

public FieldSplitterMeta()

Method Detail

getSplitField

public String getSplitField()

setSplitField

public void setSplitField(String splitField)

getDelimiter

public String getDelimiter()

setDelimiter

public void setDelimiter(String delimiter)

getEnclosure

public String getEnclosure()

setEnclosure

public void setEnclosure(String enclosure)

getFieldName

public String[] getFieldName()

setFieldName

public void setFieldName(String[] fieldName)

getFieldID

public String[] getFieldID()

setFieldID

public void setFieldID(String[] fieldID)

getFieldRemoveID

public boolean[] getFieldRemoveID()

setFieldRemoveID

public void setFieldRemoveID(boolean[] fieldRemoveID)

getFieldType

public int[] getFieldType()

setFieldType

public void setFieldType(int[] fieldType)

getFieldFormat

public String[] getFieldFormat()

setFieldFormat

public void setFieldFormat(String[] fieldFormat)

getFieldGroup

public String[] getFieldGroup()

setFieldGroup

public void setFieldGroup(String[] fieldGroup)

getFieldDecimal

public String[] getFieldDecimal()

setFieldDecimal

public void setFieldDecimal(String[] fieldDecimal)

getFieldCurrency

public String[] getFieldCurrency()

setFieldCurrency

public void setFieldCurrency(String[] fieldCurrency)

getFieldLength

public int[] getFieldLength()

setFieldLength

public void setFieldLength(int[] fieldLength)

getFieldPrecision

public int[] getFieldPrecision()

setFieldPrecision

public void setFieldPrecision(int[] fieldPrecision)

getFieldNullIf

public String[] getFieldNullIf()

setFieldNullIf

public void setFieldNullIf(String[] fieldNullIf)

getFieldIfNull

public String[] getFieldIfNull()

setFieldIfNull

public void setFieldIfNull(String[] fieldIfNull)

getFieldTrimType

public int[] getFieldTrimType()

setFieldTrimType

public void setFieldTrimType(int[] fieldTrimType)

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)

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

getFieldsCount

public int getFieldsCount()

getFields

public void getFields(RowMetaInterface r,
                      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:

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

afterInjectionSynchronization

public void afterInjectionSynchronization()

If we use injection we can have different arrays lengths. We need synchronize them for consistency behavior with UI