Package org.pentaho.di.trans.streaming.common

Class BaseStreamStepMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.core.util.serialization.BaseSerializingMeta

org.pentaho.di.trans.StepWithMappingMeta

org.pentaho.di.trans.streaming.common.BaseStreamStepMeta

All Implemented Interfaces:

Cloneable, HasRepositoryDirectories, ISubTransAwareMeta, StepAttributesInterface, StepMetaInterface

public abstract class BaseStreamStepMeta
extends StepWithMappingMeta
implements StepMetaInterface, ISubTransAwareMeta

Field Summary

Fields

Modifier and Type	Field	Description
protected String	batchDuration
protected String	batchSize
static String	DURATION
static String	MESSAGE_DATA_TYPE
static String	NOT_A_NUMBER
static String	NUM_MESSAGES
protected String	parallelism
static String	PARALLELISM
static int	PREFETCH
static String	PREFETCH_COUNT
static String	PREFETCH_DEFAULT
protected String	prefetchCount
static String	SUB_STEP
protected String	subStep
static String	TRANSFORMATION_PATH
protected String	transformationPath

Fields inherited from class org.pentaho.di.trans.StepWithMappingMeta

directoryPath, fileName, specificationMethod, transName, transObjectId

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

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

Constructor Summary

Constructors

Constructor	Description
BaseStreamStepMeta()

Method Summary

Modifier and Type	Method	Description
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.
String	getBatchDuration()
String	getBatchSize()
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.
String	getFileName()
int	getMessageDataType()
String	getParallelism()
String	getPrefetchCount()
String[]	getReferencedObjectDescriptions()
List<ResourceReference>	getResourceDependencies(TransMeta transMeta, StepMeta stepInfo)	Get a list of all the resource dependencies that the step is depending on.
abstract org.pentaho.di.core.row.RowMeta	getRowMeta(String origin, org.pentaho.di.core.variables.VariableSpace space)
String	getSubStep()
String	getTransformationPath()
boolean[]	isReferencedObjectEnabled()
Object	loadReferencedObject(int index, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.core.variables.VariableSpace space)	Load the referenced object
void	replaceFileName(String fileName)
void	setBatchDuration(String batchDuration)
void	setBatchSize(String batchSize)
void	setDefault()	Set default values
void	setParallelism(String parallelism)
void	setPrefetchCount(String prefetchCount)
void	setSubStep(String subStep)
void	setTransformationPath(String transformationPath)

Methods inherited from class org.pentaho.di.trans.StepWithMappingMeta

activateParams, activateParams, addMissingVariables, exportResources, getDirectories, getDirectoryPath, getInputMappings, getOutputMappings, getSpecificationMethod, getSpecificationMethods, getTransName, getTransObjectId, loadMappingMeta, loadMappingMeta, replaceVariableValues, replaceVariableValues, setDirectories, setDirectoryPath, setFileName, setSpecificationMethod, setTransName, setTransObjectId

Methods inherited from class org.pentaho.di.core.util.serialization.BaseSerializingMeta

getXML, loadXML, readRep, saveRep, withVariables

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

analyseImpact, analyseImpact, cancelQueries, check, check, clone, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isRowLevel, 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, 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.ISubTransAwareMeta

getDirectoryPath, getParentStepMeta, getSpecificationMethod, getTransName, getTransObjectId

Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface

analyseImpact, analyseImpact, cancelQueries, check, cleanAfterHopFromRemove, cleanAfterHopFromRemove, cleanAfterHopToRemove, clone, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, fetchTransMeta, getActiveReferencedObjectDescription, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getRequiredFields, getSQLStatements, getSQLStatements, getStep, getStepData, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXML, handleStreamSelection, hasChanged, hasRepositoryReferences, loadXML, loadXML, lookupRepositoryReferences, passDataToServletOutput, readRep, readRep, resetStepIoMeta, saveRep, saveRep, searchInfoAndTargetSteps, setChanged, setParentStepMeta, supportsErrorHandling

Field Detail

NOT_A_NUMBER

public static final String NOT_A_NUMBER

See Also:

Constant Field Values

TRANSFORMATION_PATH

public static final String TRANSFORMATION_PATH

See Also:

Constant Field Values

NUM_MESSAGES

public static final String NUM_MESSAGES

See Also:

Constant Field Values

PREFETCH_COUNT

public static final String PREFETCH_COUNT

See Also:

Constant Field Values

DURATION

public static final String DURATION

See Also:

Constant Field Values

SUB_STEP

public static final String SUB_STEP

See Also:

Constant Field Values

PARALLELISM

public static final String PARALLELISM

See Also:

Constant Field Values

MESSAGE_DATA_TYPE

public static final String MESSAGE_DATA_TYPE

See Also:

Constant Field Values

PREFETCH

public static final int PREFETCH

See Also:

Constant Field Values

PREFETCH_DEFAULT

public static final String PREFETCH_DEFAULT

transformationPath

protected String transformationPath

batchSize

protected String batchSize

prefetchCount

protected String prefetchCount

batchDuration

protected String batchDuration

subStep

protected String subStep

parallelism

protected String parallelism

Constructor Detail

BaseStreamStepMeta

public BaseStreamStepMeta()

Method Detail

getSubStep

public String getSubStep()

setSubStep

public void setSubStep(String subStep)

setTransformationPath

public void setTransformationPath(String transformationPath)

setBatchSize

public void setBatchSize(String batchSize)

setPrefetchCount

public void setPrefetchCount(String prefetchCount)

setBatchDuration

public void setBatchDuration(String batchDuration)

setParallelism

public void setParallelism(String parallelism)

setDefault

public void setDefault()

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

getTransformationPath

public String getTransformationPath()

getBatchSize

public String getBatchSize()

getPrefetchCount

public String getPrefetchCount()

getBatchDuration

public String getBatchDuration()

getParallelism

public String getParallelism()

getMessageDataType

public int getMessageDataType()

replaceFileName

public void replaceFileName(String fileName)

Overrides:

replaceFileName in class StepWithMappingMeta

Parameters:

fileName - the fileName to set

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

getFileName

public String getFileName()

Specified by:

getFileName in interface ISubTransAwareMeta

Overrides:

getFileName in class StepWithMappingMeta

Returns:

the fileName

getResourceDependencies

public List<ResourceReference> getResourceDependencies(TransMeta transMeta,
                                                       StepMeta stepInfo)

Description copied from class: BaseStepMeta

Get a list of all the resource dependencies that the step is depending on.

Specified by:

getResourceDependencies in interface StepMetaInterface

Overrides:

getResourceDependencies in class BaseStepMeta

Returns:

a list of all the resource dependencies that the step is depending on

getReferencedObjectDescriptions

public String[] getReferencedObjectDescriptions()

Specified by:

getReferencedObjectDescriptions in interface StepMetaInterface

Overrides:

getReferencedObjectDescriptions in class BaseStepMeta

Returns:

The objects referenced in the step, like a mapping, a transformation, a job, ...

isReferencedObjectEnabled

public boolean[] isReferencedObjectEnabled()

Specified by:

isReferencedObjectEnabled in interface StepMetaInterface

Overrides:

isReferencedObjectEnabled in class BaseStepMeta

Returns:

true for each referenced object that is enabled or has a valid reference definition.

loadReferencedObject

public Object loadReferencedObject(int index,
                                   Repository rep,
                                   org.pentaho.metastore.api.IMetaStore metaStore,
                                   org.pentaho.di.core.variables.VariableSpace space)
                            throws org.pentaho.di.core.exception.KettleException

Description copied from interface: StepMetaInterface

Load the referenced object

Specified by:

loadReferencedObject in interface StepMetaInterface

Overrides:

loadReferencedObject in class BaseStepMeta

Parameters:

index - the referenced object index to load (in case there are multiple references)

rep - the repository

metaStore - the MetaStore to use

space - the variable space to use

Returns:

the referenced object once loaded

Throws:

org.pentaho.di.core.exception.KettleException

getRowMeta

public abstract org.pentaho.di.core.row.RowMeta getRowMeta(String origin,
                                                           org.pentaho.di.core.variables.VariableSpace space)
                                                    throws org.pentaho.di.core.exception.KettleStepException

Throws:

org.pentaho.di.core.exception.KettleStepException

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