meka.filters.unsupervised.attribute

Class MekaClassAttributes

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

weka.filters.SimpleStreamFilter

meka.filters.unsupervised.attribute.MekaClassAttributes

All Implemented Interfaces:

Serializable, weka.core.CapabilitiesHandler, weka.core.CapabilitiesIgnorer, weka.core.CommandlineRunnable, weka.core.OptionHandler, weka.core.RevisionHandler, weka.filters.StreamableFilter

public class MekaClassAttributes
extends weka.filters.SimpleStreamFilter

Reorders attributes for MEKA to use as class attributes.

Version:

$Revision: 66 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected weka.core.Range	m_AttributeIndices the range of attributes to use as class attributes.
protected weka.filters.unsupervised.attribute.Reorder	m_Reorder for reordering the attributes.

Fields inherited from class weka.filters.Filter

m_Debug, m_DoNotCheckCapabilities, m_FirstBatchDone, m_InputRelAtts, m_InputStringAtts, m_NewBatch, m_OutputRelAtts, m_OutputStringAtts

Constructor Summary

Constructors

Constructor and Description
MekaClassAttributes()

Method Summary

Modifier and Type	Method and Description
String	attributeIndicesTipText() Returns the tip text for this property
protected weka.core.Instances	determineOutputFormat(weka.core.Instances inputFormat) Determines the output format based on the input format and returns this.
String	getAttributeIndices() Get the current range selection
weka.core.Capabilities	getCapabilities() Returns the Capabilities of this filter.
String[]	getOptions() Gets the current settings of the filter.
String	getRevision()
String	globalInfo() Returns a string describing this filter.
Enumeration	listOptions() Returns an enumeration describing the available options.
static void	main(String[] args) runs the filter with the given arguments.
protected weka.core.Instance	process(weka.core.Instance instance) processes the given instance (may change the provided instance) and returns the modified version.
void	setAttributeIndices(String value) Set which attributes are to be used as MEKA class attributes.
void	setOptions(String[] options) Parses a given list of options.

Methods inherited from class weka.filters.SimpleStreamFilter

batchFinished, hasImmediateOutputFormat, input, preprocess, process

Methods inherited from class weka.filters.SimpleFilter

reset, setInputFormat

Methods inherited from class weka.filters.Filter

batchFilterFile, bufferInput, copyValues, copyValues, debugTipText, doNotCheckCapabilitiesTipText, filterFile, flushInput, getCapabilities, getDebug, getDoNotCheckCapabilities, getInputFormat, getOutputFormat, initInputLocators, initOutputLocators, inputFormatPeek, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputFormatPeek, outputPeek, postExecution, preExecution, push, push, resetQueue, run, runFilter, setDebug, setDoNotCheckCapabilities, setOutputFormat, testInputFormat, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

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

Field Detail

m_AttributeIndices

protected weka.core.Range m_AttributeIndices

the range of attributes to use as class attributes.

m_Reorder

protected weka.filters.unsupervised.attribute.Reorder m_Reorder

for reordering the attributes.

Constructor Detail

MekaClassAttributes

public MekaClassAttributes()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing this filter.

Specified by:

globalInfo in class weka.filters.SimpleFilter

Returns:

a description of the filter suitable for displaying in the explorer/experimenter gui

listOptions

public Enumeration listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Overrides:

listOptions in class weka.filters.Filter

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(String[] options)
                throws Exception

Parses a given list of options.

Specified by:

setOptions in interface weka.core.OptionHandler

Overrides:

setOptions in class weka.filters.Filter

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 filter.

Specified by:

getOptions in interface weka.core.OptionHandler

Overrides:

getOptions in class weka.filters.Filter

Returns:

an array of strings suitable for passing to setOptions

setAttributeIndices

public void setAttributeIndices(String value)
                         throws Exception

Set which attributes are to be used as MEKA class attributes.

Parameters:

value - a string representing the list of attributes. Since the string will typically come from a user, attributes are indexed from 1.
eg: first-3,5,6-last
Note: use this method before you call setInputFormat(Instances), since the output format is determined in that method.

Throws:

Exception - if an invalid range list is supplied

getAttributeIndices

public String getAttributeIndices()

Get the current range selection

Returns:

a string containing a comma separated list of ranges

attributeIndicesTipText

public String attributeIndicesTipText()

Returns the tip text for this property

Returns:

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

getCapabilities

public weka.core.Capabilities getCapabilities()

Returns the Capabilities of this filter.

Specified by:

getCapabilities in interface weka.core.CapabilitiesHandler

Overrides:

getCapabilities in class weka.filters.Filter

Returns:

the capabilities of this object

See Also:

Capabilities

determineOutputFormat

protected weka.core.Instances determineOutputFormat(weka.core.Instances inputFormat)
                                             throws Exception

Determines the output format based on the input format and returns this. In case the output format cannot be returned immediately, i.e., hasImmediateOutputFormat() returns false, then this method will called from batchFinished() after the call of preprocess(Instances), in which, e.g., statistics for the actual processing step can be gathered.

Specified by:

determineOutputFormat in class weka.filters.SimpleStreamFilter

Parameters:

inputFormat - the input format to base the output format on

Returns:

the output format

Throws:

Exception - in case the determination goes wrong

process

protected weka.core.Instance process(weka.core.Instance instance)
                              throws Exception

processes the given instance (may change the provided instance) and returns the modified version.

Specified by:

process in class weka.filters.SimpleStreamFilter

Parameters:

instance - the instance to process

Returns:

the modified data

Throws:

Exception - in case the processing goes wrong

getRevision

public String getRevision()

Specified by:

getRevision in interface weka.core.RevisionHandler

Overrides:

getRevision in class weka.filters.Filter

main

public static void main(String[] args)

runs the filter with the given arguments.

Parameters:

args - the commandline arguments