@Step(id="ArffOutput",
image="ARFF.svg",
name="Arff output",
description="Writes data in ARFF format to a file",
documentationUrl="http://wiki.pentaho.com/display/EAI/ARFF+Output",
categoryDescription="Data Mining")
public class ArffOutputMeta
extends org.pentaho.di.trans.step.BaseStepMeta
implements org.pentaho.di.trans.step.StepMetaInterface
Modifier and Type | Field and Description |
---|---|
protected String |
m_encoding |
protected String |
m_fileFormat |
protected String |
m_fileName |
protected String |
m_newLine |
protected ArffMeta[] |
m_outputFields |
protected boolean |
m_outputSparseInstances |
protected String |
m_relationName |
protected String |
m_weightField
The anme of the field to use to set the weights.
|
protected static Class<?> |
PKG |
Constructor and Description |
---|
ArffOutputMeta()
Creates a new
ArffOutputMeta instance. |
Modifier and Type | Method and Description |
---|---|
void |
allocate(int num)
Allocate an array to hold meta data for the output fields
|
void |
check(List<org.pentaho.di.core.CheckResultInterface> remarks,
org.pentaho.di.trans.TransMeta transmeta,
org.pentaho.di.trans.step.StepMeta stepMeta,
org.pentaho.di.core.row.RowMetaInterface prev,
String[] input,
String[] output,
org.pentaho.di.core.row.RowMetaInterface info)
Check the settings of this step and put findings in a remarks list.
|
Object |
clone()
Clone this step's meta data
|
boolean |
equals(Object obj)
Check for equality
|
String |
getDialogClassName() |
String |
getEncoding()
Get the character encoding in use
|
void |
getFields(org.pentaho.di.core.row.RowMetaInterface row,
String origin,
org.pentaho.di.core.row.RowMetaInterface[] info,
org.pentaho.di.trans.step.StepMeta nextStep,
org.pentaho.di.core.variables.VariableSpace space)
Generates row meta data to represent the fields output by this step
|
String |
getFileFormat()
Get the file format in use
|
String |
getFileName()
Get the filename of the current ARFF file
|
protected String |
getNewLine() |
ArffMeta[] |
getOutputFields()
Get the meta data for the output fields
|
boolean |
getOutputSparseInstance()
Get whether to output instances in sparse format
|
String |
getRelationName()
Get the relation name for the current ARFF file
|
org.pentaho.di.trans.step.StepInterface |
getStep(org.pentaho.di.trans.step.StepMeta stepMeta,
org.pentaho.di.trans.step.StepDataInterface stepDataInterface,
int cnr,
org.pentaho.di.trans.TransMeta tr,
org.pentaho.di.trans.Trans trans)
Get the executing step, needed by Trans to launch a step.
|
org.pentaho.di.trans.step.StepDataInterface |
getStepData()
Get a new instance of the appropriate data class.
|
String |
getWeightFieldName()
Gets the name of the field to use to set instance weights.
|
String |
getXML()
Return the XML describing this (configured) step
|
void |
loadXML(Node stepnode,
List<org.pentaho.di.core.database.DatabaseMeta> databases,
Map<String,org.pentaho.di.core.Counter> counters)
Loads the meta data for this (configured) step from XML.
|
void |
readRep(org.pentaho.di.repository.Repository rep,
org.pentaho.di.repository.ObjectId id_step,
List<org.pentaho.di.core.database.DatabaseMeta> databases,
Map<String,org.pentaho.di.core.Counter> counters)
Read this step's configuration from a repository
|
void |
saveRep(org.pentaho.di.repository.Repository rep,
org.pentaho.di.repository.ObjectId id_transformation,
org.pentaho.di.repository.ObjectId id_step)
Save this step's meta data to a repository
|
void |
setDefault()
Set default values
|
void |
setEncoding(String e)
Set the character encoding to use
|
void |
setFileFormat(String ff)
Set the file format to use (DOS/UNIX)
|
void |
setFileName(String fn)
Set the filename to use
|
void |
setOutputFields(ArffMeta[] am)
Set the array of meta data for the output fields
|
void |
setOutputSparseIntsances(boolean o)
Set whether to output instances in sparse format
|
void |
setRelationName(String r)
Set the relation name to use
|
void |
setupArffMeta(org.pentaho.di.core.row.RowMetaInterface rmi)
Sets up the ArffMeta array based on the incomming Kettle row format.
|
void |
setWeightFieldName(String wfn)
Set the name of the field to use to set instance weights from.
|
analyseImpact, analyseImpact, cancelQueries, check, check, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, 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
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
analyseImpact, analyseImpact, cancelQueries, check, cleanAfterHopFromRemove, cleanAfterHopFromRemove, cleanAfterHopToRemove, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, fetchTransMeta, getActiveReferencedObjectDescription, 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
protected static Class<?> PKG
protected ArffMeta[] m_outputFields
protected String m_fileName
protected String m_encoding
protected String m_newLine
protected String m_fileFormat
protected String m_relationName
protected boolean m_outputSparseInstances
protected String m_weightField
public void allocate(int num)
num
- number of meta data objects to allocatepublic void setWeightFieldName(String wfn)
wfn
- the name of the field to use to set instance weights or null for equal weights.public String getWeightFieldName()
public void setOutputSparseIntsances(boolean o)
o
- true if instances are to be output in sparse formatpublic boolean getOutputSparseInstance()
public void setRelationName(String r)
r
- the relation namepublic String getRelationName()
public void setFileName(String fn)
fn
- the filename to usepublic String getFileName()
public void setEncoding(String e)
e
- the character encoding to usepublic String getEncoding()
String
valuepublic void setFileFormat(String ff)
ff
- the file format to usepublic String getFileFormat()
public void setOutputFields(ArffMeta[] am)
am
- an array of ArffMetapublic ArffMeta[] getOutputFields()
public void setupArffMeta(org.pentaho.di.core.row.RowMetaInterface rmi)
rmi
- a RowMetaInterface
valuepublic String getXML()
getXML
in interface org.pentaho.di.trans.step.StepMetaInterface
getXML
in class org.pentaho.di.trans.step.BaseStepMeta
String
containing the XMLpublic void loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, Map<String,org.pentaho.di.core.Counter> counters) throws org.pentaho.di.core.exception.KettleXMLException
loadXML
in interface org.pentaho.di.trans.step.StepMetaInterface
loadXML
in class org.pentaho.di.trans.step.BaseStepMeta
stepnode
- the step to loadorg.pentaho.di.core.exception.KettleXMLException
- if an error occurspublic void readRep(org.pentaho.di.repository.Repository rep, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases, Map<String,org.pentaho.di.core.Counter> counters) throws org.pentaho.di.core.exception.KettleException
readRep
in interface org.pentaho.di.trans.step.StepMetaInterface
readRep
in class org.pentaho.di.trans.step.BaseStepMeta
rep
- the repository to accessid_step
- the id for this steporg.pentaho.di.core.exception.KettleException
- if an error occurspublic void saveRep(org.pentaho.di.repository.Repository rep, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step) throws org.pentaho.di.core.exception.KettleException
saveRep
in interface org.pentaho.di.trans.step.StepMetaInterface
saveRep
in class org.pentaho.di.trans.step.BaseStepMeta
rep
- the repository to save toid_transformation
- transformation idid_step
- step idorg.pentaho.di.core.exception.KettleException
- if an error occurspublic void getFields(org.pentaho.di.core.row.RowMetaInterface row, String origin, org.pentaho.di.core.row.RowMetaInterface[] info, org.pentaho.di.trans.step.StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space) throws org.pentaho.di.core.exception.KettleStepException
getFields
in interface org.pentaho.di.trans.step.StepMetaInterface
getFields
in class org.pentaho.di.trans.step.BaseStepMeta
row
- the meta data for the output producedorigin
- the name of the step to be used as the origininfo
- 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.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
- not sure what this is :-)org.pentaho.di.core.exception.KettleStepException
- if an error occurspublic void check(List<org.pentaho.di.core.CheckResultInterface> remarks, org.pentaho.di.trans.TransMeta transmeta, org.pentaho.di.trans.step.StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info)
check
in interface org.pentaho.di.trans.step.StepMetaInterface
check
in class org.pentaho.di.trans.step.BaseStepMeta
remarks
- the list to put the remarks in. see
org.pentaho.di.core.CheckResult
transmeta
- the transform meta datastepMeta
- the step meta dataprev
- the fields coming from a previous stepinput
- the input step namesoutput
- the output step namesinfo
- the fields that are used as information by the steppublic boolean equals(Object obj)
public Object clone()
clone
in interface org.pentaho.di.trans.step.StepMetaInterface
clone
in class org.pentaho.di.trans.step.BaseStepMeta
public void setDefault()
setDefault
in interface org.pentaho.di.trans.step.StepMetaInterface
protected String getNewLine()
public String getDialogClassName()
getDialogClassName
in interface org.pentaho.di.trans.step.StepMetaInterface
getDialogClassName
in class org.pentaho.di.trans.step.BaseStepMeta
public org.pentaho.di.trans.step.StepInterface getStep(org.pentaho.di.trans.step.StepMeta stepMeta, org.pentaho.di.trans.step.StepDataInterface stepDataInterface, int cnr, org.pentaho.di.trans.TransMeta tr, org.pentaho.di.trans.Trans trans)
getStep
in interface org.pentaho.di.trans.step.StepMetaInterface
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 number to get.tr
- the transformation info.trans
- the launching transformationStepInterface
valuepublic org.pentaho.di.trans.step.StepDataInterface getStepData()
getStepData
in interface org.pentaho.di.trans.step.StepMetaInterface
StepDataInterface
valueCopyright © 2019 Hitachi Vantara. All rights reserved.