org.pentaho.di.trans.steps.pentahoreporting
Class PentahoReportingOutputMeta

java.lang.Object
  org.pentaho.di.trans.step.BaseStepMeta
      org.pentaho.di.trans.steps.pentahoreporting.PentahoReportingOutputMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

@Step(id="PentahoReportingOutput",
      image="org/pentaho/reporting/images/JFR.png",
      description="PentahoReportingOutput.Description",
      name="PentahoReportingOutput.Name",
      categoryDescription="PentahoReportingOutput.Category",
      i18nPackageName="org.pentaho.reporting.plugin")
public class PentahoReportingOutputMeta
extends BaseStepMeta
implements StepMetaInterface

Nested Class Summary

static class

PentahoReportingOutputMeta.ProcessorType

Field Summary

static String	XML_TAG_PARAMETER
static String	XML_TAG_PARAMETERS

Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

PentahoReportingOutputMeta()

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	getInputFileField()
String	getOutputFileField()
PentahoReportingOutputMeta.ProcessorType	getOutputProcessorType()
Map<String,String>	getParameterFieldMap()
StepInterface	getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, 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	getXML() Produces the XML string that describes this step's information.
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 idStep, List<DatabaseMeta> databases, Map<String,Counter> counters) Read the steps information from a Kettle repository
void	saveRep(Repository rep, ObjectId idTransformation, ObjectId idStep) Save the steps data into a Kettle repository
void	setDefault() Set default values
void	setInputFileField(String inputFileField)
void	setOutputFileField(String outputFileField)
void	setOutputProcessorType(PentahoReportingOutputMeta.ProcessorType outputProcessorType)
void	setParameterFieldMap(Map<String,String> parameterFieldMap)

Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta

analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, 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, 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, getFields, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta, supportsErrorHandling

Field Detail

XML_TAG_PARAMETERS

public static final String XML_TAG_PARAMETERS

See Also:

Constant Field Values

XML_TAG_PARAMETER

public static final String XML_TAG_PARAMETER

See Also:

Constant Field Values

Constructor Detail

PentahoReportingOutputMeta

public PentahoReportingOutputMeta()

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

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 idStep,
                    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

idStep - 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 idTransformation,
                    ObjectId idStep)
             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

idTransformation - The transformation ID

idStep - 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 transMeta,
                             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

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

getInputFileField

public String getInputFileField()

Returns:

the inputFileField

setInputFileField

public void setInputFileField(String inputFileField)

Parameters:

inputFileField - the inputFileField to set

getOutputFileField

public String getOutputFileField()

Returns:

the outputFileField

setOutputFileField

public void setOutputFileField(String outputFileField)

Parameters:

outputFileField - the outputFileField to set

getParameterFieldMap

public Map<String,String> getParameterFieldMap()

Returns:

the parameterFieldMap

setParameterFieldMap

public void setParameterFieldMap(Map<String,String> parameterFieldMap)

Parameters:

parameterFieldMap - the parameterFieldMap to set

getOutputProcessorType

public PentahoReportingOutputMeta.ProcessorType getOutputProcessorType()

Returns:

the outputProcessorType

setOutputProcessorType

public void setOutputProcessorType(PentahoReportingOutputMeta.ProcessorType outputProcessorType)

Parameters:

outputProcessorType - the outputProcessorType to set