magpie.attributes.selectors

Class RegexAttributeSelector

java.lang.Object

magpie.attributes.selectors.BaseAttributeSelector

magpie.attributes.selectors.RegexAttributeSelector

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Commandable, Options, Printable

public class RegexAttributeSelector
extends BaseAttributeSelector

Selects attributes based on whether their name matches a regular expression.

Usage: [-v] <Regex>
-v: Exclude attributes whose name matches this Regex
Regex: Regular expression designed to match attributes to be included.
If the Regex includes spaces, surround with ""s

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	IncludeMatching Whether to include attributes that match
protected java.util.regex.Pattern	Regex Regular expression to be matched

Fields inherited from class magpie.attributes.selectors.BaseAttributeSelector

trained

Constructor Summary

Constructors

Constructor and Description
RegexAttributeSelector()

Method Summary

Modifier and Type	Method and Description
java.lang.String	printDescription(boolean htmlFormat) Print full name of object, and a simple description of the options.
java.lang.String	printUsage() Print out required format for options.
void	setIncludeMatching(boolean x) Set whether to include (or exclude) attributes whose name matches the pattern.
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.
void	setRegex(java.lang.String regex) Define the regular expression.
protected java.util.List<java.lang.Integer>	train_protected(Dataset Data) Operation that actually does the work for training.

Methods inherited from class magpie.attributes.selectors.BaseAttributeSelector

about, applyAttributeSelection, clone, getSelectionNames, getSelections, isTrained, printCommand, printSelections, run, runCommand, train

Methods inherited from class java.lang.Object

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

Field Detail

Regex

protected java.util.regex.Pattern Regex

Regular expression to be matched

IncludeMatching

protected boolean IncludeMatching

Whether to include attributes that match

Constructor Detail

RegexAttributeSelector

public RegexAttributeSelector()

Method Detail

setOptions

public void setOptions(java.util.List<java.lang.Object> Options)
                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:

Options - 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

setRegex

public void setRegex(java.lang.String regex)
              throws java.util.regex.PatternSyntaxException

Define the regular expression.

Parameters:

regex - Regular expression to be matched

Throws:

java.util.regex.PatternSyntaxException

setIncludeMatching

public void setIncludeMatching(boolean x)

Set whether to include (or exclude) attributes whose name matches the pattern.

Parameters:

x - Desired operation

train_protected

protected java.util.List<java.lang.Integer> train_protected(Dataset Data)

Description copied from class: BaseAttributeSelector

Operation that actually does the work for training. Must generate a list of attribute IDs

Specified by:

train_protected in class BaseAttributeSelector

Parameters:

Data - Dataset used to train selector

Returns:

List of indexes of selected attributes

printDescription

public java.lang.String printDescription(boolean htmlFormat)

Description copied from interface: Printable

Print full name of object, and a simple description of the options. This description should print enough information to reproduce how this object was created, but not necessarily enough to run it (e.g., coefficients for the model).

Example: For a model training a separate WekaRegression for intermetallics

magpie.models.regression.SplitRegression

Splitter: AllMetalsSplitter
All Metals: magpie.models.regression.WekaRegression trees.REPTree
Contains Nonmetal: magpie.regression.LASSORegreession -maxterms 2

Specified by:

printDescription in interface Printable

Overrides:

printDescription in class BaseAttributeSelector

Parameters:

htmlFormat - Whether format for output to an HTML page (e.g., <div> to create indentation) or for printing to screen.

Returns:

String describing the model

See Also:

#printModel()