org.pentaho.di.trans.steps.autodoc
Class AutoDocMeta

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

@Step(id="AutoDoc",
      name="AutoDoc.Step.Name",
      description="AutoDoc.Step.Description",
      i18nPackageName="org.pentaho.di.autodoc",
      image="org/pentaho/di/autodoc/autodoc.png",
      categoryDescription="Autodoc.Category.PDI-EE")
public class AutoDocMeta
extends BaseStepMeta
implements StepMetaInterface, AutoDocOptionsInterface

Since:
2009-12-01
Version:
4
Author:
matt

Field Summary
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
AutoDocMeta()
           
 
Method Summary
 void allocate()
           
 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.
 void getFields(RowMetaInterface rowMeta, String origin, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Get the fields that are emitted by this step
 String getFilenameField()
           
 String getFileTypeField()
           
 KettleReportBuilder.OutputType getOutputType()
           
 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 getTargetFilename()
           
 String getXML()
          Produces the XML string that describes this step's information.
 boolean isIncludingCreated()
           
 boolean isIncludingDescription()
           
 boolean isIncludingExtendedDescription()
           
 boolean isIncludingImage()
           
 boolean isIncludingLastExecutionResult()
           
 boolean isIncludingLoggingConfiguration()
           
 boolean isIncludingModified()
           
 boolean isIncludingName()
           
 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 setDefault()
          Set default values
 void setFilenameField(String filenameField)
           
 void setFileTypeField(String fileTypeField)
           
 void setIncludingCreated(boolean includingCreated)
           
 void setIncludingDescription(boolean includingDescription)
           
 void setIncludingExtendedDescription(boolean includingExtendedDescription)
           
 void setIncludingImage(boolean includingImage)
           
 void setIncludingLastExecutionResult(boolean includingLastExecutionResult)
           
 void setIncludingLoggingConfiguration(boolean includingLoggingConfiguration)
           
 void setIncludingModified(boolean includingModified)
           
 void setIncludingName(boolean includingName)
           
 void setOutputType(KettleReportBuilder.OutputType outputType)
           
 void setTargetFilename(String targetFilename)
           
 
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
 

Constructor Detail

AutoDocMeta

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

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 interface: StepMetaInterface
Get the fields that are emitted by this step

Specified by:
getFields in interface StepMetaInterface
Overrides:
getFields in class BaseStepMeta
Parameters:
rowMeta - The fields that are entering the step. These are changed to reflect the output metadata.
origin - 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
Throws:
KettleStepException - when an error occurred searching for the fields.

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.

getFilenameField

public String getFilenameField()
Returns:
the filenameField

setFilenameField

public void setFilenameField(String filenameField)
Parameters:
filenameField - the filenameField to set

getTargetFilename

public String getTargetFilename()
Returns:
the targetFilename

setTargetFilename

public void setTargetFilename(String targetFilename)
Parameters:
targetFilename - the targetFilename to set

getOutputType

public KettleReportBuilder.OutputType getOutputType()
Specified by:
getOutputType in interface AutoDocOptionsInterface
Returns:
the outputType

setOutputType

public void setOutputType(KettleReportBuilder.OutputType outputType)
Parameters:
outputType - the outputType to set

isIncludingDescription

public boolean isIncludingDescription()
Specified by:
isIncludingDescription in interface AutoDocOptionsInterface
Returns:
the includingDescription

setIncludingDescription

public void setIncludingDescription(boolean includingDescription)
Parameters:
includingDescription - the includingDescription to set

isIncludingCreated

public boolean isIncludingCreated()
Specified by:
isIncludingCreated in interface AutoDocOptionsInterface
Returns:
the includingCreated

setIncludingCreated

public void setIncludingCreated(boolean includingCreated)
Parameters:
includingCreated - the includingCreated to set

isIncludingModified

public boolean isIncludingModified()
Specified by:
isIncludingModified in interface AutoDocOptionsInterface
Returns:
the includingModified

setIncludingModified

public void setIncludingModified(boolean includingModified)
Parameters:
includingModified - the includingModified to set

isIncludingImage

public boolean isIncludingImage()
Specified by:
isIncludingImage in interface AutoDocOptionsInterface
Returns:
the includingImage

setIncludingImage

public void setIncludingImage(boolean includingImage)
Parameters:
includingImage - the includingImage to set

isIncludingLoggingConfiguration

public boolean isIncludingLoggingConfiguration()
Specified by:
isIncludingLoggingConfiguration in interface AutoDocOptionsInterface
Returns:
the includingLoggingConfiguration

setIncludingLoggingConfiguration

public void setIncludingLoggingConfiguration(boolean includingLoggingConfiguration)
Parameters:
includingLoggingConfiguration - the includingLoggingConfiguration to set

isIncludingLastExecutionResult

public boolean isIncludingLastExecutionResult()
Specified by:
isIncludingLastExecutionResult in interface AutoDocOptionsInterface
Returns:
the includingLastExecutionResult

setIncludingLastExecutionResult

public void setIncludingLastExecutionResult(boolean includingLastExecutionResult)
Parameters:
includingLastExecutionResult - the includingLastExecutionResult to set

isIncludingExtendedDescription

public boolean isIncludingExtendedDescription()
Specified by:
isIncludingExtendedDescription in interface AutoDocOptionsInterface
Returns:
the includingExtendedDescription

setIncludingExtendedDescription

public void setIncludingExtendedDescription(boolean includingExtendedDescription)
Parameters:
includingExtendedDescription - the includingExtendedDescription to set

isIncludingName

public boolean isIncludingName()
Specified by:
isIncludingName in interface AutoDocOptionsInterface
Returns:
the includingName

setIncludingName

public void setIncludingName(boolean includingName)
Parameters:
includingName - the includingName to set

getFileTypeField

public String getFileTypeField()
Returns:
the fileTypeField

setFileTypeField

public void setFileTypeField(String fileTypeField)
Parameters:
fileTypeField - the fileTypeField to set