com.prosyst.mprm.admin.statistics

Class PeriodInfo

java.lang.Object

com.prosyst.mprm.admin.statistics.PeriodInfo

All Implemented Interfaces:

Externalizable

public class PeriodInfo
extends java.lang.Object
implements Externalizable

This class represents an object that holds the value of a statistic for given period as well as the samples used to calculate it. It could (if available - when single sample has been used) provide the record time.

Constructor Summary

Constructors

Constructor and Description
PeriodInfo() Empty constructor for externalization.
PeriodInfo(long startTime, long endTime, long recordTime, java.lang.Number value, int sampleCount) Create period info.

Method Summary

Modifier and Type	Method and Description
java.util.Date	getEndDate() Returns the end of the represented period.
long	getEndTime() Returns the end of the represented period.
java.util.Date	getRecordDate() Returns the last moment when the value of the statistic was calculated for the represented period.
long	getRecordTime() Returns the last moment when the value of the statistic was calculated for the represented period.
int	getSampleCount() Returns the count of the samples for this period.
java.util.Date	getStartDate() Returns the start of the represented period.
long	getStartTime() Returns the start of the represented period.
java.lang.Number	getValue() Returns the value of the statistic for this period.
void	readObject(java.io.InputStream is) Deserialization method - for internal use.
java.lang.String	toString()
void	writeObject(java.io.OutputStream os) Serialization method - for internal use.

Methods inherited from class java.lang.Object

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

Constructor Detail

PeriodInfo

public PeriodInfo()

Empty constructor for externalization. For internal use.

PeriodInfo

public PeriodInfo(long startTime,
                  long endTime,
                  long recordTime,
                  java.lang.Number value,
                  int sampleCount)

Create period info.

Parameters:

startTime - start time of the period (inclusive)

endTime - end time of the period (exclusive)

recordTime - record time (if available)

value - value of the quantity for the period.

sampleCount - used samples count for that period.

Method Detail

getStartDate

public java.util.Date getStartDate()

Returns the start of the represented period.

Returns:

start of the period

getEndDate

public java.util.Date getEndDate()

Returns the end of the represented period.

Returns:

end of the period

getRecordDate

public java.util.Date getRecordDate()

Returns the last moment when the value of the statistic was calculated for the represented period. Meaningful for some of the statistics (e.g. minimum, maximum).

Returns:

record time

getValue

public java.lang.Number getValue()

Returns the value of the statistic for this period.

Returns:

statistic's value

getSampleCount

public int getSampleCount()

Returns the count of the samples for this period.

Returns:

the count of the samples for this period. -1 if the count is not available/related.

getStartTime

public long getStartTime()

Returns the start of the represented period.

Returns:

start of the period

getEndTime

public long getEndTime()

Returns the end of the represented period.

Returns:

end of the period

getRecordTime

public long getRecordTime()

Returns the last moment when the value of the statistic was calculated for the represented period. Meaningful for some of the statistics (e.g. minimum, maximum).

Returns:

record time

writeObject

public void writeObject(java.io.OutputStream os)
                 throws java.io.IOException

Serialization method - for internal use.

Specified by:

writeObject in interface Externalizable

Throws:

java.io.IOException

readObject

public void readObject(java.io.InputStream is)
                throws java.io.IOException

Deserialization method - for internal use.

Specified by:

readObject in interface Externalizable

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object