weka.classifiers.timeseries.core

Class CustomPeriodicTest

java.lang.Object

weka.classifiers.timeseries.core.CustomPeriodicTest

All Implemented Interfaces:

Serializable

public class CustomPeriodicTest
extends Object
implements Serializable

Class that evaluates a supplied date against user-specified date constant fields. Fields that can be tested against include year, month, week of year, week of month, day of year, day of month, day of week, hour of day, minute of hour and second. Wildcard "*" matches any value for a particular field. Each CustomPeriodicTest is made up of one or two test parts. If the first test part's operator is "=", then no second part is necessary. Otherwise the first test part may use > or >= operators and the second test part < or <= operators. Taken together, the two parts define an interval. An optional label may be associated with the interval.

Version:

$Revision: 45163 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomPeriodicTest.Operator Enum defining inequality operations
class	CustomPeriodicTest.TestPart Inner class defining one boundary of an interval

Constructor Summary

Constructors

Constructor and Description
CustomPeriodicTest(String theTest) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	evaluate(Date d) Evaluate the supplied date with respect to this custom periodic test interval
String	getLabel() Get the optional label for this interval.
CustomPeriodicTest.TestPart	getLowerTest() Get the lower bound test
CustomPeriodicTest.TestPart	getUpperTest() Get the upper bound test
static void	main(String[] args) Main method for testing this class
void	setLabel(String label) Set the label for this interval
void	setTest(String theTest) Set the test as a String
String	toString() Returns a textual description of this test

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CustomPeriodicTest

public CustomPeriodicTest(String theTest)
                   throws IllegalArgumentException

Constructor.

Parameters:

theTest - the test definition as a String

Throws:

IllegalArgumentException - if the test can't be parsed or is ill defined.

Method Detail

getLowerTest

public CustomPeriodicTest.TestPart getLowerTest()

Get the lower bound test

Returns:

the lower bound test

getUpperTest

public CustomPeriodicTest.TestPart getUpperTest()

Get the upper bound test

Returns:

the upper bound test.

setTest

public void setTest(String theTest)
             throws IllegalArgumentException

Set the test as a String

Parameters:

theTest - the test

Throws:

IllegalArgumentException - if the test can't be parsed or is ill defined.

getLabel

public String getLabel()

Get the optional label for this interval.

Returns:

the label for this interval

setLabel

public void setLabel(String label)

Set the label for this interval

Parameters:

label - the label for this interval

evaluate

public boolean evaluate(Date d)

Evaluate the supplied date with respect to this custom periodic test interval

Parameters:

d - the date to test

Returns:

true if the date lies within the interval.

toString

public String toString()

Returns a textual description of this test

Overrides:

toString in class Object

Returns:

a textual description of this test

main

public static void main(String[] args)

Main method for testing this class

Parameters:

args - command line arguments - first element should contain a textual definition of a test