org.otfeed.command
Class AggregationSpan

java.lang.Object
  org.otfeed.command.AggregationSpan

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AggregationSpan>

public class AggregationSpan
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<AggregationSpan>

Represents aggregation time span.

Time span can range from 2 ticks, to years.

See Also:

Serialized Form

Field Summary

int	length
TimeUnitEnum	units

Constructor Summary

AggregationSpan(TimeUnitEnum units, int length)
Creates a new aggreagation span.

Method Summary

int	compareTo(AggregationSpan other)
static AggregationSpan	days() Returns a one-day aggregation span.
static AggregationSpan	days(int num) Returns aggregation span measured in days.
boolean	equals(java.lang.Object other)
int	hashCode()
static AggregationSpan	hours() Returns a one-hour aggregation span.
static AggregationSpan	hours(int num) Returns aggregation span measured in hours.
static AggregationSpan	minutes() Returns a one-minute aggregation span.
static AggregationSpan	minutes(int num) Returns aggregation span measured in minutes.
static AggregationSpan	months() Returns a one-month aggregation span.
static AggregationSpan	months(int num) Returns aggregation span measured in months.
static AggregationSpan	ticks(int num) Returns aggregation span measured in ticks.
java.lang.String	toString()
static AggregationSpan	weeks() Returns a one-week aggregation span.
static AggregationSpan	weeks(int num) Returns aggregation span measured in weeks.
static AggregationSpan	years() Returns a one-year aggregation span.
static AggregationSpan	years(int num) Returns aggregation span measured in years.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

units

public final TimeUnitEnum units

length

public final int length

Constructor Detail

AggregationSpan

public AggregationSpan(TimeUnitEnum units,
                       int length)

Creates a new aggreagation span.

Parameters:

units - time units (DAYS, WEEKS, etc.). A special unit of TICKS will mean that the aggregation will be done over that many ticks.

length - length of aggregation span.

Method Detail

years

public static AggregationSpan years(int num)

Returns aggregation span measured in years.

Parameters:

num - number of years (1 or greater).

Returns:

aggregation span.

years

public static AggregationSpan years()

Returns a one-year aggregation span.

Returns:

aggregation span.

months

public static AggregationSpan months(int num)

Returns aggregation span measured in months.

Parameters:

num - number of months (1 or greater).

Returns:

aggregation span.

months

public static AggregationSpan months()

Returns a one-month aggregation span.

Returns:

aggregation span.

weeks

public static AggregationSpan weeks(int num)

Returns aggregation span measured in weeks.

Parameters:

num - number of weeks (1 or greater).

Returns:

aggregation span.

weeks

public static AggregationSpan weeks()

Returns a one-week aggregation span.

Returns:

aggregation span.

days

public static AggregationSpan days(int num)

Returns aggregation span measured in days.

Parameters:

num - number of days (1 or greater).

Returns:

aggregation span.

days

public static AggregationSpan days()

Returns a one-day aggregation span.

Returns:

aggregation span.

hours

public static AggregationSpan hours(int num)

Returns aggregation span measured in hours.

Parameters:

num - number of hours (1 or greater).

Returns:

aggregation span.

hours

public static AggregationSpan hours()

Returns a one-hour aggregation span.

Returns:

aggregation span.

minutes

public static AggregationSpan minutes(int num)

Returns aggregation span measured in minutes.

Parameters:

num - number of minutes (1 or greater).

Returns:

aggregation span.

minutes

public static AggregationSpan minutes()

Returns a one-minute aggregation span.

Returns:

aggregation span.

ticks

public static AggregationSpan ticks(int num)

Returns aggregation span measured in ticks.

Parameters:

num - number of ticks (2 or greater).

Returns:

aggregation span.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(AggregationSpan other)

Specified by:

compareTo in interface java.lang.Comparable<AggregationSpan>