Package com.storedobject.iot

Class MonthlyStatistics

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.iot.Statistics<PeriodType>

com.storedobject.iot.MonthlyStatistics

All Implemented Interfaces:

Displayable, StringFiller, DBTransaction.NoHistory, HasId

public final class MonthlyStatistics
extends Statistics<PeriodType>

Represents a statistical record for a specific month. This class extends the base Statistics class and provides additional functionality to handle and retrieve details specific to monthly data.

This class includes methods to define table columns and indices for database operations, along with getters and setters to manage and retrieve the month corresponding to the statistical data.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
MonthlyStatistics()	Constructs a new instance of MonthlyStatistics.

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)	Defines a table column with the name "Month" and the data type "int".
int	getMonth()	Retrieves the month associated with this statistical record.
int	getPeriod()	Retrieves the period associated with the monthly statistics.
String	getPeriodDetail()	Retrieves a detailed representation of the period in the format "Month Year".
PeriodType	getPeriodType()	Retrieves the type of period associated with this statistical data.
static void	indices(Indices indices)	Adds database indices based on the specified column names and index type.
MonthlyStatistics	next()	Retrieves the next instance of MonthlyStatistics, representing the subsequent month based on the current instance's month and year.
MonthlyStatistics	previous()	Retrieves the MonthlyStatistics instance for the previous month.
void	setMonth(int month)	Sets the month value for this statistical record.

Methods inherited from class com.storedobject.iot.Statistics

add, add, getCount, getMax, getMean, getMin, getName, getPeriodName, getSD, getUnit, getUnitId, getYear, setCount, setMax, setMean, setMin, setName, setSD, setUnit, setUnit, setUnit, setYear, toDisplay, validateData

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, getUniqueCondition, 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, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toString, 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

MonthlyStatistics

public MonthlyStatistics()

Constructs a new instance of MonthlyStatistics.

This default constructor initializes the MonthlyStatistics object, which represents statistical data for a specific month. The instance can be further configured by setting the month and other properties as required.

Method Details

columns

public static void columns(Columns columns)

Defines a table column with the name "Month" and the data type "int".

Parameters:

columns - an instance of the Columns class used to specify column definitions

indices

public static void indices(Indices indices)

Adds database indices based on the specified column names and index type. This ensures that a unique compound index is created using the provided column names to optimize query performance.

Parameters:

indices - The Indices object used to define new database indices.

setMonth

public void setMonth(int month)

Sets the month value for this statistical record.

Parameters:

month - the month to set, represented as an integer (e.g., 1 for January, 12 for December)

getMonth

@Column(order=300)
public int getMonth()

Retrieves the month associated with this statistical record.

Returns:

the month as an integer, where 1 represents January and 12 represents December.

getPeriod

public int getPeriod()

Retrieves the period associated with the monthly statistics. This method overrides the base class implementation to return the specific month value represented as an integer.

Specified by:

getPeriod in class Statistics<PeriodType>

Returns:

the period as an integer, where the period corresponds to the month represented in the statistical record (e.g., 1 for January, 2 for February, etc.).

getPeriodDetail

public String getPeriodDetail()

Retrieves a detailed representation of the period in the format "Month Year". The method combines the name of the month (derived from a utility class) and the year associated with the instance.

Specified by:

getPeriodDetail in class Statistics<PeriodType>

Returns:

a string representing the period detail in the format "Month Year".

previous

public MonthlyStatistics previous()

Retrieves the MonthlyStatistics instance for the previous month. If the current month is January, it will transition to December of the previous year.

Specified by:

previous in class Statistics<PeriodType>

Returns:

a MonthlyStatistics instance representing the statistics of the previous month.

next

public MonthlyStatistics next()

Retrieves the next instance of MonthlyStatistics, representing the subsequent month based on the current instance's month and year. If the month is December (12), the year is incremented, and the month is reset to January (1).

Specified by:

next in class Statistics<PeriodType>

Returns:

the next MonthlyStatistics object corresponding to the following month.

getPeriodType

public PeriodType getPeriodType()

Retrieves the type of period associated with this statistical data. This method overrides the base class implementation and returns the specific period type as PeriodType.MONTHLY, indicating the statistics represent monthly data.

Specified by:

getPeriodType in class Statistics<PeriodType>

Returns:

the period type as PeriodType.MONTHLY.