All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home

Class weka.filters.unsupervised.attribute.RemoveType

java.lang.Object
    |
    +----weka.filters.Filter
            |
            +----weka.filters.unsupervised.attribute.RemoveType

public class RemoveType

extends Filter

implements UnsupervisedFilter, StreamableFilter, OptionHandler

Valid filter-specific options are:

-T type
Attribute type to delete. Options are "nominal", "numeric", "string" and "date". (default "string")

-V
Invert matching sense (i.e. only keep specified columns)

Version:

$Revision: 1.2 $

Author:

Richard Kirkby (rkirkby@cs.waikato.ac.nz)

TAGS_ATTRIBUTETYPE

Tag allowing selection of attribute type to delete

RemoveType()

 

attributeTypeTipText()

Returns the tip text for this property

batchFinished()

Signify that this batch of input to the filter is finished.

getAttributeType()

Gets the attribute type to be deleted by the filter.

getInvertSelection()

Get whether the supplied columns are to be removed or kept

getOptions()

Gets the current settings of the filter.

globalInfo()

Returns a string describing this filter

input(Instance)

Input an instance for filtering.

invertSelectionTipText()

Returns the tip text for this property

isOutputFormatDefined()

Returns whether the output format is ready to be collected

listOptions()

Returns an enumeration describing the available options.

main(String[])

Main method for testing this class.

numPendingOutput()

Returns the number of instances pending output

output()

Output an instance after filtering and remove from the output queue.

outputPeek()

Output an instance after filtering but do not remove from the output queue.

setAttributeType(SelectedTag)

Sets the attribute type to be deleted by the filter.

setInputFormat(Instances)

Sets the format of the input instances.

setInvertSelection(boolean)

Set whether selected columns should be removed or kept.

setOptions(String[])

Parses the options for this object.

public static final Tag[] TAGS_ATTRIBUTETYPE

          Tag allowing selection of attribute type to delete

public RemoveType()

public boolean setInputFormat(Instances instanceInfo) throws java.lang.Exception

          Sets the format of the input instances.

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:

java.lang.Exception - if the inputFormat can't be set successfully

Overrides:

setInputFormat in class Filter

public boolean input(Instance instance)

          Input an instance for filtering.

Parameters:

instance - the input instance

Returns:

true if the filtered instance may now be collected with output().

Overrides:

input in class Filter

public boolean batchFinished() throws java.lang.Exception

          Signify that this batch of input to the filter is finished.

Returns:

true if there are instances pending output

Overrides:

batchFinished in class Filter

public Instance output()

          Output an instance after filtering and remove from the output queue.

Returns:

the instance that has most recently been filtered (or null if the queue is empty).

Overrides:

output in class Filter

public Instance outputPeek()

          Output an instance after filtering but do not remove from the output queue.

Returns:

the instance that has most recently been filtered (or null if the queue is empty).

Overrides:

outputPeek in class Filter

public int numPendingOutput()

          Returns the number of instances pending output

Returns:

the number of instances pending output

Overrides:

numPendingOutput in class Filter

public boolean isOutputFormatDefined()

          Returns whether the output format is ready to be collected

Returns:

true if the output format is set

Overrides:

isOutputFormatDefined in class Filter

public java.util.Enumeration listOptions()

          Returns an enumeration describing the available options.

Returns:

an enumeration of all the available options.

public void setOptions(java.lang.String options[]) throws java.lang.Exception

          Parses the options for this object. Valid options are:

-T type
Attribute type to delete. Options are "nominal", "numeric", "string" and "date". (default "string")

-V
Invert matching sense (i.e. only keep specified columns)

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported

public java.lang.String[] getOptions()

          Gets the current settings of the filter.

Returns:

an array of strings suitable for passing to setOptions

public java.lang.String globalInfo()

          Returns a string describing this filter

Returns:

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

public java.lang.String attributeTypeTipText()

          Returns the tip text for this property

Returns:

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

public void setAttributeType(SelectedTag type)

          Sets the attribute type to be deleted by the filter.

Parameters:

type - a TAGS_ATTRIBUTETYPE of the new type the filter should delete

public SelectedTag getAttributeType()

          Gets the attribute type to be deleted by the filter.

Returns:

the attribute type as a selected tag TAGS_ATTRIBUTETYPE

public java.lang.String invertSelectionTipText()

          Returns the tip text for this property

Returns:

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

public boolean getInvertSelection()

          Get whether the supplied columns are to be removed or kept

Returns:

true if the supplied columns will be kept

public void setInvertSelection(boolean invert)

          Set whether selected columns should be removed or kept. If true the selected columns are kept and unselected columns are deleted. If false selected columns are deleted and unselected columns are kept.

Parameters:

invert - the new invert setting

public static void main(java.lang.String argv[])

          Main method for testing this class.

Parameters:

argv - should contain arguments to the filter: use -h for help

All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home