Package com.storedobject.iot

Class MonthlyConsumption

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.iot.Consumption<PeriodType>

com.storedobject.iot.MonthlyConsumption

All Implemented Interfaces:

Displayable, StringFiller, DBTransaction.NoHistory, HasId

public final class MonthlyConsumption
extends Consumption<PeriodType>

Represents a monthly consumption entity that extends the base Consumption class. This class provides functionality to handle data specific to a single month's consumption, including retrieving, navigating, and setting details about the monthly period.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)	Configures the columns for the data representation of the entity.
int	getMonth()	Retrieves the value of the month corresponding to this instance of MonthlyConsumption.
int	getPeriod()	Retrieves the period associated with the monthly consumption.
String	getPeriodDetail()	Retrieves the detailed representation of the consumption period in the format of "Month Year".
PeriodType	getPeriodType()	Retrieves the type of period associated with the consumption instance.
static void	indices(Indices indices)	Configures the indices for the MonthlyConsumption class.
MonthlyConsumption	next()	Retrieves the next MonthlyConsumption object, advancing to the subsequent month.
MonthlyConsumption	previous()	Retrieves the MonthlyConsumption instance representing the previous month relative to the current instance.
void	setMonth(int month)	Sets the month value for the current instance.

Methods inherited from class com.storedobject.iot.Consumption

getConsumption, getItem, getItemId, getPeriodName, getResource, getResourceId, getYear, setConsumption, setItem, setItem, setItem, setResource, setResource, setResource, 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

MonthlyConsumption

public MonthlyConsumption()

Default constructor for the MonthlyConsumption class. Initializes a new instance of the MonthlyConsumption entity, which is used to represent and manage the consumption details for a specific month.

Method Details

columns

public static void columns(Columns columns)

Configures the columns for the data representation of the entity. Adds a column labeled "Month" of type "int".

Parameters:

columns - the Columns object used to define and manage the data columns

indices

public static void indices(Indices indices)

Configures the indices for the MonthlyConsumption class. This method adds a composite index consisting of the fields "Item", "Resource", "Year", and "Month". The index is marked as unique.

Parameters:

indices - the Indices object to which the index configuration will be added

setMonth

public void setMonth(int month)

Sets the month value for the current instance.

Parameters:

month - the month value to set, represented as an integer (1 for January up to 12 for December)

getMonth

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

Retrieves the value of the month corresponding to this instance of MonthlyConsumption.

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 consumption. The period is represented as an integer value corresponding to the month.

Specified by:

getPeriod in class Consumption<PeriodType>

Returns:

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

getPeriodDetail

public String getPeriodDetail()

Retrieves the detailed representation of the consumption period in the format of "Month Year".

The month is derived from the internal state of the class and represented as the corresponding month name (e.g., "January", "February"). The year is retrieved using the Consumption.getYear() method.

Specified by:

getPeriodDetail in class Consumption<PeriodType>

Returns:

a string representing the period detail, combining the name of the month and the year.

previous

public MonthlyConsumption previous()

Retrieves the MonthlyConsumption instance representing the previous month relative to the current instance. If the current month is January, it shifts to December of the previous year.

Specified by:

previous in class Consumption<PeriodType>

Returns:

the MonthlyConsumption instance for the previous month.

next

public MonthlyConsumption next()

Retrieves the next MonthlyConsumption object, advancing to the subsequent month. If the current month is December, the method transitions to January of the next year.

Specified by:

next in class Consumption<PeriodType>

Returns:

the MonthlyConsumption object for the next month, based on the current month and year.

getPeriodType

public PeriodType getPeriodType()

Description copied from class: Consumption

Retrieves the type of period associated with the consumption instance. The period type is expected to represent an interval such as HOURLY, DAILY, WEEKLY, MONTHLY, or YEARLY, as defined in the PeriodType enum.

Specified by:

getPeriodType in class Consumption<PeriodType>

Returns:

The PeriodType indicating the interval type for this consumption instance.