com.isti.trinetwatch.emailer
Interface ReportDataBlock

All Superinterfaces:

java.lang.Comparable

All Known Implementing Classes:

StationReportBlock, SubsetReportBlock

public interface ReportDataBlock

extends java.lang.Comparable

Interface ReportDataBlock defines methods for station and subset data reports.

Method Summary

int	compareTo(java.lang.Object cmpObj) Compares this object with the given object for order.
java.lang.String	getDetailDisplayString(boolean shortFlag, java.lang.String indentStr) Returns a report-format display string of the "detail" items in this data block.
java.lang.String	getDisplayString(boolean showTimeFlag) Returns a report-format display string of the items in this data block.
java.lang.String	getDisplayString(boolean showTimeFlag, boolean noNameFlag) Returns a report-format display string of the items in this data block.
java.lang.String	getName() Returns the item name.
java.lang.String	getShortDisplayString() Returns a short-version report-format display string of the items in this data block.
long	getTimeVal() Returns the time value associated with the data (in seconds since 1/1/1970).

Method Detail

getName

public java.lang.String getName()

Returns the item name.

Returns:

The item name.

getTimeVal

public long getTimeVal()

Returns the time value associated with the data (in seconds since 1/1/1970).

Returns:

The time value associated with the data (in seconds since 1/1/1970).

getDisplayString

public java.lang.String getDisplayString(boolean showTimeFlag,
                                         boolean noNameFlag)

Returns a report-format display string of the items in this data block.

Parameters:

showTimeFlag - true to display the time value with the data.

noNameFlag - true to not display the item name and to put the time value after the data, false to display the name and to put the time value before the data.

Returns:

A report-format display string of the items in this data block.

getDisplayString

public java.lang.String getDisplayString(boolean showTimeFlag)

Returns a report-format display string of the items in this data block.

Parameters:

showTimeFlag - true to display the time value after the data.

Returns:

A report-format display string of the items in this data block.

getShortDisplayString

public java.lang.String getShortDisplayString()

Returns a short-version report-format display string of the items in this data block.

Returns:

A short-version report-format display string of the items in this data block.

getDetailDisplayString

public java.lang.String getDetailDisplayString(boolean shortFlag,
                                               java.lang.String indentStr)

Returns a report-format display string of the "detail" items in this data block.

Parameters:

shortFlag - if true then a short version of the display string is returned.

indentStr - indentation to use, or null for default indentation.

Returns:

A report-format display string of the items in this data block.

compareTo

public int compareTo(java.lang.Object cmpObj)

Compares this object with the given object for order.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

cmpObj - a 'ReportDataBlock' object to compare to.

Returns:

A negative integer, zero or a positive integer as this object is less than, equal to or greater than the given object.

Throws:

'ClassCastException' - if the given object is not of a matching type.