org.dspace.app.statistics

Class Stat

java.lang.Object

org.dspace.app.statistics.Stat

All Implemented Interfaces:

java.lang.Comparable

public class Stat
extends java.lang.Object
implements java.lang.Comparable

This is a primitive class to represent a single statistic, which will generally be a key value pair but with the capabilities for being sorted Note: this class has a natural ordering that is inconsistent with equals

Author:

Richard Jones

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o) compare the current object to the given object returning -1 if o is less than the current object, 0 if they are the same, and +1 if o is greater than the current object.
java.lang.String	getKey() get the key (text describing) the statistic
java.lang.String	getReference() get the reference to related statistic information
java.lang.String	getUnits() get the unts that this statistic is measured in
int	getValue() get the value of the statistic
void	setKey(java.lang.String key) set the reference information
void	setReference(java.lang.String reference) set the reference information
void	setUnits(java.lang.String unit) set the units of this statistic

Methods inherited from class java.lang.Object

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

Method Detail

setUnits

public void setUnits(java.lang.String unit)

set the units of this statistic

Parameters:

unit - the units that this statistic is measured in

getUnits

public java.lang.String getUnits()

get the unts that this statistic is measured in

Returns:

the units this statistic is measured in

getValue

public int getValue()

get the value of the statistic

Returns:

the value of this statistic

getKey

public java.lang.String getKey()

get the key (text describing) the statistic

Returns:

the key for this statistic

getReference

public java.lang.String getReference()

get the reference to related statistic information

Returns:

the reference for this statistic

setKey

public void setKey(java.lang.String key)

set the reference information

Parameters:

key - the key for this statistic

setReference

public void setReference(java.lang.String reference)

set the reference information

Parameters:

reference - the reference for this statistic

compareTo

public int compareTo(java.lang.Object o)

compare the current object to the given object returning -1 if o is less than the current object, 0 if they are the same, and +1 if o is greater than the current object.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

o - the object to compare to the current one

Returns:

+1, 0, -1 if o is less than, equal to, or greater than the current object value.