bg.util.leto.api

Interface LetoPeriodType

All Known Implementing Classes:

LetoPeriodTypeBase, LetoPeriodTypeBean

public interface LetoPeriodType

An interface to define an abstract period type, such as day, month, year, century and so on...

Each calendar splits the time into abstract periods of time. Each of the supported periods is defined internally by an implementation of LetoPeriodType.

The main characteristics of the period type are:

Characteristic	Description
Name	The name of the period type. Examples: "day", "month", "year", "century", ...
Description	Human readable description about the period type.
Possible Structures	This is an array of possibilities which show how exactly the period is structured and what sub-periods it contains. For example for the period type "month" in Gregorian calendar, this array would show 4 possibilities (an array of 4 elements): Month containing 28 days Month containing 29 days Month containing 30 days Month containing 31 days Another example could be the period type "year" in Gregorian calendar. It would have 2 possible structures: one for non-leap years and another for leap years: Non-Leap: 365 days, January (31), February (28), March(31), ... Leap: 366 days, January (31), February (29), March(31), ...

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Get the human readable description of this period type in the default locale.
java.lang.String	getDescription(java.util.Locale locale) Longer human readable description of the period type.
java.util.Map<java.util.Locale,java.lang.String>	getDescriptionTranslations() Get the available translations in human spoken languages of this period type description.
java.lang.String	getName() Get the name of this period type in the default locale.
java.lang.String	getName(java.util.Locale locale) The name of the period type.
java.util.Map<java.util.Locale,java.lang.String>	getNameTranslations() Get the available translations of the name of this period type in different human spoken languages.
LetoPeriodStructure[]	getPossibleStructures() Return the possible structures for this period type.

Method Detail

getName

java.lang.String getName()

Get the name of this period type in the default locale.

Returns:

The name of this period type in the default locale.

getName

java.lang.String getName(java.util.Locale locale)

The name of the period type. For example: "day", "month", "year", "century" and so on...

Parameters:

locale - The localization to be used.

Returns:

The name of this period type.

getNameTranslations

java.util.Map<java.util.Locale,java.lang.String> getNameTranslations()

Get the available translations of the name of this period type in different human spoken languages.

Returns:

The available translations of the name of this period type in different human spoken languages.

getDescription

java.lang.String getDescription()

Get the human readable description of this period type in the default locale.

Returns:

The human readable long description of this period type using the default locale.

getDescription

java.lang.String getDescription(java.util.Locale locale)

Longer human readable description of the period type.

Parameters:

locale - The localization to be used.

Returns:

Longer human readable description of the given period type.

getDescriptionTranslations

java.util.Map<java.util.Locale,java.lang.String> getDescriptionTranslations()

Get the available translations in human spoken languages of this period type description.

Returns:

The available translations to human spoken languages of this period type description.

getPossibleStructures

LetoPeriodStructure[] getPossibleStructures()

Return the possible structures for this period type. Each possible structure is defined as an element of the array returned. Each possible structure contains the duration of the period in days as well as information about how much sub-periods it contains.
For example in Gregorian calendar, the month period type should return an array of 4 elements like this:

Number	Duration in days	Description
1-st	duration - 28 days	February in non leap year
2-nd	duration - 29 days	February in a leap year
3-rd	duration - 30 days	April, June, September, November
4-th	duration - 31 days	January, March, May, July, August, October, December

Returns:

An array containing all of the possible structures of this period type.