weka.knowledgeflow

Class LegacyFlowLoader

java.lang.Object

weka.knowledgeflow.LegacyFlowLoader

All Implemented Interfaces:

FlowLoader

public class LegacyFlowLoader
extends java.lang.Object
implements FlowLoader

Flow loader that reads legacy .kfml files and translates them to the new implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTENSION File extension for the format handled by this flow loader
protected java.util.Vector<java.lang.Object>	m_beans Legacy beans loaded
protected java.util.Vector<BeanConnection>	m_connections Legacy bean connections loaded
protected LogManager	m_log Log to use
protected static java.lang.String	STEP_LIST_PROPS Path to the steps.props file

Constructor Summary

Constructors

Constructor and Description
LegacyFlowLoader() Constructor

Method Summary

Modifier and Type	Method and Description
protected void	configurePluginStep(java.lang.Object legacy, Step current) Handles configuration of settings in the case of plugin steps
protected void	copySettingsNonWrapper(java.lang.Object legacy, Step current) Copy the settings from a legacy non-algorithm wrapper bean to the new step equivalent
protected void	copySettingsWrapper(WekaWrapper legacy, WekaAlgorithmWrapper current) Copy settings from a legacy WekaWrapper bean to the new WekaAlgorithmWrapper equivalent
protected Step	findStepMatch(java.lang.String legacyFullyQualified) Attempts to find a matching Step implementation for a supplied legacy class name
java.lang.String	getFlowFileExtension() Get the flow file extension of the file format handled by this flow loader
java.lang.String	getFlowFileExtensionDescription() Get the description of the file format handled by this flow loader
protected void	handleConnection(Flow flow, BeanConnection conn) Handles a legacy
protected StepManagerImpl	handleStep(BeanInstance bean) Handles a legacy step component
protected void	loadLegacy(java.io.Reader r) Load the legacy flow using the supplied reader
protected Flow	makeFlow(java.lang.String name) Makes a new Flow by translating the legacy beans and connections to the new Step implementations
Flow	readFlow(java.io.File flowFile) Deserialize a legacy flow from the supplied file
Flow	readFlow(java.io.InputStream is) Deserialize a legacy flow from the supplied input stream
Flow	readFlow(java.io.Reader r) Deserialize a legacy flow from the supplied reader
void	setLog(Logger log) Set the log to use
protected void	transferSetting(java.lang.Object legacy, Step current, java.lang.String propName, java.lang.Class propType) Transfer a single setting

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION

public static final java.lang.String EXTENSION

File extension for the format handled by this flow loader

See Also:

Constant Field Values

STEP_LIST_PROPS

protected static final java.lang.String STEP_LIST_PROPS

Path to the steps.props file

See Also:

Constant Field Values

m_beans

protected java.util.Vector<java.lang.Object> m_beans

Legacy beans loaded

m_connections

protected java.util.Vector<BeanConnection> m_connections

Legacy bean connections loaded

m_log

protected LogManager m_log

Log to use

Constructor Detail

LegacyFlowLoader

public LegacyFlowLoader()

Constructor

Method Detail

setLog

public void setLog(Logger log)

Set the log to use

Specified by:

setLog in interface FlowLoader

Parameters:

log - log to use

getFlowFileExtension

public java.lang.String getFlowFileExtension()

Get the flow file extension of the file format handled by this flow loader

Specified by:

getFlowFileExtension in interface FlowLoader

Returns:

the file extension

getFlowFileExtensionDescription

public java.lang.String getFlowFileExtensionDescription()

Get the description of the file format handled by this flow loader

Specified by:

getFlowFileExtensionDescription in interface FlowLoader

Returns:

the description of the file format

readFlow

public Flow readFlow(java.io.File flowFile)
              throws WekaException

Deserialize a legacy flow from the supplied file

Specified by:

readFlow in interface FlowLoader

Parameters:

flowFile - the file to load from

Returns:

the legacy flow translated to a new Flow object

Throws:

WekaException - if a problem occurs

readFlow

public Flow readFlow(java.io.InputStream is)
              throws WekaException

Deserialize a legacy flow from the supplied input stream

Specified by:

readFlow in interface FlowLoader

Parameters:

is - the input stream to load from

Returns:

the legacy flow translated to a new Flow object

Throws:

WekaException - if a problem occurs

readFlow

public Flow readFlow(java.io.Reader r)
              throws WekaException

Deserialize a legacy flow from the supplied reader

Specified by:

readFlow in interface FlowLoader

Parameters:

r - the reader to load from

Returns:

the legacy flow translated to a new Flow object

Throws:

WekaException - if a problem occurs

makeFlow

protected Flow makeFlow(java.lang.String name)
                 throws WekaException

Makes a new Flow by translating the legacy beans and connections to the new Step implementations

Parameters:

name - the name to use for the flow

Returns:

a Flow object

Throws:

WekaException - if a problem occurs

handleConnection

protected void handleConnection(Flow flow,
                                BeanConnection conn)

Handles a legacy

Parameters:

flow - the new Flow to add the translated connection to

conn - the legacy bean connection to process

handleStep

protected StepManagerImpl handleStep(BeanInstance bean)
                              throws WekaException

Handles a legacy step component

Parameters:

bean - the bean instance to process

Returns:

a configured StepManagerImpl that is the equivalent of the legacy bean

Throws:

WekaException - if a problem occurs

copySettingsWrapper

protected void copySettingsWrapper(WekaWrapper legacy,
                                   WekaAlgorithmWrapper current)
                            throws WekaException

Copy settings from a legacy WekaWrapper bean to the new WekaAlgorithmWrapper equivalent

Parameters:

legacy - the legacy wrapper

current - the new step equivalent

Throws:

WekaException - if a problem occurs

copySettingsNonWrapper

protected void copySettingsNonWrapper(java.lang.Object legacy,
                                      Step current)
                               throws WekaException

Copy the settings from a legacy non-algorithm wrapper bean to the new step equivalent

Parameters:

legacy - the legacy bean to copy settings from

current - the new Step to copy to

Throws:

WekaException - if a problem occurs

transferSetting

protected void transferSetting(java.lang.Object legacy,
                               Step current,
                               java.lang.String propName,
                               java.lang.Class propType)
                        throws WekaException

Transfer a single setting

Parameters:

legacy - the legacy bean to transfer from

current - the new step to transfer to

propName - the property name of the setting

propType - the type of the setting

Throws:

WekaException - if a problem occurs

configurePluginStep

protected void configurePluginStep(java.lang.Object legacy,
                                   Step current)
                            throws WekaException

Handles configuration of settings in the case of plugin steps

Parameters:

legacy - the legacy bean to copy settings from

current - the plugin step to copy to

Throws:

WekaException - if a problem occurs

findStepMatch

protected Step findStepMatch(java.lang.String legacyFullyQualified)
                      throws WekaException

Attempts to find a matching Step implementation for a supplied legacy class name

Parameters:

legacyFullyQualified - the fully qualified class name of the legacy bean to find a match for

Returns:

an instantiated Step that is equivalent to the legacy one

Throws:

WekaException - if a match can't be found

loadLegacy

protected void loadLegacy(java.io.Reader r)
                   throws WekaException

Load the legacy flow using the supplied reader

Parameters:

r - the reader to load from

Throws:

WekaException - if a problem occurs