bg.util.leto.base

Class LetoPeriodTypeBean

java.lang.Object

bg.util.leto.base.LetoPeriodTypeBase

bg.util.leto.base.LetoPeriodTypeBean

All Implemented Interfaces:

LetoPeriodType

public class LetoPeriodTypeBean
extends LetoPeriodTypeBase

Constructor Summary

Constructors

Constructor and Description
LetoPeriodTypeBean(LocaleStringId nameTranslationIndex, LocaleStringId descriptionTranslationIndex, LetoPeriodStructure[] structures)

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.
void	setDescription(LocaleStringId descriptionTranslationIndex)
void	setName(LocaleStringId nameTranslationIndex)
void	setPossibleStructures(LetoPeriodStructure[] structures)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LetoPeriodTypeBean

public LetoPeriodTypeBean(LocaleStringId nameTranslationIndex,
                          LocaleStringId descriptionTranslationIndex,
                          LetoPeriodStructure[] structures)
                   throws LetoExceptionUnrecoverable

Throws:

LetoExceptionUnrecoverable

Method Detail

setDescription

public void setDescription(LocaleStringId descriptionTranslationIndex)

setName

public void setName(LocaleStringId nameTranslationIndex)

getName

public java.lang.String getName()

Description copied from interface: LetoPeriodType

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

Returns:

The name of this period type in the default locale.

getName

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

Description copied from interface: LetoPeriodType

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

Specified by:

getName in interface LetoPeriodType

Specified by:

getName in class LetoPeriodTypeBase

Parameters:

locale - The localization to be used.

Returns:

The name of this period type.

getDescription

public java.lang.String getDescription()

Description copied from interface: LetoPeriodType

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

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

Description copied from interface: LetoPeriodType

Longer human readable description of the period type.

Specified by:

getDescription in interface LetoPeriodType

Specified by:

getDescription in class LetoPeriodTypeBase

Parameters:

locale - The localization to be used.

Returns:

Longer human readable description of the given period type.

getNameTranslations

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

Description copied from interface: LetoPeriodType

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.

getDescriptionTranslations

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

Description copied from interface: LetoPeriodType

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.

setPossibleStructures

public void setPossibleStructures(LetoPeriodStructure[] structures)

getPossibleStructures

public LetoPeriodStructure[] getPossibleStructures()

Description copied from interface: LetoPeriodType

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

Specified by:

getPossibleStructures in interface LetoPeriodType

Specified by:

getPossibleStructures in class LetoPeriodTypeBase

Returns:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object