weka.filters.unsupervised.attribute

Class DateToNumeric

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

weka.filters.SimpleBatchFilter

weka.filters.unsupervised.attribute.DateToNumeric

All Implemented Interfaces:

java.io.Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler, WeightedAttributesHandler, WeightedInstancesHandler

public class DateToNumeric
extends SimpleBatchFilter
implements WeightedInstancesHandler, WeightedAttributesHandler

A filter for turning date attributes into numeric ones. The numeric value will be the number of milliseconds since January 1, 1970, 00:00:00 GMT, corresponding to the given date."

Valid options are:

 -R <col1,col2-col4,...>
  Specifies list of attributes to turn into numeric ones. Only date attributes will be converted.
  First and last are valid indexes.
  (default: first-last)
 

 -V
  Invert matching sense of column indexes.
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Range	m_Cols Stores which columns to turn into numeric attributes
protected java.lang.String	m_DefaultCols The default columns to turn into numeric attributes

Fields inherited from class weka.filters.Filter

m_Debug, m_DoNotCheckCapabilities, m_FirstBatchDone, m_InputRelAtts, m_InputStringAtts, m_NewBatch, m_OutputRelAtts, m_OutputStringAtts

Constructor Summary

Constructors

Constructor and Description
DateToNumeric()

Method Summary

Modifier and Type	Method and Description
java.lang.String	attributeIndicesTipText() Returns the tip text for this property
protected Instances	determineOutputFormat(Instances data) Determines the output format based on the input format and returns this.
java.lang.String	getAttributeIndices() Gets the current range selection
Capabilities	getCapabilities() Returns the Capabilities of this filter.
boolean	getInvertSelection() Gets whether the supplied columns are to be worked on or the others.
java.lang.String[]	getOptions() Gets the current settings of the filter.
java.lang.String	getRevision() Returns the revision string.
java.lang.String	globalInfo() Returns a string describing this filter
protected boolean	hasImmediateOutputFormat() This filter's output format is immediately available
java.lang.String	invertSelectionTipText() Returns the tip text for this property
java.util.Enumeration<Option>	listOptions() Gets an enumeration describing the available options.
static void	main(java.lang.String[] args) Runs the filter with the given parameters.
protected Instances	process(Instances instances) Processes the given data (may change the provided dataset) and returns the modified version.
void	setAttributeIndices(java.lang.String value) Sets which attributes are to be turned into numeric attributes (only date attributes among the selection will be transformed).
void	setAttributeIndicesArray(int[] value) Sets which attributes are to be transformed to numeric attributes (only date attributes among the selection will be transformed).
void	setInvertSelection(boolean value) Sets whether selected columns should be worked on or all the others apart from these.
void	setOptions(java.lang.String[] options) Parses a given list of options.

Methods inherited from class weka.filters.SimpleBatchFilter

allowAccessToFullInputFormat, batchFinished, input

Methods inherited from class weka.filters.SimpleFilter

reset, setInputFormat

Methods inherited from class weka.filters.Filter

batchFilterFile, bufferInput, copyValues, copyValues, debugTipText, doNotCheckCapabilitiesTipText, filterFile, flushInput, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getInputFormat, getOutputFormat, initInputLocators, initOutputLocators, inputFormatPeek, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputFormatPeek, outputPeek, postExecution, preExecution, push, push, resetQueue, run, runFilter, setDebug, setDoNotCheckCapabilities, setOutputFormat, testInputFormat, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

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

Field Detail

m_Cols

protected Range m_Cols

Stores which columns to turn into numeric attributes

m_DefaultCols

protected java.lang.String m_DefaultCols

The default columns to turn into numeric attributes

Constructor Detail

DateToNumeric

public DateToNumeric()

Method Detail

globalInfo

public java.lang.String globalInfo()

Returns a string describing this filter

Specified by:

globalInfo in class SimpleFilter

Returns:

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

listOptions

public java.util.Enumeration<Option> listOptions()

Gets an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Overrides:

listOptions in class Filter

Returns:

an enumeration of all the available options.

setOptions

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

Parses a given list of options.

Valid options are:

 -R <col1,col2-col4,...>
  Specifies list of attributes to turn into numeric ones. Only date attributes will be converted.
  First and last are valid indexes.
  (default: first-last)
 

 -V
  Invert matching sense of column indexes.
 

Specified by:

setOptions in interface OptionHandler

Overrides:

setOptions in class Filter

Parameters:

options - the list of options as an array of strings

Throws:

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

getOptions

public java.lang.String[] getOptions()

Gets the current settings of the filter.

Specified by:

getOptions in interface OptionHandler

Overrides:

getOptions in class Filter

Returns:

an array of strings suitable for passing to setOptions

invertSelectionTipText

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

getInvertSelection

public boolean getInvertSelection()

Gets whether the supplied columns are to be worked on or the others.

Returns:

true if the supplied columns will be worked on

setInvertSelection

public void setInvertSelection(boolean value)

Sets whether selected columns should be worked on or all the others apart from these. If true all the other columns are considered for conversion.

Parameters:

value - the new invert setting

attributeIndicesTipText

public java.lang.String attributeIndicesTipText()

Returns the tip text for this property

Returns:

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

getAttributeIndices

public java.lang.String getAttributeIndices()

Gets the current range selection

Returns:

a string containing a comma separated list of ranges

setAttributeIndices

public void setAttributeIndices(java.lang.String value)

Sets which attributes are to be turned into numeric attributes (only date attributes among the selection will be transformed).

Parameters:

value - a string representing the list of attributes. Since the string will typically come from a user, attributes are indexed from 1.
eg: first-3,5,6-last

Throws:

java.lang.IllegalArgumentException - if an invalid range list is supplied

setAttributeIndicesArray

public void setAttributeIndicesArray(int[] value)

Sets which attributes are to be transformed to numeric attributes (only date attributes among the selection will be transformed).

Parameters:

value - an array containing indexes of attributes to turn into numeric ones. Since the array will typically come from a program, attributes are indexed from 0.

Throws:

java.lang.IllegalArgumentException - if an invalid set of ranges is supplied

getCapabilities

public Capabilities getCapabilities()

Returns the Capabilities of this filter.

Specified by:

getCapabilities in interface CapabilitiesHandler

Overrides:

getCapabilities in class Filter

Returns:

the capabilities of this object

See Also:

Capabilities

determineOutputFormat

protected Instances determineOutputFormat(Instances data)
                                   throws java.lang.Exception

Determines the output format based on the input format and returns this. In case the output format cannot be returned immediately, i.e., immediateOutputFormat() returns false, then this method will be called from batchFinished().

Specified by:

determineOutputFormat in class SimpleFilter

Parameters:

data - the input format to base the output format on

Returns:

the output format

Throws:

java.lang.Exception - in case the determination goes wrong

See Also:

hasImmediateOutputFormat(), SimpleBatchFilter.batchFinished()

hasImmediateOutputFormat

protected boolean hasImmediateOutputFormat()

This filter's output format is immediately available

Overrides:

hasImmediateOutputFormat in class SimpleBatchFilter

Returns:

true if the output format is immediately available

See Also:

SimpleBatchFilter.batchFinished(), SimpleFilter.setInputFormat(Instances)

process

protected Instances process(Instances instances)
                     throws java.lang.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 SimpleFilter

Parameters:

instances - the data to process

Returns:

the modified data

Throws:

java.lang.Exception - in case the processing goes wrong

See Also:

SimpleBatchFilter.batchFinished()

getRevision

public java.lang.String getRevision()

Returns the revision string.

Specified by:

getRevision in interface RevisionHandler

Overrides:

getRevision in class Filter

Returns:

the revision

main

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

Runs the filter with the given parameters. Use -h to list options.

Parameters:

args - the commandline options