Class AddUserFields
java.lang.Object
weka.filters.Filter
weka.filters.unsupervised.attribute.AddUserFields
- All Implemented Interfaces:
Serializable,CapabilitiesHandler,CapabilitiesIgnorer,CommandlineRunnable,EnvironmentHandler,OptionHandler,RevisionHandler,WeightedAttributesHandler,WeightedInstancesHandler,UnsupervisedFilter
public class AddUserFields
extends Filter
implements OptionHandler, EnvironmentHandler, UnsupervisedFilter, WeightedInstancesHandler, WeightedAttributesHandler
A filter that adds new attributes with user
specified type and constant value. Numeric, nominal, string and date
attributes can be created. Attribute name, and value can be set with
environment variables. Date attributes can also specify a formatting string
by which to parse the supplied date value. Alternatively, a current time
stamp can be specified by supplying the special string "now" as the value for
a date attribute.
Valid options are:
-A <name:type:value> New field specification (name@type@value). Environment variables may be used for any/all parts of the specification. Type can be one of (numeric, nominal, string or date). The value for date be a specific date string or the special string "now" to indicate the current date-time. A specific date format string for parsing specific date values can be specified by suffixing the type specification - e.g. "myTime@date:MM-dd-yyyy@08-23-2009".This option may be specified multiple times
- Version:
- $Revision: 14534 $
- Author:
- Mark Hall (mhall{[at]}pentaho{[dot]}com)
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classInner class encapsulating a new user-specified attribute to create. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddAttributeSpec(String spec) Add an attribute spec to the listReturns the tip text for this property.voidClear the list of attribute specificationsGet the list of attribute specs to use to create the new attributes.Returns the Capabilities of this filter.String[]Gets the current settings of the filterReturns a string describing this filterbooleanInput an instance for filtering.Returns an enumeration describing the available options.static voidMain method for testing this class.voidSet the list of attribute specs to use to create the new attributes.voidSet environment varialbes to usebooleansetInputFormat(Instances instanceInfo) Sets the format of the input instances.voidsetOptions(String[] options) Parses a given list of options.Methods inherited from class weka.filters.Filter
batchFilterFile, batchFinished, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getOutputFormat, getRevision, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, toString, useFilter, wekaStaticWrapper
-
Constructor Details
-
AddUserFields
public AddUserFields()Constructs a new AddUserFields
-
-
Method Details
-
globalInfo
Returns a string describing this filter- Returns:
- a description of the filter suitable for displaying in the explorer/experimenter gui
-
getCapabilities
Returns the Capabilities of this filter.- Specified by:
getCapabilitiesin interfaceCapabilitiesHandler- Overrides:
getCapabilitiesin classFilter- Returns:
- the capabilities of this object
- See Also:
-
clearAttributeSpecs
public void clearAttributeSpecs()Clear the list of attribute specifications -
listOptions
Returns an enumeration describing the available options.- Specified by:
listOptionsin interfaceOptionHandler- Overrides:
listOptionsin classFilter- Returns:
- an enumeration of all the available options.
-
setOptions
Parses a given list of options. * Valid options are: * *-A <name:type:value> * New field specification (name@type@value). * Environment variables may be used for any/all parts of the * specification. Type can be one of (numeric, nominal, string or date). * The value for date be a specific date string or the special string * "now" to indicate the current date-time. A specific date format * string for parsing specific date values can be specified by suffixing * the type specification - e.g. "myTime@date:MM-dd-yyyy@08-23-2009".This option may be specified multiple times
*- Specified by:
setOptionsin interfaceOptionHandler- Overrides:
setOptionsin classFilter- Parameters:
options- the list of options as an array of string- Throws:
Exception- if an option is not supported
-
getOptions
Gets the current settings of the filter- Specified by:
getOptionsin interfaceOptionHandler- Overrides:
getOptionsin classFilter- Returns:
- an array of strings suitable for passing to setOptions
-
addAttributeSpec
Add an attribute spec to the list- Parameters:
spec- the attribute spec to add
-
attributeSpecsTipText
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setAttributeSpecs
Set the list of attribute specs to use to create the new attributes.- Parameters:
specs- the list of attribute specs to use
-
getAttributeSpecs
Get the list of attribute specs to use to create the new attributes.- Returns:
- the list of attribute specs to use
-
setEnvironment
Set environment varialbes to use- Specified by:
setEnvironmentin interfaceEnvironmentHandler- Parameters:
env- the environment variables to use
-
setInputFormat
Sets the format of the input instances.- Overrides:
setInputFormatin classFilter- Parameters:
instanceInfo- an Instances object containing the input instance structure (any instances contained in the object are ignored - only the structure is required).- Returns:
- true if the outputFormat may be collected immediately
- Throws:
Exception- if the input format can't be set successfully
-
input
Input an instance for filtering. Ordinarily the instance is processed and made available for output immediately. Some filters require all instances be read before producing output.- Overrides:
inputin classFilter- Parameters:
instance- the input instance- Returns:
- true if the filtered instance may now be collected with output().
- Throws:
IllegalStateException- if no input format has been defined.
-
main
Main method for testing this class.- Parameters:
argv- should contain arguments to the filter: use -h for help
-