org.pentaho.di.trans.steps.propertyoutput

类 PropertyOutputMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

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

所有已实现的接口:

Cloneable, StepAttributesInterface, StepMetaInterface

public class PropertyOutputMeta
extends BaseStepMeta
implements StepMetaInterface

Output rows to Properties file and create a file.

从以下版本开始:

13-Apr-2008

作者:

Samatar

字段概要

从类继承的字段 org.pentaho.di.trans.step.BaseStepMeta

attributes, databases, log, loggingObject, parentStepMeta, repository, STEP_ATTRIBUTES_FILE

构造器概要

构造器

构造器和说明
PropertyOutputMeta()

方法概要

限定符和类型	方法和说明
boolean	addToResult() 已过时。 use isAddToResult()
String	buildFilename(org.pentaho.di.core.variables.VariableSpace space, int stepnr)
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.
String	exportResources(org.pentaho.di.core.variables.VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) 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(org.pentaho.di.core.variables.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	isAddToResult()
boolean	isAppend()
boolean	isCreateParentFolder()
boolean	isDateInFilename()
boolean	isFileNameInField()
boolean	isStepNrInFilename()
boolean	isTimeInFilename()
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 Node
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) Read the steps information from a Kettle repository
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.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()

从类继承的方法 org.pentaho.di.trans.step.BaseStepMeta

analyseImpact, analyseImpact, cancelQueries, check, check, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, 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

从类继承的方法 java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.pentaho.di.trans.step.StepMetaInterface

analyseImpact, analyseImpact, cancelQueries, check, cleanAfterHopFromRemove, cleanAfterHopFromRemove, cleanAfterHopToRemove, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, 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

构造器详细资料

PropertyOutputMeta

public PropertyOutputMeta()

方法详细资料

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

从接口复制的说明: StepMetaInterface

Load the values for this step from an XML Node

指定者:

loadXML 在接口中 StepMetaInterface

覆盖:

loadXML 在类中 BaseStepMeta

参数:

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

抛出:

org.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

clone

public Object clone()

从接口复制的说明: StepMetaInterface

Make an exact copy of this step, make sure to explicitly copy Collections etc.

指定者:

clone 在接口中 StepMetaInterface

覆盖:

clone 在类中 BaseStepMeta

返回:

an exact copy of this step

getExtension

public String getExtension()

返回:

Returns the extension.

setExtension

public void setExtension(String extension)

参数:

extension - The extension to set.

getFileName

public String getFileName()

返回:

Returns the fileName.

isFileNameInField

public boolean isFileNameInField()

返回:

Is the file name coded in a field?

setFileNameInField

public void setFileNameInField(boolean fileNameInField)

参数:

fileNameInField - Is the file name coded in a field?

getFileNameField

public String getFileNameField()

返回:

The field name that contains the output file name.

setFileNameField

public void setFileNameField(String fileNameField)

参数:

fileNameField - Name of the field that contains the file name

isStepNrInFilename

public boolean isStepNrInFilename()

返回:

Returns the stepNrInFilename.

setStepNrInFilename

public void setStepNrInFilename(boolean stepNrInFilename)

参数:

stepNrInFilename - The stepNrInFilename to set.

isTimeInFilename

public boolean isTimeInFilename()

返回:

Returns the timeInFilename.

isDateInFilename

public boolean isDateInFilename()

返回:

Returns the dateInFilename.

setDateInFilename

public void setDateInFilename(boolean dateInFilename)

参数:

dateInFilename - The dateInFilename to set.

setTimeInFilename

public void setTimeInFilename(boolean timeInFilename)

参数:

timeInFilename - The timeInFilename to set.

setFileName

public void setFileName(String fileName)

参数:

fileName - The fileName to set.

addToResult

@Deprecated
public boolean addToResult()

已过时。 use isAddToResult()

返回:

Returns the Add to result filesname flag.

isAddToResult

public boolean isAddToResult()

setAddToResult

public void setAddToResult(boolean addToResult)

参数:

addToResult - The Add file to result to set.

isCreateParentFolder

public boolean isCreateParentFolder()

返回:

Returns the create parent folder flag.

setCreateParentFolder

public void setCreateParentFolder(boolean createparentfolder)

参数:

createparentfolder - The create parent folder flag to set.

isAppend

public boolean isAppend()

返回:

Returns the append flag.

setAppend

public void setAppend(boolean append)

参数:

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

从接口复制的说明: StepMetaInterface

Set default values

指定者:

setDefault 在接口中 StepMetaInterface

getXML

public String getXML()

从类复制的说明: BaseStepMeta

Produces the XML string that describes this step's information.

指定者:

getXML 在接口中 StepMetaInterface

覆盖:

getXML 在类中 BaseStepMeta

返回:

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

从接口复制的说明: StepMetaInterface

Read the steps information from a Kettle repository

指定者:

readRep 在接口中 StepMetaInterface

覆盖:

readRep 在类中 BaseStepMeta

参数:

rep - The repository to read from

metaStore - The MetaStore to read external information from

id_step - The step ID

databases - The databases to reference

抛出:

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

从接口复制的说明: StepMetaInterface

Save the steps data into a Kettle repository

指定者:

saveRep 在接口中 StepMetaInterface

覆盖:

saveRep 在类中 BaseStepMeta

参数:

rep - The Kettle repository to save to

metaStore - the metaStore to optionally write to

id_transformation - The transformation ID

id_step - The step ID

抛出:

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)

从接口复制的说明: StepMetaInterface

Checks the settings of this step and puts the findings in a remarks List.

指定者:

check 在接口中 StepMetaInterface

覆盖:

check 在类中 BaseStepMeta

参数:

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

从接口复制的说明: 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.

指定者:

getStepData 在接口中 StepMetaInterface

返回:

The appropriate StepDataInterface class.

getKeyField

public String getKeyField()

返回:

the keyfield

getValueField

public String getValueField()

返回:

the valuefield

setKeyField

public void setKeyField(String KeyField)

参数:

KeyField - the keyfield to set

setValueField

public void setValueField(String valuefield)

参数:

valuefield - the valuefield to set

getStep

public StepInterface getStep(StepMeta stepMeta,
                             StepDataInterface stepDataInterface,
                             int cnr,
                             TransMeta tr,
                             Trans trans)

从接口复制的说明: StepMetaInterface

Get the executing step, needed by Trans to launch a step.

指定者:

getStep 在接口中 StepMetaInterface

参数:

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

指定者:

supportsErrorHandling 在接口中 StepMetaInterface

覆盖:

supportsErrorHandling 在类中 BaseStepMeta

返回:

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.

指定者:

exportResources 在接口中 StepMetaInterface

覆盖:

exportResources 在类中 BaseStepMeta

参数:

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.

返回:

the filename of the exported resource

抛出:

org.pentaho.di.core.exception.KettleException