weka.filters.unsupervised.attribute
Class ChangeDateFormat

java.lang.Object
  extended by weka.filters.Filter
      extended by weka.filters.unsupervised.attribute.ChangeDateFormat
All Implemented Interfaces:
java.io.Serializable, OptionHandler, StreamableFilter, UnsupervisedFilter

public class ChangeDateFormat
extends Filter
implements UnsupervisedFilter, StreamableFilter, OptionHandler

Changes the date format used by a date attribute. This is most useful for converting to a format with less precision, for example, from an absolute date to day of year, etc. This changes the format string, and changes the date values to those that would be parsed by the new format.

Valid filter-specific options are:

-C col
The column containing the date attribute to be changed. (default last)

-F format
The output date format (default corresponds to ISO-8601 format).

Version:
$Revision: 1.1 $
Author:
Len Trigg
See Also:
Serialized Form

Constructor Summary
ChangeDateFormat()
           
 
Method Summary
 java.lang.String attributeIndexTipText()
           
 java.lang.String dateFormatTipText()
           
 java.lang.String getAttributeIndex()
          Gets the index of the attribute converted.
 java.text.SimpleDateFormat getDateFormat()
          Get the date format used in output.
 java.lang.String[] getOptions()
          {@inheritDoc
 java.lang.String globalInfo()
          Returns a string describing this filter
 boolean input(Instance instance)
          {@inheritDoc
 java.util.Enumeration listOptions()
          {@inheritDoc
static void main(java.lang.String[] argv)
          Main method for testing this class.
 void setAttributeIndex(java.lang.String attIndex)
          Sets the index of the attribute used.
 void setDateFormat(java.text.SimpleDateFormat dateFormat)
          Sets the output date format.
 void setDateFormat(java.lang.String dateFormat)
          Sets the output date format.
 boolean setInputFormat(Instances instanceInfo)
          {@inheritDoc
 void setOptions(java.lang.String[] options)
          Parses the options for this object.
 
Methods inherited from class weka.filters.Filter
batchFilterFile, batchFinished, filterFile, getOutputFormat, inputFormat, isOutputFormatDefined, numPendingOutput, output, outputFormat, outputPeek, useFilter
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChangeDateFormat

public ChangeDateFormat()
Method Detail

globalInfo

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

setInputFormat

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

Overrides:
setInputFormat in class Filter
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

input

public boolean input(Instance instance)
{@inheritDoc

Overrides:
input in class Filter
Parameters:
instance - the input instance
Returns:
true if the filtered instance may now be collected with output().

listOptions

public java.util.Enumeration listOptions()
{@inheritDoc

Specified by:
listOptions in interface OptionHandler
Returns:
an enumeration of all available options.

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception
Parses the options for this object. Valid options are:

-C col
The column containing the date attribute to be changed. (default last)

-F index
The output date format (default corresponds to ISO-8601 format).

Specified by:
setOptions in interface OptionHandler
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()
{@inheritDoc

Specified by:
getOptions in interface OptionHandler
Returns:
the list of current option settings as an array of strings

attributeIndexTipText

public java.lang.String attributeIndexTipText()
Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui

getAttributeIndex

public java.lang.String getAttributeIndex()
Gets the index of the attribute converted.

Returns:
the index of the attribute

setAttributeIndex

public void setAttributeIndex(java.lang.String attIndex)
Sets the index of the attribute used.

Parameters:
index - the index of the attribute

dateFormatTipText

public java.lang.String dateFormatTipText()
Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui

getDateFormat

public java.text.SimpleDateFormat getDateFormat()
Get the date format used in output.

Returns:
the output date format.

setDateFormat

public void setDateFormat(java.lang.String dateFormat)
Sets the output date format.

Parameters:
index - the output date format.

setDateFormat

public void setDateFormat(java.text.SimpleDateFormat dateFormat)
Sets the output date format.

Parameters:
index - the output date format.

main

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