weka.associations

Class SingleAssociatorEnhancer

java.lang.Object

weka.associations.AbstractAssociator

weka.associations.SingleAssociatorEnhancer

All Implemented Interfaces:

Serializable, Cloneable, Associator, CapabilitiesHandler, OptionHandler, RevisionHandler

Direct Known Subclasses:

FilteredAssociator

public abstract class SingleAssociatorEnhancer
extends AbstractAssociator
implements OptionHandler

Abstract utility class for handling settings common to meta associators that use a single base associator.

Version:

$Revision: 5504 $

Author:

Eibe Frank (eibe@cs.waikato.ac.nz), FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Associator	m_Associator The base associator to use

Constructor Summary

Constructors

Constructor and Description
SingleAssociatorEnhancer()

Method Summary

Modifier and Type	Method and Description
String	associatorTipText() Returns the tip text for this property
protected String	defaultAssociatorString() String describing default Associator.
Associator	getAssociator() Get the associator used as the base associator.
protected String	getAssociatorSpec() Gets the associator specification string, which contains the class name of the associator and any options to the associator
Capabilities	getCapabilities() Returns default capabilities of the base associator.
String[]	getOptions() Gets the current settings of the associator.
Enumeration	listOptions() Returns an enumeration describing the available options.
void	setAssociator(Associator value) Set the base associator.
void	setOptions(String[] options) Parses a given list of options.

Methods inherited from class weka.associations.AbstractAssociator

forName, getRevision, makeCopies, makeCopy, runAssociator

Methods inherited from class java.lang.Object

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

Methods inherited from interface weka.associations.Associator

buildAssociations

Field Detail

m_Associator

protected Associator m_Associator

The base associator to use

Constructor Detail

SingleAssociatorEnhancer

public SingleAssociatorEnhancer()

Method Detail

defaultAssociatorString

protected String defaultAssociatorString()

String describing default Associator.

Returns:

default classname

listOptions

public Enumeration listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(String[] options)
                throws Exception

Parses a given list of options. Valid options are:

-W classname
Specify the full class name of the base associator.

Options after -- are passed to the designated associator.

Specified by:

setOptions in interface OptionHandler

Parameters:

options - the list of options as an array of strings

Throws:

Exception - if an option is not supported

getOptions

public String[] getOptions()

Gets the current settings of the associator.

Specified by:

getOptions in interface OptionHandler

Returns:

an array of strings suitable for passing to setOptions

associatorTipText

public String associatorTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

setAssociator

public void setAssociator(Associator value)

Set the base associator.

Parameters:

value - the associator to use.

getAssociator

public Associator getAssociator()

Get the associator used as the base associator.

Returns:

the currently used associator

getAssociatorSpec

protected String getAssociatorSpec()

Gets the associator specification string, which contains the class name of the associator and any options to the associator

Returns:

the associator string

getCapabilities

public Capabilities getCapabilities()

Returns default capabilities of the base associator.

Specified by:

getCapabilities in interface Associator

Specified by:

getCapabilities in interface CapabilitiesHandler

Overrides:

getCapabilities in class AbstractAssociator

Returns:

the capabilities of the base associator

See Also:

Capabilities