org.pentaho.di.trans.steps.yamlinput

Class YamlInputMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.yamlinput.YamlInputMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class YamlInputMeta
extends BaseStepMeta
implements StepMetaInterface

Store run-time data on the YamlInput step.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	RequiredFilesCode
static String[]	RequiredFilesDesc

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
YamlInputMeta()

Method Summary

Modifier and Type	Method and Description
boolean	addResultFile()
void	allocate(int nrfiles, 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	exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Since the exported transformation that runs this will reside in a ZIP file, we can't reference files relatively.
String	getEncoding()
void	getFields(RowMetaInterface r, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Gets the fields.
String[]	getFileMask()
String[]	getFileName()
String	getFilenameField()
String[]	getFileRequired()
FileInputList	getFiles(VariableSpace space)
String[]	getIncludeSubFolders()
YamlInputField[]	getInputFields()
boolean	getIsAFile()
String	getRequiredFilesCode(String tt)
String	getRequiredFilesDesc(String tt)
long	getRowLimit()
String	getRowNumberField()
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.
String	getXML() Produces the XML string that describes this step's information.
String	getYamlField() Get XML field.
boolean	includeFilename()
boolean	includeRowNumber()
boolean	isdoNotFailIfNoFile()
boolean	isIgnoreEmptyFile()
boolean	isInFields() Get the IsInFields.
boolean	isValidating()
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	setAddResultFile(boolean addResultFile)
void	setDefault() Set default values
void	setdoNotFailIfNoFile(boolean doNotFailIfNoFile)
void	setEncoding(String encoding)
void	setFileMask(String[] fileMask)
void	setFileName(String[] fileName)
void	setFilenameField(String filenameField)
void	setFileRequired(String[] fileRequiredin)
void	setIgnoreEmptyFile(boolean IsIgnoreEmptyFile)
void	setIncludeFilename(boolean includeFilename)
void	setIncludeRowNumber(boolean includeRowNumber)
void	setIncludeSubFolders(String[] includeSubFoldersin)
void	setInFields(boolean inFields)
void	setInputFields(YamlInputField[] inputFields)
void	setIsAFile(boolean IsAFile)
void	setRowLimit(long rowLimit)
void	setRowNumberField(String rowNumberField)
void	setValidating(boolean validating)
void	setYamlField(String yamlField) Set XML field.
boolean	supportsErrorHandling()

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

analyseImpact, analyseImpact, cancelQueries, check, check, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, 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

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

Field Detail

RequiredFilesDesc

public static final String[] RequiredFilesDesc

RequiredFilesCode

public static final String[] RequiredFilesCode

Constructor Detail

YamlInputMeta

public YamlInputMeta()

Method Detail

addResultFile

public boolean addResultFile()

Returns:

the add result filesname flag

isValidating

public boolean isValidating()

Returns:

the validating flag

setValidating

public void setValidating(boolean validating)

Parameters:

validating - the validating flag to set

setAddResultFile

public void setAddResultFile(boolean addResultFile)

getInputFields

public YamlInputField[] getInputFields()

Returns:

Returns the input fields.

setInputFields

public void setInputFields(YamlInputField[] inputFields)

Parameters:

inputFields - The input fields to set.

getYamlField

public String getYamlField()

Get XML field.

setYamlField

public void setYamlField(String yamlField)

Set XML field.

isInFields

public boolean isInFields()

Get the IsInFields.

setInFields

public void setInFields(boolean inFields)

Parameters:

inFields - set the inFields.

getFileMask

public String[] getFileMask()

Returns:

Returns the fileMask.

setFileMask

public void setFileMask(String[] fileMask)

Parameters:

fileMask - The fileMask to set.

getFileRequired

public String[] getFileRequired()

setFileRequired

public void setFileRequired(String[] fileRequiredin)

setIncludeSubFolders

public void setIncludeSubFolders(String[] includeSubFoldersin)

getFileName

public String[] getFileName()

Returns:

Returns the fileName.

setFileName

public void setFileName(String[] fileName)

Parameters:

fileName - The fileName to set.

getFilenameField

public String getFilenameField()

Returns:

Returns the filenameField.

setFilenameField

public void setFilenameField(String filenameField)

Parameters:

filenameField - The filenameField to set.

includeFilename

public boolean includeFilename()

Returns:

Returns the includeFilename.

setIncludeFilename

public void setIncludeFilename(boolean includeFilename)

Parameters:

includeFilename - The includeFilename to set.

includeRowNumber

public boolean includeRowNumber()

Returns:

Returns the includeRowNumber.

setIncludeRowNumber

public void setIncludeRowNumber(boolean includeRowNumber)

Parameters:

includeRowNumber - The includeRowNumber to set.

getRowLimit

public long getRowLimit()

Returns:

Returns the rowLimit.

setRowLimit

public void setRowLimit(long rowLimit)

Parameters:

rowLimit - The rowLimit to set.

isIgnoreEmptyFile

public boolean isIgnoreEmptyFile()

Returns:

the IsIgnoreEmptyFile flag

setIgnoreEmptyFile

public void setIgnoreEmptyFile(boolean IsIgnoreEmptyFile)

Parameters:

IsIgnoreEmptyFile - the IsIgnoreEmptyFile to set

isdoNotFailIfNoFile

public boolean isdoNotFailIfNoFile()

Returns:

the doNotFailIfNoFile flag

setdoNotFailIfNoFile

public void setdoNotFailIfNoFile(boolean doNotFailIfNoFile)

Parameters:

doNotFailIfNoFile - the doNotFailIfNoFile to set

getRowNumberField

public String getRowNumberField()

Returns:

Returns the rowNumberField.

setRowNumberField

public void setRowNumberField(String rowNumberField)

Parameters:

rowNumberField - The rowNumberField to set.

getEncoding

public String getEncoding()

Returns:

the encoding

setEncoding

public void setEncoding(String encoding)

Parameters:

encoding - the encoding to set

getIsAFile

public boolean getIsAFile()

setIsAFile

public void setIsAFile(boolean IsAFile)

getIncludeSubFolders

public String[] getIncludeSubFolders()

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

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.

getRequiredFilesDesc

public String getRequiredFilesDesc(String tt)

getRequiredFilesCode

public String getRequiredFilesCode(String tt)

allocate

public void allocate(int nrfiles,
                     int nrfields)

setDefault

public void setDefault()

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

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

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)

getFiles

public FileInputList getFiles(VariableSpace space)

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

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.

exportResources

public String exportResources(VariableSpace space,
                              Map<String,ResourceDefinition> definitions,
                              ResourceNamingInterface resourceNamingInterface,
                              Repository repository,
                              org.pentaho.metastore.api.IMetaStore metaStore)
                       throws KettleException

Since the exported transformation that runs this will reside in a ZIP file, we can't reference files relatively. So what this does is turn the name of files into absolute paths OR it simply includes the resource in the ZIP file. For now, we'll simply turn it into an absolute path and pray that the file is on a shared drive or something like that.

Specified by:

exportResources in interface StepMetaInterface

Overrides:

exportResources in class BaseStepMeta

Parameters:

space - the variable space to use

definitions -

resourceNamingInterface -

repository - The repository to optionally load other resources from (to be converted to XML)

metaStore - the metaStore in which non-kettle metadata could reside.

Returns:

the filename of the exported resource

Throws:

KettleException