Package com.storedobject.iot

Class Unit

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.Name

com.storedobject.iot.AbstractUnit

com.storedobject.iot.Unit

All Implemented Interfaces:

Displayable, HasName, StringFiller, HasId

Direct Known Subclasses:

SuperUnit

public abstract class Unit
extends AbstractUnit

Represents a unit with various attributes and methods for handling its statistics, ordinality, block association, and other operations. A unit is a fundamental entity that is associated with a site, block, and statistical data used for resource consumption analysis and monitoring over different time periods.
This class extends AbstractUnit and provides specific implementations and utilities for managing unit-related tasks in a structured and efficient manner.

Field Summary

Fields inherited from class com.storedobject.core.Name

name

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
Unit()	Default constructor for the Unit class.

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)	Configures the specified Columns instance by adding predefined column definitions.
void	computeStatistics(TransactionManager tm)	Computes and updates statistics for the given transaction manager based on the unit type and data classes associated with the unit.
static Unit	get(String name)	Retrieves a Unit instance that matches the given name.
Block	getBlock()	Retrieves the associated Block for the current Unit.
Id	getBlockId()	Retrieves the block ID associated with this unit.
int	getCode()	Retrieves the unique unit code associated with the unit.
final DailyStatistics	getDailyStatistics(String name)	Retrieves the DailyStatistics for a given name.
final DailyStatistics	getDailyStatistics(String name, int year, int day)	Retrieves daily statistics for a given name, year, and day.
final <D extends Date> DailyStatistics	getDailyStatistics(String name, D date)	Retrieves the daily statistics for a given name and date.
final HourlyStatistics	getHourlyStatistics(String name)	Retrieves the hourly statistics for a given name.
final HourlyStatistics	getHourlyStatistics(String name, int year, int hour)	Retrieves the hourly statistics for a specific name, year, and hour.
final <D extends Date> HourlyStatistics	getHourlyStatistics(String name, D date)	Retrieves the hourly statistics for the specified name and date.
int	getLayoutStyle()	Retrieves the layout style identifier for this unit's associated block.
final MonthlyStatistics	getMonthlyStatistics(String name)	Retrieves the monthly statistics for the given name.
final MonthlyStatistics	getMonthlyStatistics(String name, int year, int month)	Retrieves the monthly statistics for the specified name, year, and month.
final <D extends Date> MonthlyStatistics	getMonthlyStatistics(String name, D date)	Retrieves the monthly statistics for the specified name and date.
int	getOrdinality()	Gets the ordinality of this unit, which represents its order or sequence in some context.
String	getOrdinalityValue()	Retrieves the descriptive string corresponding to the current object's ordinality value.
static String	getOrdinalityValue(int ordinality)	Retrieves the ordinality value corresponding to the specified ordinality index.
static String[]	getOrdinalityValues()	Retrieves an array of ordinality values associated with the Unit class.
final Site	getSite()	Retrieves the associated Site for this unit.
final Id	getSiteId()	Retrieves the identifier of the associated site.
final UnitType	getType()	Retrieves the type of this unit as an instance of UnitType.
final WeeklyStatistics	getWeeklyStatistics(String name)	Retrieves the weekly statistics for the given name.
final WeeklyStatistics	getWeeklyStatistics(String name, int year, int week)	Retrieves weekly statistics for a specific name, year, and week.
final <D extends Date> WeeklyStatistics	getWeeklyStatistics(String name, D date)	Retrieves weekly statistics for the specified name and date.
final YearlyStatistics	getYearlyStatistics(String name)	Retrieves the yearly statistics for a given name.
final YearlyStatistics	getYearlyStatistics(String name, int year)	Retrieves the yearly statistics for a given name and year.
final <D extends Date> YearlyStatistics	getYearlyStatistics(String name, D date)	Retrieves the yearly statistics for the given name and date.
static int	hints()	Provides a hint about the type of object or structure used within this context.
static void	indices(Indices indices)	Configures indices for the Unit instance.
static String[]	links()	Provides a list of links to related classes or resources in the system.
static ObjectIterator<? extends Unit>	list(String name)	Lists the Unit objects based on the given name.
final List<DailyStatistics>	listDailyStatistics(String name, int year, int dayFrom, int dayTo)	Retrieves a list of daily statistics filtered by the specified name, year, and day range.
final List<DailyStatistics>	listDailyStatistics(String name, int yearFrom, int dayFrom, int yearTo, int dayTo)	Retrieves a list of daily statistics within a specified date range.
final List<DailyStatistics>	listDailyStatistics(String name, Site site, int periodCount)	Retrieves a list of daily statistics for the specified parameters.
final List<HourlyStatistics>	listHourlyStatistics(String name, int year, int hourFrom, int hourTo)	Retrieves a list of hourly statistics for a given name and year within the specified hour range.
final List<HourlyStatistics>	listHourlyStatistics(String name, int yearFrom, int hourFrom, int yearTo, int hourTo)	Retrieves hourly statistics for a given name across a specified time range.
final List<HourlyStatistics>	listHourlyStatistics(String name, Site site, int periodCount)	Retrieves a list of HourlyStatistics for a specified name, site, and period count.
final List<MonthlyStatistics>	listMonthlyStatistics(String name, int year, int monthFrom, int monthTo)	Retrieves a list of monthly statistics based on the specified parameters.
final List<MonthlyStatistics>	listMonthlyStatistics(String name, int yearFrom, int monthFrom, int yearTo, int monthTo)	Retrieves a list of monthly statistics for a given name within a specified date range.
final List<MonthlyStatistics>	listMonthlyStatistics(String name, Site site, int periodCount)	Retrieves a list of monthly statistics for a given site and time period.
final List<WeeklyStatistics>	listWeeklyStatistics(String name, int year, int weekFrom, int weekTo)	Retrieves a list of weekly statistics for the specified name and year within the given week range.
final List<WeeklyStatistics>	listWeeklyStatistics(String name, int yearFrom, int weekFrom, int yearTo, int weekTo)	Retrieves a list of weekly statistics for a given name, over a specified range of years and weeks.
final List<WeeklyStatistics>	listWeeklyStatistics(String name, Site site, int periodCount)	Retrieves a list of weekly statistics based on the specified parameters.
final List<YearlyStatistics>	listYearlyStatistics(String name, int yearFrom, int yearTo)	Retrieves a list of yearly statistics for a given name and within a specified year range.
final List<YearlyStatistics>	listYearlyStatistics(String name, Site site, int periodCount)	Retrieves a list of yearly statistics for a specified entity within a given time period.
void	recomputeStatistics(TransactionManager tm)	Recomputes all statistics for the current unit by first deleting the existing statistics and then regenerating them.
void	saved()	Overridden method that is invoked when the object's state has been saved successfully.
void	setBlock(Id blockId)	Sets the block identifier for this Unit.
void	setBlock(Block block)	Sets the block associated with this unit.
void	setBlock(BigDecimal idValue)	Sets the block for the unit using the specified block identifier value.
void	setCode(int code)	Sets the unique code for the Unit.
void	setOrdinality(int ordinality)	Sets the ordinality value for the unit.
String	toDisplay()	Converts the object to a displayable string format, combining the super class's display string with this instance's code value in parentheses.
void	validateData(TransactionManager tm)	Validates the Unit's data by ensuring the blockId is associated with an instance of the Block class and invoking additional data validation logic from the superclass.

Methods inherited from class com.storedobject.iot.AbstractUnit

computeConsumption, consumes, consumes, getActive, getConsumptionCalculator, getDailyConsumption, getDailyConsumption, getDailyConsumption, getHourlyConsumption, getHourlyConsumption, getHourlyConsumption, getMonthlyConsumption, getMonthlyConsumption, getMonthlyConsumption, getWeeklyConsumption, getWeeklyConsumption, getWeeklyConsumption, getYearlyConsumption, getYearlyConsumption, getYearlyConsumption, listDailyConsumption, listDailyConsumption, listDailyConsumption, listHourlyConsumption, listHourlyConsumption, listHourlyConsumption, listMonthlyConsumption, listMonthlyConsumption, listMonthlyConsumption, listWeeklyConsumption, listWeeklyConsumption, listWeeklyConsumption, listYearlyConsumption, listYearlyConsumption, setActive

Methods inherited from class com.storedobject.core.Name

getName, getUniqueCondition, setName, toString

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getAttachment, getAttachmentId, getChildren, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

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

Constructor Details

Unit

public Unit()

Default constructor for the Unit class. Initializes a new instance of the Unit class.

Method Details

columns

public static void columns(Columns columns)

Configures the specified Columns instance by adding predefined column definitions.

Parameters:

columns - the Columns object to be configured; it will have additional column definitions added, specifically "Block" with data type "id", "Code" with data type "int", and "Ordinality" with data type "int".

indices

public static void indices(Indices indices)

Configures indices for the Unit instance.

Parameters:

indices - The Indices object to which index definitions are added.

links

public static String[] links()

Provides a list of links to related classes or resources in the system.

Returns:

An array of strings where each string represents a link with the format "Description|ClassPath".

saved

public void saved()
           throws Exception

Overridden method that is invoked when the object's state has been saved successfully. This method calls the parent class's `saved()` method to ensure that any additional saving logic from the superclass is executed. After the superclass logic is executed, it triggers a refresh operation for the `DataSet` to ensure any associated data is updated and synchronized if applicable.

Overrides:

saved in class StoredObject

Throws:

Exception - if an error occurs during the save or refresh process

get

public static Unit get(String name)

Retrieves a Unit instance that matches the given name.

Parameters:

name - the name of the Unit to retrieve

Returns:

the Unit instance corresponding to the given name, or null if no match is found

list

public static ObjectIterator<? extends Unit> list(String name)

Lists the Unit objects based on the given name.

Parameters:

name - The name of the unit to list.

Returns:

An iterator providing access to the list of Unit objects matching the given name.

hints

public static int hints()

Provides a hint about the type of object or structure used within this context.

Returns:

A constant value representing a hint, such as ObjectHint.SMALL_LIST.

setBlock

public void setBlock(Id blockId)

Sets the block identifier for this Unit.

Parameters:

blockId - the identifier of the block to associate with this Unit

setBlock

public void setBlock(BigDecimal idValue)

Sets the block for the unit using the specified block identifier value.

Parameters:

idValue - The identifier value of the block as a BigDecimal.

setBlock

public void setBlock(Block block)

Sets the block associated with this unit.

Parameters:

block - The block to be set. If null, the block ID will be set to null; otherwise, the block's ID will be used to set the block.

getBlockId

@Column(order=200)
public Id getBlockId()

Retrieves the block ID associated with this unit.

Specified by:

getBlockId in class AbstractUnit

Returns:

The block ID of the unit as an instance of Id.

getBlock

public Block getBlock()

Retrieves the associated Block for the current Unit. If the block is not already loaded, it is fetched and initialized using the getRelated() method with the block ID.

Returns:

The associated Block instance. If the block is not set, it will attempt to retrieve it using the related block ID.

setCode

public void setCode(int code)

Sets the unique code for the Unit.

Parameters:

code - the unique integer code that identifies the Unit

getCode

@Column(order=300,
        caption="Unique Unit Code")
public int getCode()

Retrieves the unique unit code associated with the unit.

Returns:

the unique code of the unit

setOrdinality

public void setOrdinality(int ordinality)

Sets the ordinality value for the unit.

Parameters:

ordinality - The ordinality value to set.

getOrdinality

@Column(order=400)
public int getOrdinality()

Gets the ordinality of this unit, which represents its order or sequence in some context.

Returns:

the ordinality of the unit as an integer

getOrdinalityValue

public String getOrdinalityValue()

Retrieves the descriptive string corresponding to the current object's ordinality value.

Returns:

The string representation of the ordinality value for this instance.

getOrdinalityValue

public static String getOrdinalityValue(int ordinality)

Retrieves the ordinality value corresponding to the specified ordinality index.

Parameters:

ordinality - The ordinality index to determine the ordinality value.

Returns:

A string representation of the ordinality value based on the provided index.

getOrdinalityValues

public static String[] getOrdinalityValues()

Retrieves an array of ordinality values associated with the Unit class.

Returns:

A string array containing the ordinality values.

getLayoutStyle

public int getLayoutStyle()

Retrieves the layout style identifier for this unit's associated block.

Returns:

An integer representing the layout style of the associated block.

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Validates the Unit's data by ensuring the blockId is associated with an instance of the Block class and invoking additional data validation logic from the superclass.

Overrides:

validateData in class Name

Parameters:

tm - The TransactionManager used to perform validation operations.

Throws:

Exception - If validation fails or an error occurs during the validation process.

getSite

public final Site getSite()

Retrieves the associated Site for this unit. If the site is not already set, it initializes the site field by fetching the site from the associated block.

Specified by:

getSite in class AbstractUnit

Returns:

The Site object associated with this unit. If the site is not set, it retrieves the site from the block and returns it.

getSiteId

public final Id getSiteId()

Retrieves the identifier of the associated site. If the site is defined for the current instance, its identifier is returned. Otherwise, the site identifier is retrieved from the associated block.

Returns:

The identifier of the site as an Id object.

getType

public final UnitType getType()

Retrieves the type of this unit as an instance of UnitType. This method attempts to create and return a UnitType object based on the class of this unit. If an exception occurs during the creation process, it returns null.

Returns:

The UnitType instance representing the type of this unit, or null if the type cannot be determined.

recomputeStatistics

public void recomputeStatistics(TransactionManager tm)
                         throws Exception

Recomputes all statistics for the current unit by first deleting the existing statistics and then regenerating them.

Parameters:

tm - The TransactionManager instance used for performing the necessary database transactions.

Throws:

Exception - If an error occurs during the recomputation process, including database transaction failures or operations on statistics.

computeStatistics

public void computeStatistics(TransactionManager tm)
                       throws Exception

Computes and updates statistics for the given transaction manager based on the unit type and data classes associated with the unit.

Parameters:

tm - The transaction manager instance responsible for managing database transactions during the computation of statistics.

Throws:

Exception - If any exception occurs during the computation or interaction with the data methods.

listYearlyStatistics

public final List<YearlyStatistics> listYearlyStatistics(String name,
 int yearFrom,
 int yearTo)

Retrieves a list of yearly statistics for a given name and within a specified year range.

Parameters:

name - the name for which statistics are being retrieved

yearFrom - the starting year of the range

yearTo - the ending year of the range

Returns:

a list of YearlyStatistics objects within the specified year range for the given name

listYearlyStatistics

public final List<YearlyStatistics> listYearlyStatistics(String name,
 Site site,
 int periodCount)

Retrieves a list of yearly statistics for a specified entity within a given time period.

Parameters:

name - the name of the entity for which yearly statistics are to be retrieved

site - the site associated with the entity

periodCount - the number of years for which statistics should be retrieved, counting backwards from the current year

Returns:

a list of YearlyStatistics representing the yearly data for the specified entity and period

getYearlyStatistics

public final YearlyStatistics getYearlyStatistics(String name,
 int year)

Retrieves the yearly statistics for a given name and year.

Parameters:

name - the name identifier for which the statistics are to be retrieved

year - the year for which the statistics are requested

Returns:

an instance of YearlyStatistics containing the data for the specified name and year

getYearlyStatistics

public final <D extends Date> YearlyStatistics getYearlyStatistics(String name,
 D date)

Retrieves the yearly statistics for the given name and date.

Parameters:

name - the name for which the yearly statistics are to be retrieved

date - the date used to determine the year for the statistics

Returns:

the yearly statistics corresponding to the given name and year derived from the date

listMonthlyStatistics

public final List<MonthlyStatistics> listMonthlyStatistics(String name,
 int year,
 int monthFrom,
 int monthTo)

Retrieves a list of monthly statistics based on the specified parameters.

Parameters:

name - the name of the entity for which statistics are retrieved

year - the year for the data to be retrieved

monthFrom - the starting month (inclusive) for the data range

monthTo - the ending month (inclusive) for the data range

Returns:

a list of MonthlyStatistics objects representing the retrieved data

listMonthlyStatistics

public final List<MonthlyStatistics> listMonthlyStatistics(String name,
 int yearFrom,
 int monthFrom,
 int yearTo,
 int monthTo)

Retrieves a list of monthly statistics for a given name within a specified date range.

Parameters:

name - the name for which statistics need to be retrieved

yearFrom - the starting year of the desired date range

monthFrom - the starting month of the desired date range

yearTo - the ending year of the desired date range

monthTo - the ending month of the desired date range

Returns:

a list of MonthlyStatistics objects within the specified range; an empty list if the range is invalid or no statistics are available

listMonthlyStatistics

public final List<MonthlyStatistics> listMonthlyStatistics(String name,
 Site site,
 int periodCount)

Retrieves a list of monthly statistics for a given site and time period.

Parameters:

name - the name or identifier for the entity whose statistics are being retrieved

site - the site for which the statistics are to be generated

periodCount - the number of months for which the statistics should be retrieved

Returns:

a list of MonthlyStatistics objects containing the requested data

getMonthlyStatistics

public final MonthlyStatistics getMonthlyStatistics(String name,
 int year,
 int month)

Retrieves the monthly statistics for the specified name, year, and month.

Parameters:

name - the identifier for which the statistics are retrieved

year - the year for which the statistics are retrieved

month - the month for which the statistics are retrieved

Returns:

an instance of MonthlyStatistics containing the relevant data for the specified parameters

getMonthlyStatistics

public final <D extends Date> MonthlyStatistics getMonthlyStatistics(String name,
 D date)

Retrieves the monthly statistics for the specified name and date.

Parameters:

name - the identifier for which the monthly statistics are to be retrieved

date - the date object used to extract the month and year for the statistics

Returns:

the monthly statistics based on the provided name and date

listWeeklyStatistics

public final List<WeeklyStatistics> listWeeklyStatistics(String name,
 int year,
 int weekFrom,
 int weekTo)

Retrieves a list of weekly statistics for the specified name and year within the given week range. The method supports querying statistics for a single week, a range of weeks within the same year, or for weeks spanning across two consecutive years.

Parameters:

name - the name associated with the statistics being queried

year - the starting year for the week range

weekFrom - the starting week number (inclusive)

weekTo - the ending week number (inclusive)

Returns:

a list of weekly statistics for the specified parameters

listWeeklyStatistics

public final List<WeeklyStatistics> listWeeklyStatistics(String name,
 int yearFrom,
 int weekFrom,
 int yearTo,
 int weekTo)

Retrieves a list of weekly statistics for a given name, over a specified range of years and weeks.

Parameters:

name - the name for which the weekly statistics are to be retrieved

yearFrom - the starting year of the range

weekFrom - the starting week of the range within the starting year

yearTo - the ending year of the range

weekTo - the ending week of the range within the ending year

Returns:

a list of WeeklyStatistics for the specified range, or an empty list if the range is invalid

listWeeklyStatistics

public final List<WeeklyStatistics> listWeeklyStatistics(String name,
 Site site,
 int periodCount)

Retrieves a list of weekly statistics based on the specified parameters.

Parameters:

name - the name associated with the statistics to be retrieved

site - the site for which the statistics are to be generated

periodCount - the number of periods (weeks) to include in the statistics

Returns:

a list of WeeklyStatistics that match the specified criteria

getWeeklyStatistics

public final WeeklyStatistics getWeeklyStatistics(String name,
 int year,
 int week)

Retrieves weekly statistics for a specific name, year, and week.

Parameters:

name - the identifier for which the weekly statistics are to be retrieved

year - the year for the desired weekly statistics

week - the week in the specified year for the desired statistics

Returns:

an instance of WeeklyStatistics representing the data for the specified name, year, and week

getWeeklyStatistics

public final <D extends Date> WeeklyStatistics getWeeklyStatistics(String name,
 D date)

Retrieves weekly statistics for the specified name and date.

Type Parameters:

D - a type that extends java.util.Date

Parameters:

name - the name associated with the statistics to retrieve

date - the date used to determine the year and week for the statistics

Returns:

a WeeklyStatistics object containing the statistics for the specified name and date

listHourlyStatistics

public final List<HourlyStatistics> listHourlyStatistics(String name,
 int year,
 int hourFrom,
 int hourTo)

Retrieves a list of hourly statistics for a given name and year within the specified hour range.

Parameters:

name - the name for which hourly statistics are to be retrieved

year - the year for which hourly statistics are to be retrieved

hourFrom - the starting hour of the range

hourTo - the ending hour of the range

Returns:

a list of HourlyStatistics objects containing data for the specified range

listHourlyStatistics

public final List<HourlyStatistics> listHourlyStatistics(String name,
 int yearFrom,
 int hourFrom,
 int yearTo,
 int hourTo)

Retrieves hourly statistics for a given name across a specified time range.

Parameters:

name - the name for which hourly statistics are being retrieved

yearFrom - the starting year of the range

hourFrom - the starting hour of the range in the starting year

yearTo - the ending year of the range

hourTo - the ending hour of the range in the ending year

Returns:

a list of hourly statistics for the specified name and time range, or an empty list if the range is invalid

listHourlyStatistics

public final List<HourlyStatistics> listHourlyStatistics(String name,
 Site site,
 int periodCount)

Retrieves a list of HourlyStatistics for a specified name, site, and period count.

Parameters:

name - the identifier for which hourly statistics are requested

site - the site associated with the hourly statistics

periodCount - the number of periods to retrieve statistics for

Returns:

a list of HourlyStatistics objects representing the data for the specified parameters

getHourlyStatistics

public final HourlyStatistics getHourlyStatistics(String name,
 int year,
 int hour)

Retrieves the hourly statistics for a specific name, year, and hour.

Parameters:

name - the name identifier for which the statistics are to be retrieved

year - the year for which the statistics are to be retrieved

hour - the specific hour of the day (0-23) for which the statistics are to be retrieved

Returns:

an instance of HourlyStatistics containing the relevant data for the specified parameters

getHourlyStatistics

public final <D extends Date> HourlyStatistics getHourlyStatistics(String name,
 D date)

Retrieves the hourly statistics for the specified name and date.

Type Parameters:

D - the type of the date parameter, which must extend java.util.Date

Parameters:

name - the name for which the hourly statistics are to be retrieved

date - the date object specifying the year and hour of the statistics

Returns:

an HourlyStatistics object containing the statistics for the given name and date

listDailyStatistics

public final List<DailyStatistics> listDailyStatistics(String name,
 int year,
 int dayFrom,
 int dayTo)

Retrieves a list of daily statistics filtered by the specified name, year, and day range.

Parameters:

name - the name identifier for the daily statistics

year - the year to filter the statistics

dayFrom - the starting day of the range (inclusive)

dayTo - the ending day of the range (inclusive)

Returns:

a list of DailyStatistics objects within the specified range

listDailyStatistics

public final List<DailyStatistics> listDailyStatistics(String name,
 int yearFrom,
 int dayFrom,
 int yearTo,
 int dayTo)

Retrieves a list of daily statistics within a specified date range.

Parameters:

name - the name of the entity for which the statistics are being retrieved

yearFrom - the starting year of the range

dayFrom - the starting day of the year in the range

yearTo - the ending year of the range

dayTo - the ending day of the year in the range

Returns:

a list of DailyStatistics objects representing the statistics for each day within the specified date range; returns an empty list if the range is invalid

listDailyStatistics

public final List<DailyStatistics> listDailyStatistics(String name,
 Site site,
 int periodCount)

Retrieves a list of daily statistics for the specified parameters.

Parameters:

name - the name associated with the daily statistics

site - the site for which the daily statistics are being retrieved

periodCount - the number of daily periods to be considered

Returns:

a list of DailyStatistics objects for the specified parameters

getDailyStatistics

public final DailyStatistics getDailyStatistics(String name,
 int year,
 int day)

Retrieves daily statistics for a given name, year, and day.

Parameters:

name - the name associated with the statistics to retrieve

year - the year for which the statistics are being retrieved

day - the day (within the specified year) for which the statistics are being retrieved

Returns:

the daily statistics corresponding to the specified parameters

getDailyStatistics

public final <D extends Date> DailyStatistics getDailyStatistics(String name,
 D date)

Retrieves the daily statistics for a given name and date.

Type Parameters:

D - the type of the date, which extends java.util.Date

Parameters:

name - the name associated with the daily statistics

date - the date for which the daily statistics are requested

Returns:

the daily statistics corresponding to the provided name and date

getHourlyStatistics

public final HourlyStatistics getHourlyStatistics(String name)

Retrieves the hourly statistics for a given name. If the statistics are not yet available, they are fetched or created for the corresponding time period and stored for future use.

Parameters:

name - the name for which the hourly statistics are to be retrieved

Returns:

the HourlyStatistics object associated with the given name

getDailyStatistics

public final DailyStatistics getDailyStatistics(String name)

Retrieves the DailyStatistics for a given name. If the statistics are not already available, it initializes and stores a new DailyStatistics instance for the specified name and date.

Parameters:

name - the name for which the DailyStatistics are retrieved or created

Returns:

the DailyStatistics instance corresponding to the given name

getWeeklyStatistics

public final WeeklyStatistics getWeeklyStatistics(String name)

Retrieves the weekly statistics for the given name. If the statistics are not already cached, they are either fetched or created for the specified name and date.

Parameters:

name - the identifier for the statistics to be retrieved

Returns:

the WeeklyStatistics object corresponding to the specified name

getMonthlyStatistics

public final MonthlyStatistics getMonthlyStatistics(String name)

Retrieves the monthly statistics for the given name. If no statistics are found, it attempts to generate or retrieve statistics for the previous month.

Parameters:

name - the name for which the monthly statistics are required

Returns:

the MonthlyStatistics object corresponding to the given name

getYearlyStatistics

public final YearlyStatistics getYearlyStatistics(String name)

Retrieves the yearly statistics for a given name. If the statistics do not exist, it will attempt to create and cache the statistics for the specified name.

Parameters:

name - the name for which the yearly statistics are retrieved

Returns:

the YearlyStatistics object associated with the given name

toDisplay

public String toDisplay()

Converts the object to a displayable string format, combining the super class's display string with this instance's code value in parentheses.

Specified by:

toDisplay in interface Displayable

Overrides:

toDisplay in class StoredObject

Returns:

a formatted string combining the super class display string and the code value.