weka.filters.unsupervised.instance
Class LatestRecords

java.lang.Object
  weka.filters.Filter
      weka.filters.SimpleFilter
          weka.filters.SimpleBatchFilter
              weka.filters.unsupervised.instance.LatestRecords

All Implemented Interfaces:

Serializable, weka.core.CapabilitiesHandler, weka.core.OptionHandler, weka.core.RevisionHandler, weka.filters.UnsupervisedFilter

public class LatestRecords
extends weka.filters.SimpleBatchFilter
implements weka.filters.UnsupervisedFilter

Retains the latest database records.

Valid options are:

 -att-name
  The name of the attribute that holds the numeric DB ID.
  (default: db_id)

 -amount
  The amount of latest records to keep.
  (0,1]: percentage, (1,+inf): absolute number
  (default: 0.5)

Version:

$Revision: 5491 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

static double	DEFAULT_AMOUNT the default number of records to keep.
static String	DEFAULT_ATTNAME the default attribute name.
protected double	m_Amount the amount to keep (less than 1: percentage, otherwise absolute number).
protected String	m_AttributeName the name of the attribute that holds the numeric database ID.

Fields inherited from class weka.filters.SimpleFilter

m_Debug

Fields inherited from class weka.filters.Filter

m_FirstBatchDone, m_InputRelAtts, m_InputStringAtts, m_NewBatch, m_OutputRelAtts, m_OutputStringAtts

Constructor Summary

LatestRecords()

Method Summary

String	amountTipText() Returns the tip text for this property.
String	attributeNameTipText() 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.
double	getAmount() Returns the amount of records to keep.
String	getAttributeName() Returns the name of the attribute containing the numeric database ID.
weka.core.Capabilities	getCapabilities() Returns the Capabilities of this filter.
String[]	getOptions() Gets the current settings of the filter.
String	getRevision() Returns the revision string.
String	globalInfo() Returns a string describing this classifier.
Enumeration	listOptions() Returns an enumeration describing the available options.
static void	main(String[] args) Main method for running this filter.
protected weka.core.Instances	process(weka.core.Instances instances) Processes the given data (may change the provided dataset) and returns the modified version.
void	setAmount(double value) Sets the amount of records to keep (0,1]=percentage, (1,+inf)=absolute number.
void	setAttributeName(String value) Sets the name of the attribute containing the numeric database ID.
void	setOptions(String[] options) Parses a given list of options.

Methods inherited from class weka.filters.SimpleBatchFilter

batchFinished, hasImmediateOutputFormat, input

Methods inherited from class weka.filters.SimpleFilter

debugTipText, getDebug, reset, setDebug, setInputFormat

Methods inherited from class weka.filters.Filter

batchFilterFile, bufferInput, copyValues, copyValues, filterFile, flushInput, getCapabilities, getInputFormat, getOutputFormat, initInputLocators, initOutputLocators, inputFormatPeek, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputFormatPeek, outputPeek, push, resetQueue, runFilter, setOutputFormat, testInputFormat, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ATTNAME

public static final String DEFAULT_ATTNAME

the default attribute name.

See Also:

Constant Field Values

DEFAULT_AMOUNT

public static final double DEFAULT_AMOUNT

the default number of records to keep.

See Also:

Constant Field Values

m_AttributeName

protected String m_AttributeName

the name of the attribute that holds the numeric database ID.

m_Amount

protected double m_Amount

the amount to keep (less than 1: percentage, otherwise absolute number).

Constructor Detail

LatestRecords

public LatestRecords()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing this classifier.

Specified by:

globalInfo in class weka.filters.SimpleFilter

Returns:

a description of the classifier 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.SimpleFilter

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(String[] options)
                throws Exception

Parses a given list of options.

Valid options are:

 -att-name
  The name of the attribute that holds the numeric DB ID.
  (default: db_id)

 -amount
  The amount of latest records to keep.
  (0,1]: percentage, (1,+inf): absolute number
  (default: 0.5)

Specified by:

setOptions in interface weka.core.OptionHandler

Overrides:

setOptions in class weka.filters.SimpleFilter

Parameters:

options - the list of options as an array of string.s

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

Returns:

an array of strings suitable for passing to setOptions.

setAttributeName

public void setAttributeName(String value)

Sets the name of the attribute containing the numeric database ID.

Parameters:

value - the name of the attribute

getAttributeName

public String getAttributeName()

Returns the name of the attribute containing the numeric database ID.

Returns:

the name of the attribute

attributeNameTipText

public String attributeNameTipText()

Returns the tip text for this property.

Returns:

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

setAmount

public void setAmount(double value)

Sets the amount of records to keep (0,1]=percentage, (1,+inf)=absolute number.

Parameters:

value - the amount

getAmount

public double getAmount()

Returns the amount of records to keep.

Returns:

the amount

amountTipText

public String amountTipText()

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.

Specified by:

determineOutputFormat in class weka.filters.SimpleFilter

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.Instances process(weka.core.Instances instances)
                               throws Exception

Processes the given data (may change the provided dataset) and returns the modified version. This method is called in batchFinished().

Specified by:

process in class weka.filters.SimpleFilter

Parameters:

instances - the data to process

Returns:

the modified data

Throws:

Exception - in case the processing goes wrong

getRevision

public String getRevision()

Returns the revision string.

Specified by:

getRevision in interface weka.core.RevisionHandler

Overrides:

getRevision in class weka.filters.Filter

Returns:

the revision

main

public static void main(String[] args)

Main method for running this filter.

Parameters:

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