net.agmodel.physical
Class SummaryKind

java.lang.Object
  net.agmodel.physical.SummaryKind

All Implemented Interfaces:

Comparable, Serializable

public final class SummaryKind

extends Object

implements Serializable, Comparable

A set of type-safe constants that represent the different ways of summarising data. Supports locale dependent names for each kind, and iteration through the set. Use them just like standard int constants eg SummaryKind.AVERAGE
Follows the style for typed classes described in "Create enumerated constants in Java" by Eric Armstrong JavaWorld July 1997 Uses the resource bundle net.agmodel.resources.PhysicalResources

Author:

Matthew Laurenson

See Also:

Serialized Form

Field Summary

static SummaryKind	AVERAGE Each datum represents the average of a set of more detailed data
static SummaryKind	EXTREMA Each data pair represents the maximum and minimum of a set of more detailed data
static SummaryKind	MAXIMUM Each datum represents the highest value of a set of more detailed data
static SummaryKind	MINIMUM Each datum represents the lowest value of a set of more detailed data
int	ord Used to provide an equivalent of the ord(A) function.
static SummaryKind	SAMPLE Each datum consists of a single representative value from a set of more detailed data
String	summaryKindName
static SummaryKind	TOTAL Each datum represents the accumulated sum of a set of more detailed data

Method Summary

int	compareTo(Object a)
boolean	equals(Object a)
static SummaryKind	first()
String	getName()
int	hashCode()
static Iterator	iterator()
static SummaryKind	last()
SummaryKind	next()
SummaryKind	prev()
static int	size()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

TOTAL

public static final SummaryKind TOTAL

Each datum represents the accumulated sum of a set of more detailed data

AVERAGE

public static final SummaryKind AVERAGE

Each datum represents the average of a set of more detailed data

EXTREMA

public static final SummaryKind EXTREMA

Each data pair represents the maximum and minimum of a set of more detailed data

MAXIMUM

public static final SummaryKind MAXIMUM

Each datum represents the highest value of a set of more detailed data

MINIMUM

public static final SummaryKind MINIMUM

Each datum represents the lowest value of a set of more detailed data

SAMPLE

public static final SummaryKind SAMPLE

Each datum consists of a single representative value from a set of more detailed data

ord

public final int ord

Used to provide an equivalent of the ord(A) function.

summaryKindName

public String summaryKindName

Method Detail

iterator

public static Iterator iterator()

toString

public String toString()

Returns:

the name of the element in the language of the default Locale

getName

public String getName()

Returns:

the name of the element in the language of the default Locale

size

public static int size()

Returns:

the number of elements

first

public static SummaryKind first()

Returns:

the first element in the list

last

public static SummaryKind last()

Returns:

the last element in the list

prev

public SummaryKind prev()

Returns:

the previous element in the list

next

public SummaryKind next()

Returns:

the next element in the list

equals

public boolean equals(Object a)

Returns:

true if SummaryKind.A.ord==SummaryKind.B.ord, regardless of the languages used with A and B

hashCode

public int hashCode()

compareTo

public int compareTo(Object a)

Specified by:

compareTo in interface Comparable