org.pentaho.di.trans.steps.xbaseinput
Class XBaseInputMeta

java.lang.Object
  extended by org.pentaho.di.trans.step.BaseStepMeta
      extended by org.pentaho.di.trans.steps.xbaseinput.XBaseInputMeta
All Implemented Interfaces:
Cloneable, StepAttributesInterface, StepMetaInterface

public class XBaseInputMeta
extends BaseStepMeta
implements StepMetaInterface


Field Summary
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
XBaseInputMeta()
           
 
Method Summary
 void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, 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 exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository)
          Since the exported transformation that runs this will reside in a ZIP file, we can't reference files relatively.
 String getAcceptingField()
           
 StepMeta getAcceptingStep()
           
 String getAcceptingStepName()
           
 String getCharactersetName()
           
 String getDbfFileName()
           
 void getFields(RowMetaInterface row, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Gets the fields.
 String getFilenameField()
           
 String[] getFilePaths(VariableSpace space)
           
 String[] getInfoSteps()
           
 String getLookupStepname()
           
 RowMetaInterface getOutputFields(FileInputList files, String name)
           
 int getRowLimit()
           
 String getRowNrField()
           
 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.
 FileInputList getTextFileList(VariableSpace space)
           
 String[] getUsedLibraries()
           
 String getXML()
          Produces the XML string that describes this step's information.
 boolean includeFilename()
           
 boolean isAcceptingFilenames()
           
 boolean isRowNrAdded()
           
 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 searchInfoAndTargetSteps(List<StepMeta> steps)
          Change step names into step objects to allow them to be name-changed etc.
 void setAcceptingField(String acceptingField)
           
 void setAcceptingFilenames(boolean acceptingFilenames)
           
 void setAcceptingStep(StepMeta acceptingStep)
           
 void setAcceptingStepName(String acceptingStepName)
           
 void setCharactersetName(String charactersetName)
           
 void setDbfFileName(String dbfFileName)
           
 void setDefault()
          Set default values
 void setFilenameField(String filenameField)
           
 void setIncludeFilename(boolean includeFilename)
           
 void setRowLimit(int rowLimit)
           
 void setRowNrAdded(boolean rowNrAdded)
           
 void setRowNrField(String rowNrField)
           
 
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, 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, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isRowLevel, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, resetStepIoMeta, 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, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, setParentStepMeta, supportsErrorHandling
 

Constructor Detail

XBaseInputMeta

public XBaseInputMeta()
Method Detail

getDbfFileName

public String getDbfFileName()
Returns:
Returns the dbfFileName.

setDbfFileName

public void setDbfFileName(String dbfFileName)
Parameters:
dbfFileName - The dbfFileName to set.

getRowLimit

public int getRowLimit()
Returns:
Returns the rowLimit.

setRowLimit

public void setRowLimit(int rowLimit)
Parameters:
rowLimit - The rowLimit to set.

getRowNrField

public String getRowNrField()
Returns:
Returns the rowNrField.

setRowNrField

public void setRowNrField(String rowNrField)
Parameters:
rowNrField - The rowNrField to set.

isRowNrAdded

public boolean isRowNrAdded()
Returns:
Returns the rowNrAdded.

setRowNrAdded

public void setRowNrAdded(boolean rowNrAdded)
Parameters:
rowNrAdded - The rowNrAdded to set.

getAcceptingField

public String getAcceptingField()
Returns:
Returns the acceptingField.

setAcceptingField

public void setAcceptingField(String acceptingField)
Parameters:
acceptingField - The acceptingField to set.

isAcceptingFilenames

public boolean isAcceptingFilenames()
Returns:
Returns the acceptingFilenames.

setAcceptingFilenames

public void setAcceptingFilenames(boolean acceptingFilenames)
Parameters:
acceptingFilenames - The acceptingFilenames to set.

getAcceptingStep

public StepMeta getAcceptingStep()
Returns:
Returns the acceptingStep.

setAcceptingStep

public void setAcceptingStep(StepMeta acceptingStep)
Parameters:
acceptingStep - The acceptingStep to set.

getAcceptingStepName

public String getAcceptingStepName()
Returns:
Returns the acceptingStepName.

setAcceptingStepName

public void setAcceptingStepName(String acceptingStepName)
Parameters:
acceptingStepName - The acceptingStepName 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.

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

setDefault

public void setDefault()
Description copied from interface: StepMetaInterface
Set default values

Specified by:
setDefault in interface StepMetaInterface

getLookupStepname

public String getLookupStepname()

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

getInfoSteps

public String[] getInfoSteps()

getOutputFields

public RowMetaInterface getOutputFields(FileInputList files,
                                        String name)
                                 throws KettleStepException
Throws:
KettleStepException

getFields

public void getFields(RowMetaInterface row,
                      String name,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)
               throws KettleStepException
Description copied from class: BaseStepMeta
Gets the fields.

Specified by:
getFields in interface StepMetaInterface
Overrides:
getFields in class BaseStepMeta
Parameters:
row - the input row meta
name - the name
info - the info
nextStep - the next step
space - the space
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,
                    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 stepMeta,
                  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
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

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.

getFilePaths

public String[] getFilePaths(VariableSpace space)

getTextFileList

public FileInputList getTextFileList(VariableSpace space)

getUsedLibraries

public String[] getUsedLibraries()
Specified by:
getUsedLibraries in interface StepMetaInterface
Overrides:
getUsedLibraries in class BaseStepMeta
Returns:
the libraries that this step or plug-in uses.

getCharactersetName

public String getCharactersetName()
Returns:
the charactersetName

setCharactersetName

public void setCharactersetName(String charactersetName)
Parameters:
charactersetName - the charactersetName to set

exportResources

public String exportResources(VariableSpace space,
                              Map<String,ResourceDefinition> definitions,
                              ResourceNamingInterface resourceNamingInterface,
                              Repository repository)
                       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. TODO: create options to configure this behavior

Specified by:
exportResources in interface StepMetaInterface
Overrides:
exportResources in class BaseStepMeta
Parameters:
space - the space
definitions - the definitions
resourceNamingInterface - the resource naming interface
repository - the repository
Returns:
the string
Throws:
KettleException - the kettle exception