Package org.pentaho.di.trans.steps.propertyoutput

Class PropertyOutputMeta

java.lang.Object
org.pentaho.di.trans.step.BaseStepMeta
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

  • Constructor Details

    • PropertyOutputMeta

      public PropertyOutputMeta()

  • Method Details

    • loadXML

      public void loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.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:
      org.pentaho.di.core.exception.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

      @Deprecated public boolean addToResult()
      Deprecated.
      use isAddToResult()
      Returns:
      Returns the Add to result filesname flag.

    • isAddToResult

      public boolean isAddToResult()

    • 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(org.pentaho.di.core.variables.VariableSpace space)

    • buildFilename

      public String buildFilename(org.pentaho.di.core.variables.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, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases) throws org.pentaho.di.core.exception.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:
      org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

    • saveRep

      public void saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step) throws org.pentaho.di.core.exception.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:
      org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

    • check

      public void check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info, org.pentaho.di.core.variables.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

    • 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(org.pentaho.di.core.variables.VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.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:
      org.pentaho.di.core.exception.KettleException