weka.knowledgeflow.steps

Class WriteWekaLog

java.lang.Object

weka.knowledgeflow.steps.BaseStep

weka.knowledgeflow.steps.WriteWekaLog

All Implemented Interfaces:

java.io.Serializable, BaseStepExtender, Step

@KFStep(name="WriteToWekaLog",
        category="Flow",
        toolTipText="Write data to the log",
        iconPath="weka/gui/knowledgeflow/icons/WriteWekaLog.gif")
public class WriteWekaLog
extends BaseStep

Step that takes incoming data and writes it to the Weka log

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	m_incrCount Count of how many incremental data points have been seen so far
protected java.lang.String	m_incrementalWriteFrequency How often to write incremental data to the log
protected int	m_incrFreq Resolved frequency
protected boolean	m_inputIsIncremental True if the input is incremental
protected boolean	m_isReset True if the step has been reset
protected LoggingLevel	m_logLevel Level to log at

Fields inherited from class weka.knowledgeflow.steps.BaseStep

m_stepIsResourceIntensive, m_stepManager, m_stepName

Constructor Summary

Constructors

Constructor and Description
WriteWekaLog()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getIncomingConnectionTypes() Get a list of acceptable incoming connection types (at this point in time)
java.lang.String	getIncrementalLoggingFrequency() Get how frequently to write an incremental data point to the log
LoggingLevel	getLoggingLevel() Get the logging level to use
java.util.List<java.lang.String>	getOutgoingConnectionTypes() Get currently generatable outgoing connection types
protected void	processBatch(Data data) Process a batch data point
void	processIncoming(Data data) Process an incoming piece of data
protected void	processStreaming(Data data) Process a streaming data point
void	setIncrementalLoggingFrequency(java.lang.String frequency) Set how frequently to write an incremental data point to the log
void	setLoggingLevel(LoggingLevel level) Set the logging level to use
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, setStepMustRunSingleThreaded, start, stepMustRunSingleThreaded, stop

Methods inherited from class java.lang.Object

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

Field Detail

m_incrementalWriteFrequency

protected java.lang.String m_incrementalWriteFrequency

How often to write incremental data to the log

m_incrFreq

protected int m_incrFreq

Resolved frequency

m_incrCount

protected int m_incrCount

Count of how many incremental data points have been seen so far

m_isReset

protected boolean m_isReset

True if the step has been reset

m_inputIsIncremental

protected boolean m_inputIsIncremental

True if the input is incremental

m_logLevel

protected LoggingLevel m_logLevel

Level to log at

Constructor Detail

WriteWekaLog

public WriteWekaLog()

Method Detail

setLoggingLevel

@OptionMetadata(displayName="Logging level",
                description="The level at which to write log messages",
                displayOrder=1)
public void setLoggingLevel(LoggingLevel level)

Set the logging level to use

Parameters:

level - the level to use

getLoggingLevel

public LoggingLevel getLoggingLevel()

Get the logging level to use

Returns:

the level to use

setIncrementalLoggingFrequency

@OptionMetadata(displayName="Incremental logging frequency",
                description="How often to write an incremental/streaming data point to the log",
                displayOrder=2)
public void setIncrementalLoggingFrequency(java.lang.String frequency)

Set how frequently to write an incremental data point to the log

Parameters:

frequency - the frequency (in data points) to write to the log

getIncrementalLoggingFrequency

public java.lang.String getIncrementalLoggingFrequency()

Get how frequently to write an incremental data point to the log

Returns:

the frequency (in data points) to write to the log

stepInit

public void stepInit()
              throws WekaException

Initialize the step

Throws:

WekaException - if a problem occurs

processIncoming

public void processIncoming(Data data)
                     throws WekaException

Process an incoming piece of data

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

processStreaming

protected void processStreaming(Data data)
                         throws WekaException

Process a streaming data point

Parameters:

data - the data

Throws:

WekaException - if a problem occurs

processBatch

protected void processBatch(Data data)
                     throws WekaException

Process a batch data point

Parameters:

data - the data

Throws:

WekaException - if a problem occurs

getIncomingConnectionTypes

public java.util.List<java.lang.String> getIncomingConnectionTypes()

Get a list of acceptable incoming connection types (at this point in time)

Returns:

a list of legal incoming connection types to accept

getOutgoingConnectionTypes

public java.util.List<java.lang.String> getOutgoingConnectionTypes()

Get currently generatable outgoing connection types

Returns:

a list of outgoing connection types