org.pentaho.di.trans.steps.xmlinputstream
Class XMLInputStreamMeta

java.lang.Object
  org.pentaho.di.trans.step.BaseStepMeta
      org.pentaho.di.trans.steps.xmlinputstream.XMLInputStreamMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class XMLInputStreamMeta
extends BaseStepMeta
implements StepMetaInterface

Since:

2011-01-13

Author:

Jens Bleuel

Field Summary

static String	DEFAULT_ENCODING
static String	DEFAULT_STRING_LEN

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

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

XMLInputStreamMeta()

Method Summary

void	check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepinfo, 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.
String	getDefaultStringLen()
String	getEncoding()
void	getFields(RowMetaInterface r, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) Get the fields that are emitted by this step
String	getFilename()
String	getFilenameField()
String	getNrRowsToSkip()
String	getRowLimit()
String	getRowNumberField()
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.
String	getXmlDataNameField()
String	getXmlDataTypeDescriptionField()
String	getXmlDataTypeNumericField()
String	getXmlDataValueField()
String	getXmlElementIDField()
String	getXmlElementLevelField()
String	getXmlLocationColumnField()
String	getXmlLocationLineField()
String	getXmlParentElementIDField()
String	getXmlParentPathField()
String	getXmlPathField()
boolean	isAddResultFile()
boolean	isEnableNamespaces()
boolean	isEnableTrim()
boolean	isIncludeFilenameField()
boolean	isIncludeRowNumberField()
boolean	isIncludeXmlDataNameField()
boolean	isIncludeXmlDataTypeDescriptionField()
boolean	isIncludeXmlDataTypeNumericField()
boolean	isIncludeXmlDataValueField()
boolean	isIncludeXmlElementIDField()
boolean	isIncludeXmlElementLevelField()
boolean	isIncludeXmlLocationColumnField()
boolean	isIncludeXmlLocationLineField()
boolean	isIncludeXmlParentElementIDField()
boolean	isIncludeXmlParentPathField()
boolean	isIncludeXmlPathField()
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	setAddResultFile(boolean addResultFile)
void	setDefault() Set default values
void	setDefaultStringLen(String defaultStringLen)
void	setEnableNamespaces(boolean enableNamespaces)
void	setEnableTrim(boolean enableTrim)
void	setEncoding(String encoding)
void	setFilename(String filename)
void	setFilenameField(String filenameField)
void	setIncludeFilenameField(boolean includeFilenameField)
void	setIncludeRowNumberField(boolean includeRowNumberField)
void	setIncludeXmlDataNameField(boolean includeXmlDataNameField)
void	setIncludeXmlDataTypeDescriptionField(boolean includeXmlDataTypeDescriptionField)
void	setIncludeXmlDataTypeNumericField(boolean includeXmlDataTypeNumericField)
void	setIncludeXmlDataValueField(boolean includeXmlDataValueField)
void	setIncludeXmlElementIDField(boolean includeXmlElementIDField)
void	setIncludeXmlElementLevelField(boolean includeXmlElementLevelField)
void	setIncludeXmlLocationColumnField(boolean includeXmlLocationColumnField)
void	setIncludeXmlLocationLineField(boolean includeXmlLocationLineField)
void	setIncludeXmlParentElementIDField(boolean includeXmlParentElementIDField)
void	setIncludeXmlParentPathField(boolean includeXmlParentPathField)
void	setIncludeXmlPathField(boolean includeXmlPathField)
void	setNrRowsToSkip(String nrRowsToSkip)
void	setRowLimit(String rowLimit)
void	setRowNumberField(String rowNumberField)
void	setXmlDataNameField(String xmlDataNameField)
void	setXmlDataTypeDescriptionField(String xmlDataTypeDescriptionField)
void	setXmlDataTypeNumericField(String xmlDataTypeNumericField)
void	setXmlDataValueField(String xmlDataValueField)
void	setXmlElementIDField(String xmlElementIDField)
void	setXmlElementLevelField(String xmlElementLevelField)
void	setXmlLocationColumnField(String xmlLocationColumnField)
void	setXmlLocationLineField(String xmlLocationLineField)
void	setXmlParentElementIDField(String xmlParentElementIDField)
void	setXmlParentPathField(String xmlParentPathField)
void	setXmlPathField(String xmlPathField)

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, getStepMetaInjectionInterface, 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, 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, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta, supportsErrorHandling

Field Detail

DEFAULT_STRING_LEN

public static final String DEFAULT_STRING_LEN

See Also:

Constant Field Values

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

See Also:

Constant Field Values

Constructor Detail

XMLInputStreamMeta

public XMLInputStreamMeta()

Method Detail

getFields

public void getFields(RowMetaInterface r,
                      String name,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)

Description copied from interface: StepMetaInterface

Get the fields that are emitted by this step

Specified by:

getFields in interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

r - The fields that are entering the step. These are changed to reflect the output metadata.

name - The name of the step to be used as origin

info - The input rows metadata that enters the step through the specified channels in the same order as in method getInfoSteps(). The step metadata can then choose what to do with it: ignore it or not. Interesting is also that in case of database lookups, the layout of the target database table is put in info[0]

nextStep - if this is a non-null value, it's the next step in the transformation. The one who's asking, the step where the data is targetted towards.

space - TODO

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

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

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

getFilename

public String getFilename()

setFilename

public void setFilename(String filename)

isAddResultFile

public boolean isAddResultFile()

setAddResultFile

public void setAddResultFile(boolean addResultFile)

getNrRowsToSkip

public String getNrRowsToSkip()

setNrRowsToSkip

public void setNrRowsToSkip(String nrRowsToSkip)

getRowLimit

public String getRowLimit()

setRowLimit

public void setRowLimit(String rowLimit)

getDefaultStringLen

public String getDefaultStringLen()

setDefaultStringLen

public void setDefaultStringLen(String defaultStringLen)

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

isEnableNamespaces

public boolean isEnableNamespaces()

setEnableNamespaces

public void setEnableNamespaces(boolean enableNamespaces)

isEnableTrim

public boolean isEnableTrim()

setEnableTrim

public void setEnableTrim(boolean enableTrim)

isIncludeFilenameField

public boolean isIncludeFilenameField()

setIncludeFilenameField

public void setIncludeFilenameField(boolean includeFilenameField)

getFilenameField

public String getFilenameField()

setFilenameField

public void setFilenameField(String filenameField)

isIncludeRowNumberField

public boolean isIncludeRowNumberField()

setIncludeRowNumberField

public void setIncludeRowNumberField(boolean includeRowNumberField)

getRowNumberField

public String getRowNumberField()

setRowNumberField

public void setRowNumberField(String rowNumberField)

isIncludeXmlDataTypeNumericField

public boolean isIncludeXmlDataTypeNumericField()

setIncludeXmlDataTypeNumericField

public void setIncludeXmlDataTypeNumericField(boolean includeXmlDataTypeNumericField)

getXmlDataTypeNumericField

public String getXmlDataTypeNumericField()

setXmlDataTypeNumericField

public void setXmlDataTypeNumericField(String xmlDataTypeNumericField)

isIncludeXmlDataTypeDescriptionField

public boolean isIncludeXmlDataTypeDescriptionField()

setIncludeXmlDataTypeDescriptionField

public void setIncludeXmlDataTypeDescriptionField(boolean includeXmlDataTypeDescriptionField)

getXmlDataTypeDescriptionField

public String getXmlDataTypeDescriptionField()

setXmlDataTypeDescriptionField

public void setXmlDataTypeDescriptionField(String xmlDataTypeDescriptionField)

isIncludeXmlLocationLineField

public boolean isIncludeXmlLocationLineField()

setIncludeXmlLocationLineField

public void setIncludeXmlLocationLineField(boolean includeXmlLocationLineField)

getXmlLocationLineField

public String getXmlLocationLineField()

setXmlLocationLineField

public void setXmlLocationLineField(String xmlLocationLineField)

isIncludeXmlLocationColumnField

public boolean isIncludeXmlLocationColumnField()

setIncludeXmlLocationColumnField

public void setIncludeXmlLocationColumnField(boolean includeXmlLocationColumnField)

getXmlLocationColumnField

public String getXmlLocationColumnField()

setXmlLocationColumnField

public void setXmlLocationColumnField(String xmlLocationColumnField)

isIncludeXmlElementIDField

public boolean isIncludeXmlElementIDField()

setIncludeXmlElementIDField

public void setIncludeXmlElementIDField(boolean includeXmlElementIDField)

getXmlElementIDField

public String getXmlElementIDField()

setXmlElementIDField

public void setXmlElementIDField(String xmlElementIDField)

isIncludeXmlParentElementIDField

public boolean isIncludeXmlParentElementIDField()

setIncludeXmlParentElementIDField

public void setIncludeXmlParentElementIDField(boolean includeXmlParentElementIDField)

getXmlParentElementIDField

public String getXmlParentElementIDField()

setXmlParentElementIDField

public void setXmlParentElementIDField(String xmlParentElementIDField)

isIncludeXmlElementLevelField

public boolean isIncludeXmlElementLevelField()

setIncludeXmlElementLevelField

public void setIncludeXmlElementLevelField(boolean includeXmlElementLevelField)

getXmlElementLevelField

public String getXmlElementLevelField()

setXmlElementLevelField

public void setXmlElementLevelField(String xmlElementLevelField)

isIncludeXmlPathField

public boolean isIncludeXmlPathField()

setIncludeXmlPathField

public void setIncludeXmlPathField(boolean includeXmlPathField)

getXmlPathField

public String getXmlPathField()

setXmlPathField

public void setXmlPathField(String xmlPathField)

isIncludeXmlParentPathField

public boolean isIncludeXmlParentPathField()

setIncludeXmlParentPathField

public void setIncludeXmlParentPathField(boolean includeXmlParentPathField)

getXmlParentPathField

public String getXmlParentPathField()

setXmlParentPathField

public void setXmlParentPathField(String xmlParentPathField)

isIncludeXmlDataNameField

public boolean isIncludeXmlDataNameField()

setIncludeXmlDataNameField

public void setIncludeXmlDataNameField(boolean includeXmlDataNameField)

getXmlDataNameField

public String getXmlDataNameField()

setXmlDataNameField

public void setXmlDataNameField(String xmlDataNameField)

isIncludeXmlDataValueField

public boolean isIncludeXmlDataValueField()

setIncludeXmlDataValueField

public void setIncludeXmlDataValueField(boolean includeXmlDataValueField)

getXmlDataValueField

public String getXmlDataValueField()

setXmlDataValueField

public void setXmlDataValueField(String xmlDataValueField)