LetoPeriodStructureBean (java 1.0.0 API)

java.lang.Object
- bg.util.leto.base.LetoPeriodStructureBean

All Implemented Interfaces:: LetoPeriodStructure

public class LetoPeriodStructureBean
extends java.lang.Object
implements LetoPeriodStructure

Constructor Summary

Constructors
Constructor and Description
`LetoPeriodStructureBean(LocaleStringId translatedName, long totalLengthInDays, LetoPeriodStructure[] subPeriods)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getName()`
`java.lang.String`	`getName(java.util.Locale locale)` Return the human readable name of this structure if one is available or just return null if no specific name is defined.
`java.util.Map<java.util.Locale,java.lang.String>`	`getNameTranslations()`
`LetoPeriodType`	`getPeriodType()` Return a reference to the abstract period type, this strucutre describes.
`LetoPeriodStructure[]`	`getSubPeriods()` Return sub-periods information for the given structure of the period type.
`long`	`getTotalLengthInDays()` Total length in days of the period type.
`long`	`getTotalLengthInPeriodTypes(LetoPeriodType periodType)` This will return how many period types are contained in this type structure.
`void`	`setPeriodType(LetoPeriodType period)` Once the period is set (to something different than null) either by the constructor or the setPeriodType method, it can no longer be reset to any value.
`void`	`setSubPeriods(LetoPeriodStructure[] subPeriods)`
`void`	`setTotalLengthInDays(long lengthInDays)`
`void`	`setTotalLengthInPeriodTypes(java.util.Map<LetoPeriodType,java.lang.Long> lengthsInPeriodTypes)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LetoPeriodStructureBean
```
public LetoPeriodStructureBean(LocaleStringId translatedName,
                               long totalLengthInDays,
                               LetoPeriodStructure[] subPeriods)
```
- Method Detail
  - getPeriodType
```
public LetoPeriodType getPeriodType()
```
    Description copied from interface: LetoPeriodStructure
    
    Return a reference to the abstract period type, this strucutre describes. For example, if this structure describes a leap year, the the getPeriodType() method will return a reference to the period type year.
    Ahother exaple is: If this structure describes 28 days month (like fecruary in non-leap years), then the getPeriodType() method will return a reference to the period type "month".
    
    Specified by:
    
    getPeriodType in interface LetoPeriodStructure
    
    Returns:
    
    The period type this structure describes.
  - setPeriodType
```
public void setPeriodType(LetoPeriodType period)
                   throws LetoExceptionUnrecoverable
```
    Description copied from interface: LetoPeriodStructure
    
    Once the period is set (to something different than null) either by the constructor or the setPeriodType method, it can no longer be reset to any value. If a try to reset it is performed, then a LetoException will be thrown.
    
    Specified by:
    
    setPeriodType in interface LetoPeriodStructure
    
    Parameters:
    
    period - The period type that has to be set to this strucutre.
    
    Throws:
    
    LetoExceptionUnrecoverable - If the period type of this strucutre is already set.
  - setSubPeriods
```
public void setSubPeriods(LetoPeriodStructure[] subPeriods)
```
  - getSubPeriods
```
public LetoPeriodStructure[] getSubPeriods()
```
    Description copied from interface: LetoPeriodStructure
    
    Return sub-periods information for the given structure of the period type. For example the period type "year" in Gregorian calendar has two different structures: for leap and non-leap years. The structure for non-leap years will return getTotalLengthInDays() 365 and the method getSubPeriods() will return the actual separation of this non-leap year into 12 months. The result will be an array of 12 elements - an element for each month. Each of this 12 elements will refer to the subtype "month".
    
    Specified by:
    
    getSubPeriods in interface LetoPeriodStructure
    
    Returns:
    
    The actual separation into sub-periods.
  - setTotalLengthInDays
```
public void setTotalLengthInDays(long lengthInDays)
```
  - setTotalLengthInPeriodTypes
```
public void setTotalLengthInPeriodTypes(java.util.Map<LetoPeriodType,java.lang.Long> lengthsInPeriodTypes)
```
  - getTotalLengthInDays
```
public long getTotalLengthInDays()
```
    Description copied from interface: LetoPeriodStructure
    
    Total length in days of the period type. Each period type can have several different possible structures. Each possible structure can have different duration in days. For example in Gregorian calendar months can have 4 different structures containing 28,29, 30 or 31 days.
    
    Specified by:
    
    getTotalLengthInDays in interface LetoPeriodStructure
    
    Returns:
    
    The total length of the period type.
  - getTotalLengthInPeriodTypes
```
public long getTotalLengthInPeriodTypes(LetoPeriodType periodType)
```
    Description copied from interface: LetoPeriodStructure
    
    This will return how many period types are contained in this type structure. So for example if the type structure is a normal (non-leap) year, then it would contain 12 months, but 365 days. However if this represents a leap year, then it would return 12 for months, but 366 for days.
    
    Specified by:
    
    getTotalLengthInPeriodTypes in interface LetoPeriodStructure
    
    Parameters:
    
    periodType - We need to return how many periods of this type are available in this period structure. For example if the type structure is a leap year and the period type is day, then it would return how many days are inside a leap year. In that example - 366.
    
    Returns:
    
    How many periods of the given type are available in this type structure.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface LetoPeriodStructure
  - getName
```
public java.lang.String getName(java.util.Locale locale)
```
    Description copied from interface: LetoPeriodStructure
    
    Return the human readable name of this structure if one is available or just return null if no specific name is defined.
    
    Example: Please assume that we have the LetoPeriodType for year. The method getPossibleStructures() would return a LetoPeriodStructure object without a specific name (or maybe just "year" as a name), but then one could call the method getSubperiods() of that LetoPeriodStructure. That method this time could return an array of LetoPeriodStructure object, each of which would have a specific name: "January", "February", etc...
    
    LetoPeriodType year = ...
    LetoPeriodStructure[] possibleTypeOfYearss = year.getPossibleStructgures(); // Leap and non leap uears
    LetoPeriodStructure firstPossibility = possibleTypeOfYearss[0];
    LetoPeriodStructure[] subPeriods = firstPossibility.getSubPeriods();
    for (int i = 0; i < subPeriods.length; i++) {
    String name = subPeriod[i].getName(); // This could return "January", "February", etc...
    System.out.println(name + ", ");
    }
    
    Specified by:
    
    getName in interface LetoPeriodStructure
    
    Parameters:
    
    locale - The locale to be used to return the name of the structure. For example if locale is java.util.Locale ENGLISH, then the implementation might output "January", while if the Locale is Bulgarian, then it might output "Yanuary" or "Януари". If the locale parameter is null, then the implementation should output some default value.
    
    Returns:
    
    The name of the subperiod type that is returned by the getSubPeriods() method or null if there is no specific name in the current calendar instance.
  - getNameTranslations
```
public java.util.Map<java.util.Locale,java.lang.String> getNameTranslations()
```
    Specified by:
    
    getNameTranslations in interface LetoPeriodStructure

Class LetoPeriodStructureBean

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LetoPeriodStructureBean

Method Detail

getPeriodType

setPeriodType

setSubPeriods

getSubPeriods

setTotalLengthInDays

setTotalLengthInPeriodTypes

getTotalLengthInDays

getTotalLengthInPeriodTypes

toString

getName

getName

getNameTranslations