org.pentaho.di.trans.steps.propertyoutput
Class PropertyOutputMeta

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

public class PropertyOutputMeta
extends BaseStepMeta
implements StepMetaInterface

Output rows to Properties file and create a file.

Since:
13-Apr-2008
Author:
Samatar

Field Summary
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
PropertyOutputMeta()
           
 
Method Summary
 boolean addToResult()
           
 String buildFilename(VariableSpace space, int stepnr)
           
 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 getComment()
           
 String getExtension()
           
 String getFileName()
           
 String getFileNameField()
           
 String[] getFiles(VariableSpace space)
           
 String getKeyField()
           
 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 getValueField()
           
 String getXML()
          Produces the XML string that describes this step's information.
 boolean isAppend()
           
 boolean isCreateParentFolder()
           
 boolean isDateInFilename()
           
 boolean isFileNameInField()
           
 boolean isStepNrInFilename()
           
 boolean isTimeInFilename()
           
 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 setAddToResult(boolean addToResult)
           
 void setAppend(boolean append)
           
 void setComment(String commentin)
           
 void setCreateParentFolder(boolean createparentfolder)
           
 void setDateInFilename(boolean dateInFilename)
           
 void setDefault()
          Set default values
 void setExtension(String extension)
           
 void setFileName(String fileName)
           
 void setFileNameField(String fileNameField)
           
 void setFileNameInField(boolean fileNameInField)
           
 void setKeyField(String KeyField)
           
 void setStepNrInFilename(boolean stepNrInFilename)
           
 void setTimeInFilename(boolean timeInFilename)
           
 void setValueField(String valuefield)
           
 boolean supportsErrorHandling()
           
 
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, findAttribute, findParent, getDescription, getDialogClassName, getFields, 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
 
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, getFields, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta
 

Constructor Detail

PropertyOutputMeta

public PropertyOutputMeta()
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

getExtension

public String getExtension()
Returns:
Returns the extension.

setExtension

public void setExtension(String extension)
Parameters:
extension - The extension to set.

getFileName

public String getFileName()
Returns:
Returns the fileName.

isFileNameInField

public boolean isFileNameInField()
Returns:
Is the file name coded in a field?

setFileNameInField

public void setFileNameInField(boolean fileNameInField)
Parameters:
fileNameInField - Is the file name coded in a field?

getFileNameField

public String getFileNameField()
Returns:
The field name that contains the output file name.

setFileNameField

public void setFileNameField(String fileNameField)
Parameters:
fileNameField - Name of the field that contains the file name

isStepNrInFilename

public boolean isStepNrInFilename()
Returns:
Returns the stepNrInFilename.

setStepNrInFilename

public void setStepNrInFilename(boolean stepNrInFilename)
Parameters:
stepNrInFilename - The stepNrInFilename to set.

isTimeInFilename

public boolean isTimeInFilename()
Returns:
Returns the timeInFilename.

isDateInFilename

public boolean isDateInFilename()
Returns:
Returns the dateInFilename.

setDateInFilename

public void setDateInFilename(boolean dateInFilename)
Parameters:
dateInFilename - The dateInFilename to set.

setTimeInFilename

public void setTimeInFilename(boolean timeInFilename)
Parameters:
timeInFilename - The timeInFilename to set.

setFileName

public void setFileName(String fileName)
Parameters:
fileName - The fileName to set.

addToResult

public boolean addToResult()
Returns:
Returns the Add to result filesname flag.

setAddToResult

public void setAddToResult(boolean addToResult)
Parameters:
addToResult - The Add file to result to set.

isCreateParentFolder

public boolean isCreateParentFolder()
Returns:
Returns the create parent folder flag.

setCreateParentFolder

public void setCreateParentFolder(boolean createparentfolder)
Parameters:
createparentfolder - The create parent folder flag to set.

isAppend

public boolean isAppend()
Returns:
Returns the append flag.

setAppend

public void setAppend(boolean append)
Parameters:
append - The append to set.

getComment

public String getComment()

setComment

public void setComment(String commentin)

getFiles

public String[] getFiles(VariableSpace space)

buildFilename

public String buildFilename(VariableSpace space,
                            int stepnr)

setDefault

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

Specified by:
setDefault in interface StepMetaInterface

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

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.

getKeyField

public String getKeyField()
Returns:
the keyfield

getValueField

public String getValueField()
Returns:
the valuefield

setKeyField

public void setKeyField(String KeyField)
Parameters:
KeyField - the keyfield to set

setValueField

public void setValueField(String valuefield)
Parameters:
valuefield - the valuefield to set

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

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)
                       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 variable space to use
repository - The repository to optionally load other resources from (to be converted to XML)
Returns:
the filename of the exported resource
Throws:
KettleException