org.pentaho.di.trans.steps.fixedinput
Class FixedInputMeta

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

public class FixedInputMeta
extends BaseStepMeta
implements StepMetaInterface

Since:
2007-07-05
Version:
3.0
Author:
matt

Field Summary
static int FILE_TYPE_DOS
           
static int FILE_TYPE_NONE
           
static int FILE_TYPE_UNIX
           
static String[] fileTypeCode
           
static String[] fileTypeDesc
           
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
FixedInputMeta()
           
 
Method Summary
 void allocate(int nrFields)
           
 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 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 getBufferSize()
           
 String getEncoding()
           
 FixedFileInputField[] getFieldDefinition()
           
 void getFields(RowMetaInterface rowMeta, String origin, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Gets the fields.
 String getFilename()
           
 int getFileType()
           
static int getFileType(String fileTypeCode)
           
 String getFileTypeCode()
           
static String getFileTypeCode(int fileType)
           
 String getFileTypeDesc()
           
static String getFileTypeDesc(int fileType)
           
 int getLineSeparatorLength()
           
 String getLineWidth()
           
 List<ResourceReference> getResourceDependencies(TransMeta transMeta, StepMeta stepInfo)
          Get a list of all the resource dependencies that the step is depending on.
 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.
 StepMetaInjectionInterface getStepMetaInjectionInterface()
           
 String getXML()
          Produces the XML string that describes this step's information.
 boolean isAddResultFile()
           
 boolean isHeaderPresent()
           
 boolean isLazyConversionActive()
           
 boolean isLineFeedPresent()
           
 boolean isRunningInParallel()
           
 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 isaddresult)
           
 void setBufferSize(String bufferSize)
           
 void setDefault()
          Set default values
 void setEncoding(String encoding)
           
 void setFieldDefinition(FixedFileInputField[] fieldDefinition)
           
 void setFilename(String filename)
           
 void setFileType(int fileType)
           
 void setHeaderPresent(boolean headerPresent)
           
 void setLazyConversionActive(boolean lazyConversionActive)
           
 void setLineFeedPresent(boolean lineFeedPresent)
           
 void setLineWidth(String lineWidth)
           
 void setRunningInParallel(boolean runningInParallel)
           
 
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, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, 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, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getSQLStatements, getStepIOMeta, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta, supportsErrorHandling
 

Field Detail

FILE_TYPE_NONE

public static final int FILE_TYPE_NONE
See Also:
Constant Field Values

FILE_TYPE_UNIX

public static final int FILE_TYPE_UNIX
See Also:
Constant Field Values

FILE_TYPE_DOS

public static final int FILE_TYPE_DOS
See Also:
Constant Field Values

fileTypeCode

public static final String[] fileTypeCode

fileTypeDesc

public static final String[] fileTypeDesc
Constructor Detail

FixedInputMeta

public FixedInputMeta()
Method Detail

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

allocate

public void allocate(int nrFields)

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)

getFields

public void getFields(RowMetaInterface rowMeta,
                      String origin,
                      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:
rowMeta - the input row meta
origin - the name
info - the info
nextStep - the next step
space - the space
Throws:
KettleStepException - the kettle step exception

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

getFilename

public String getFilename()
Returns:
the filename

setFilename

public void setFilename(String filename)
Parameters:
filename - the filename to set

getBufferSize

public String getBufferSize()
Returns:
the bufferSize

setBufferSize

public void setBufferSize(String bufferSize)
Parameters:
bufferSize - the bufferSize to set

isLazyConversionActive

public boolean isLazyConversionActive()
Returns:
true if lazy conversion is turned on: conversions are delayed as long as possible, perhaps to never occur at all.

setLazyConversionActive

public void setLazyConversionActive(boolean lazyConversionActive)
Parameters:
lazyConversionActive - true if lazy conversion is to be turned on: conversions are delayed as long as possible, perhaps to never occur at all.

isHeaderPresent

public boolean isHeaderPresent()
Returns:
the headerPresent

setHeaderPresent

public void setHeaderPresent(boolean headerPresent)
Parameters:
headerPresent - the headerPresent to set

getLineWidth

public String getLineWidth()
Returns:
the lineWidth

isLineFeedPresent

public boolean isLineFeedPresent()
Returns:
the lineFeedPresent

setLineWidth

public void setLineWidth(String lineWidth)
Parameters:
lineWidth - the lineWidth to set

setLineFeedPresent

public void setLineFeedPresent(boolean lineFeedPresent)
Parameters:
lineFeedPresent - the lineFeedPresent to set

isRunningInParallel

public boolean isRunningInParallel()
Returns:
the runningInParallel

setRunningInParallel

public void setRunningInParallel(boolean runningInParallel)
Parameters:
runningInParallel - the runningInParallel to set

getFieldDefinition

public FixedFileInputField[] getFieldDefinition()
Returns:
the fieldDefinition

setFieldDefinition

public void setFieldDefinition(FixedFileInputField[] fieldDefinition)
Parameters:
fieldDefinition - the fieldDefinition to set

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

getFileType

public int getFileType()
Returns:
the fileType

setFileType

public void setFileType(int fileType)
Parameters:
fileType - the fileType to set

getFileTypeCode

public static final String getFileTypeCode(int fileType)

getFileTypeDesc

public static final String getFileTypeDesc(int fileType)

getFileTypeCode

public String getFileTypeCode()

getFileTypeDesc

public String getFileTypeDesc()

getFileType

public static final int getFileType(String fileTypeCode)

getLineSeparatorLength

public int getLineSeparatorLength()

getEncoding

public String getEncoding()
Returns:
the encoding

setEncoding

public void setEncoding(String encoding)
Parameters:
encoding - the encoding to set

setAddResultFile

public void setAddResultFile(boolean isaddresult)
Parameters:
isaddresult - The isaddresult to set.

isAddResultFile

public boolean isAddResultFile()
Returns:
Returns isaddresult.

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

getStepMetaInjectionInterface

public StepMetaInjectionInterface getStepMetaInjectionInterface()
Specified by:
getStepMetaInjectionInterface in interface StepMetaInterface
Overrides:
getStepMetaInjectionInterface in class BaseStepMeta
Returns:
Optional interface that allows an external program to inject step metadata in a standardized fasion. This method will return null if the interface is not available for this step.