@KFStep(name="TextSaver", category="DataSinks", toolTipText="Save text output to a file", iconPath="weka/gui/knowledgeflow/icons/DefaultText.gif") public class TextSaver extends BaseStep
Modifier and Type | Class and Description |
---|---|
static class |
TextSaver.TextSaverDefaults
Defaults for the step
|
Constructor and Description |
---|
TextSaver() |
Modifier and Type | Method and Description |
---|---|
boolean |
getAppend()
get whether the file should be appended to rather than overwritten
|
Defaults |
getDefaultSettings()
Get default settings for the step (if any).
|
java.io.File |
getFile()
Get the file to save to
|
java.util.List<java.lang.String> |
getIncomingConnectionTypes()
Get a list of incoming connection types that this step can accept.
|
java.util.List<java.lang.String> |
getOutgoingConnectionTypes()
Get a list of outgoing connection types that this step can produce.
|
boolean |
getWriteTitleString()
Get whether the title string will be written to the file
|
void |
processIncoming(Data data)
Process an incoming data payload (if the step accepts incoming connections)
|
void |
setAppend(boolean append)
Set whether the file should be appended to rather than overwritten
|
void |
setFile(java.io.File f)
Set the file to save to
|
void |
setWriteTitleString(boolean w)
Set whether the title string will be written to the file
|
void |
stepInit()
Initialize the step
|
environmentSubstitute, getCustomEditorForStep, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, globalInfo, isResourceIntensive, isStopRequested, outputStructureForConnectionType, outputStructureForConnectionType, setName, setStepIsResourceIntensive, setStepManager, setStepMustRunSingleThreaded, start, stepMustRunSingleThreaded, stop
@OptionMetadata(displayName="File to save to", description="The file to save textual results to", displayOrder=1) @FilePropertyMetadata(fileChooserDialogType=0, directoriesOnly=false) public void setFile(java.io.File f)
f
- the file to save topublic java.io.File getFile()
@OptionMetadata(displayName="Append to file", description="Append to file, rather than re-create for each incoming texual result", displayOrder=2) public void setAppend(boolean append)
append
- true to appendpublic boolean getAppend()
@OptionMetadata(displayName="Write title string", description="Whether to output the title string associated with each textual result", displayOrder=3) public void setWriteTitleString(boolean w)
w
- true to write the title stringpublic boolean getWriteTitleString()
public void stepInit() throws WekaException
WekaException
- if a problem occurspublic java.util.List<java.lang.String> getIncomingConnectionTypes()
public java.util.List<java.lang.String> getOutgoingConnectionTypes()
public void processIncoming(Data data) throws WekaException
processIncoming
in interface BaseStepExtender
processIncoming
in interface Step
processIncoming
in class BaseStep
data
- the data to processWekaException
- if a problem occurspublic Defaults getDefaultSettings()
getDefaultSettings
in interface Step
getDefaultSettings
in class BaseStep