magpie.data.utilities.filters

Class AttributeFilter

java.lang.Object

magpie.data.utilities.filters.BaseDatasetFilter

magpie.data.utilities.filters.ComparisonOperatorFilter

magpie.data.utilities.filters.AttributeFilter

All Implemented Interfaces:

java.io.Serializable, Options

Direct Known Subclasses:

PropertyFilter

public class AttributeFilter
extends ComparisonOperatorFilter

Filter entries based on value of a single attribute.

Usage: <Target Attribute> <Operator> <Threshold>
Target Attribute: Name of attribute to use for filtering
Opterator: Comparison operator used to filter data. Can be: <, ≤, >, ≥, =, and ≠
Threshold: Value to which attribute is compared

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	TargetAttribute Name of feature to base filter on

Fields inherited from class magpie.data.utilities.filters.ComparisonOperatorFilter

Equal, GreaterThan, LessThan, Threshold

Constructor Summary

Constructors

Constructor and Description
AttributeFilter()

Method Summary

Modifier and Type	Method and Description
boolean[]	label(Dataset D) Given a dataset, determine which entries passes the filter.
java.lang.String	printUsage() Print out required format for options.
void	setOptions(java.util.List<java.lang.Object> OptionsObj) Set any options for this object.
void	setOptions(java.lang.String TargetFeature, java.lang.String Operator, java.lang.String Threshold) Configure the filter by defining which entries should be kept
void	setTargetAttribute(java.lang.String targetAttribute) Set the attribute being compared
void	train(Dataset TrainingSet) Train a dataset splitter, if necessary

Methods inherited from class magpie.data.utilities.filters.ComparisonOperatorFilter

setComparisonOperator, setThreshold, testCriteria

Methods inherited from class magpie.data.utilities.filters.BaseDatasetFilter

filter, parallelLabel, parallelMinimum, setExclude, toExclude

Methods inherited from class java.lang.Object

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

Field Detail

TargetAttribute

protected java.lang.String TargetAttribute

Name of feature to base filter on

Constructor Detail

AttributeFilter

public AttributeFilter()

Method Detail

setOptions

public void setOptions(java.util.List<java.lang.Object> OptionsObj)
                throws java.lang.Exception

Description copied from interface: Options

Set any options for this object. If parsing the options fails, return an Exception with the usage as its message.

Parameters:

OptionsObj - Array of options as Objects - can be null

Throws:

java.lang.Exception - if problem with inputs

printUsage

public java.lang.String printUsage()

Description copied from interface: Options

Print out required format for options. For consistency, should start with "Usage: ".

Returns:

Usage for this function

setOptions

public void setOptions(java.lang.String TargetFeature,
                       java.lang.String Operator,
                       java.lang.String Threshold)

Configure the filter by defining which entries should be kept

Parameters:

TargetFeature - Which feature to filter

Operator - Operator used to test for inclusion

Threshold - Threshold used to test for inclusion

setTargetAttribute

public void setTargetAttribute(java.lang.String targetAttribute)

Set the attribute being compared

Parameters:

targetAttribute - Name of attribute used in filtering

label

public boolean[] label(Dataset D)

Description copied from class: BaseDatasetFilter

Given a dataset, determine which entries passes the filter. Please ensure that D remains unaltered (clone if you must)

Specified by:

label in class BaseDatasetFilter

Parameters:

D - Dataset to be labeled

Returns:

A list of booleans marking whether an entry passes

train

public void train(Dataset TrainingSet)

Description copied from class: BaseDatasetFilter

Train a dataset splitter, if necessary

Specified by:

train in class BaseDatasetFilter

Parameters:

TrainingSet - Dataset to use for training