weka.knowledgeflow.steps

Class SerializedModelSaver

java.lang.Object

weka.knowledgeflow.steps.BaseStep

weka.knowledgeflow.steps.SerializedModelSaver

All Implemented Interfaces:

Serializable, BaseStepExtender, Step

@KFStep(name="SerializedModelSaver",
        category="DataSinks",
        toolTipText="A step that saves models to the file system",
        iconPath="weka/gui/knowledgeflow/icons/SerializedModelSaver.gif")
public class SerializedModelSaver
extends BaseStep

Version:

$Revision: $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SerializedModelSaver()

Method Summary

Modifier and Type	Method and Description
String	getFilenamePrefix()
boolean	getIncludeRelationNameInFilename()
List<String>	getIncomingConnectionTypes() Get a list of incoming connection types that this step can accept.
int	getIncrementalSaveSchedule()
List<String>	getOutgoingConnectionTypes() Get a list of outgoing connection types that this step can produce.
File	getOutputDirectory()
void	processIncoming(Data data) Process an incoming data payload (if the step accepts incoming connections)
void	setFilenamePrefix(String filenamePrefix)
void	setIncludeRelationNameInFilename(boolean includeRelationName)
void	setIncrementalSaveSchedule(int schedule)
void	setOutputDirectory(File directory)
void	stepInit() Initialize the step.

Methods inherited from class weka.knowledgeflow.steps.BaseStep

environmentSubstitute, getCustomEditorForStep, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, globalInfo, isResourceIntensive, isStopRequested, outputStructureForConnectionType, setName, setStepIsResourceIntensive, setStepManager, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializedModelSaver

public SerializedModelSaver()

Method Detail

setOutputDirectory

@FilePropertyMetadata(fileChooserDialogType=1,
                      directoriesOnly=true)
 @OptionMetadata(displayName="Output directory",
                description="The directory to save models to",
                displayOrder=0)
public void setOutputDirectory(File directory)

getOutputDirectory

public File getOutputDirectory()

setFilenamePrefix

@OptionMetadata(displayName="Filename prefix",
                description="A prefix to prepend to the filename",
                displayOrder=1)
public void setFilenamePrefix(String filenamePrefix)

getFilenamePrefix

public String getFilenamePrefix()

setIncrementalSaveSchedule

@OptionMetadata(displayName="Incremental save schedule",
                description="How frequently to save incremental classifiers (<= 0 indicates that the save will happen just once, at the end of the stream",
                displayOrder=4)
public void setIncrementalSaveSchedule(int schedule)

getIncrementalSaveSchedule

public int getIncrementalSaveSchedule()

setIncludeRelationNameInFilename

@OptionMetadata(displayName="Include relation name in file name",
                description="Whether to include the relation name of the data as part of the file name",
                displayOrder=2)
public void setIncludeRelationNameInFilename(boolean includeRelationName)

getIncludeRelationNameInFilename

public boolean getIncludeRelationNameInFilename()

getIncomingConnectionTypes

public List<String> getIncomingConnectionTypes()

Description copied from interface: Step

Get a list of incoming connection types that this step can accept. Ideally (and if appropriate), this should take into account the state of the step and any existing incoming connections. E.g. a step might be able to accept one (and only one) incoming batch data connection.

Returns:

a list of incoming connections that this step can accept given its current state

getOutgoingConnectionTypes

public List<String> getOutgoingConnectionTypes()

Description copied from interface: Step

Get a list of outgoing connection types that this step can produce. Ideally (and if appropriate), this should take into account the state of the step and the incoming connections. E.g. depending on what incoming connection is present, a step might be able to produce a trainingSet output, a testSet output or neither, but not both.

Returns:

a list of outgoing connections that this step can produce

stepInit

public void stepInit()

Description copied from interface: Step

Initialize the step.

processIncoming

public void processIncoming(Data data)
                     throws WekaException

Description copied from class: BaseStep

Process an incoming data payload (if the step accepts incoming connections)

Specified by:

processIncoming in interface BaseStepExtender

Specified by:

processIncoming in interface Step

Overrides:

processIncoming in class BaseStep

Parameters:

data - the payload to process

Throws:

WekaException - if a problem occurs