Class PentahoReportingOutputMeta
- java.lang.Object
-
- org.pentaho.di.trans.step.BaseStepMeta
-
- org.pentaho.di.trans.steps.pentahoreporting.PentahoReportingOutputMeta
-
- All Implemented Interfaces:
Cloneable
,StepAttributesInterface
,StepMetaInterface
public class PentahoReportingOutputMeta extends BaseStepMeta implements StepMetaInterface
Created on 4-apr-2003
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
PentahoReportingOutputMeta.Param
Initializer for one parameter.static class
PentahoReportingOutputMeta.ProcessorType
-
Field Summary
Fields Modifier and Type Field Description static String
XML_TAG_CREATE_PARENT_FOLDER
static String
XML_TAG_FIELD
static String
XML_TAG_INPUT_FILE
static String
XML_TAG_INPUT_FILE_FIELD
static String
XML_TAG_NAME
static String
XML_TAG_OUTPUT_FILE
static String
XML_TAG_OUTPUT_FILE_FIELD
static String
XML_TAG_PARAMETER
static String
XML_TAG_PARAMETERS
static String
XML_TAG_PROCESSOR_TYPE
static String
XML_TAG_USE_VALUES_FROM_FIELDS
-
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
attributes, databases, log, loggingObject, parentStepMeta, repository, STEP_ATTRIBUTES_FILE
-
-
Constructor Summary
Constructors Constructor Description PentahoReportingOutputMeta()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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)
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.Boolean
getCreateParentfolder()
String
getInputFile()
String
getInputFileField()
String
getOutputFile()
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.Boolean
getUseValuesFromFields()
String
getXML()
Produces the XML string that describes this step's information.void
loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore)
Load the values for this step from an XML Nodevoid
readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId idStep, List<org.pentaho.di.core.database.DatabaseMeta> databases)
Read the steps information from a Kettle repositoryvoid
saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId idTransformation, org.pentaho.di.repository.ObjectId idStep)
Save the steps data into a Kettle repositoryvoid
setCreateParentfolder(Boolean createParentFolder)
void
setDefault()
Set default valuesvoid
setInputFile(String inputFile)
void
setInputFileField(String inputFileField)
void
setOutputFile(String outputFile)
void
setOutputFileField(String outputFileField)
void
setOutputProcessorType(PentahoReportingOutputMeta.ProcessorType outputProcessorType)
void
setParameterFieldMap(Map<String,String> parameterFieldMap)
void
setUseValuesFromFields(Boolean useValuesFromFields)
-
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, analyseImpact, cancelQueries, check, check, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isReferencedObjectEnabled, isRowLevel, loadReferencedObject, loadReferencedObject, loadStepAttributes, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta, setStepIOMeta, supportsErrorHandling
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface
analyseImpact, analyseImpact, cancelQueries, check, cleanAfterHopFromRemove, cleanAfterHopFromRemove, cleanAfterHopToRemove, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, fetchTransMeta, getActiveReferencedObjectDescription, getDialogClassName, getFields, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, passDataToServletOutput, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, 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
-
XML_TAG_INPUT_FILE_FIELD
public static final String XML_TAG_INPUT_FILE_FIELD
- See Also:
- Constant Field Values
-
XML_TAG_OUTPUT_FILE_FIELD
public static final String XML_TAG_OUTPUT_FILE_FIELD
- See Also:
- Constant Field Values
-
XML_TAG_INPUT_FILE
public static final String XML_TAG_INPUT_FILE
- See Also:
- Constant Field Values
-
XML_TAG_OUTPUT_FILE
public static final String XML_TAG_OUTPUT_FILE
- See Also:
- Constant Field Values
-
XML_TAG_USE_VALUES_FROM_FIELDS
public static final String XML_TAG_USE_VALUES_FROM_FIELDS
- See Also:
- Constant Field Values
-
XML_TAG_CREATE_PARENT_FOLDER
public static final String XML_TAG_CREATE_PARENT_FOLDER
- See Also:
- Constant Field Values
-
XML_TAG_NAME
public static final String XML_TAG_NAME
- See Also:
- Constant Field Values
-
XML_TAG_FIELD
public static final String XML_TAG_FIELD
- See Also:
- Constant Field Values
-
XML_TAG_PROCESSOR_TYPE
public static final String XML_TAG_PROCESSOR_TYPE
- See Also:
- Constant Field Values
-
-
Method Detail
-
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 interfaceStepMetaInterface
- Overrides:
loadXML
in classBaseStepMeta
- Parameters:
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tometaStore
- 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 interfaceStepMetaInterface
- Overrides:
clone
in classBaseStepMeta
- Returns:
- an exact copy of this step
-
setDefault
public void setDefault()
Description copied from interface:StepMetaInterface
Set default values- Specified by:
setDefault
in interfaceStepMetaInterface
-
getXML
public String getXML()
Description copied from class:BaseStepMeta
Produces the XML string that describes this step's information.- Specified by:
getXML
in interfaceStepMetaInterface
- Overrides:
getXML
in classBaseStepMeta
- 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 idStep, 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 interfaceStepMetaInterface
- Overrides:
readRep
in classBaseStepMeta
- Parameters:
rep
- The repository to read frommetaStore
- The MetaStore to read external information fromidStep
- The step IDdatabases
- 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 idTransformation, org.pentaho.di.repository.ObjectId idStep) throws org.pentaho.di.core.exception.KettleException
Description copied from interface:StepMetaInterface
Save the steps data into a Kettle repository- Specified by:
saveRep
in interfaceStepMetaInterface
- Overrides:
saveRep
in classBaseStepMeta
- Parameters:
rep
- The Kettle repository to save tometaStore
- the metaStore to optionally write toidTransformation
- The transformation IDidStep
- 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 interfaceStepMetaInterface
- Overrides:
check
in classBaseStepMeta
- Parameters:
remarks
- The list to put the remarks in @see org.pentaho.di.core.CheckResultstepMeta
- The stepMeta to help checkingprev
- The fields coming from the previous stepinput
- The input step namesoutput
- The output step namesinfo
- The fields that are used as information by the stepspace
- the variable space to resolve variable expressions withrepository
- the repository to use to load Kettle metadata objects impacting the output fieldsmetaStore
- the MetaStore to use to load additional external data or metadata impacting the output fields
-
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 interfaceStepMetaInterface
- Parameters:
stepMeta
- The step infostepDataInterface
- the step data interface linked to this step. Here the step can store temporary data, database connections, etc.cnr
- The copy nr to gettransMeta
- The transformation infotrans
- 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 interfaceStepMetaInterface
- Returns:
- The appropriate StepDataInterface class.
-
getCreateParentfolder
public Boolean getCreateParentfolder()
- Returns:
- the createParentFolder
-
setCreateParentfolder
public void setCreateParentfolder(Boolean createParentFolder)
- Parameters:
createParentFolder
- the createParentFolder to set
-
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
-
getUseValuesFromFields
public Boolean getUseValuesFromFields()
- Returns:
- the useValuesFromFields
-
setUseValuesFromFields
public void setUseValuesFromFields(Boolean useValuesFromFields)
- Parameters:
useValuesFromFields
- the useValuesFromFields to set
-
getInputFile
public String getInputFile()
- Returns:
- the inputFile
-
setInputFile
public void setInputFile(String inputFile)
- Parameters:
inputFile
- the inputFile to set
-
getOutputFile
public String getOutputFile()
- Returns:
- the outputFile
-
setOutputFile
public void setOutputFile(String outputFile)
- Parameters:
outputFile
- the outputFile 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
-
-