tauzaman.calendricsystem
Class CalendricSystem

java.lang.Object
  |
  +--tauzaman.calendricsystem.CalendricSystem

public class CalendricSystem

extends java.lang.Object

CalendricSystem class represents a Calendric System, which contains Calendars' Epochs and provides an entrance point to all Epoch and Calendar services.

See Also:

Calendar, PropertyManager

Status:

still being designed (granularity lattice), implementation started

Constructor Summary

CalendricSystem(CalendarRepository cr, java.net.URL url)
Constructs a CalendricSystem object; Forms a CalendricSystem by parsing url.

Method Summary

Granule	castDeterminantInstant(Granule granule, Granularity toGranularity)
Granule	castDeterminantInterval(Granule granule, Granularity toGranularity)
void	clearCaches()
Calendar[]	getAllCalendars() Returns all Calendars in this CalendricSystem.
Calendar	getCalendar(java.lang.String calendarName)
Granularity	getDefaultGranularity() Returns default Granularity of this CalendricSystem.
java.lang.String	getDefaultRegex() Returns default regular expression for this CalendricSystem
Mapping[]	getMappings() Returns Mappings of this CalendricSystem.
Calendar[]	getOrderedCalendars(Property overrideInputOrderProperty) Returns an array of ordered list of Calendars for converting a temporal data type to corresponding output string.
java.net.URL	getUrl() Returns url of this CalendricSystem's specification file.
boolean	isCoarser(Granularity g1, Granularity g2)
boolean	isEquivalent(Granularity g1, Granularity g2)
boolean	isFiner(Granularity g1, Granularity g2)
boolean	isIncomparable(Granularity g1, Granularity g2)
void	printGranularityLattice()
java.lang.String	toString() Returns url of this CalendricSystem.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CalendricSystem

public CalendricSystem(CalendarRepository cr,
                       java.net.URL url)
                throws CalendricSystemFormationException

Constructs a CalendricSystem object; Forms a CalendricSystem by parsing url.

Parameters:

cr - CalendarRepository, which this CalendricSystem will use to load Calendars

Throws:

CalendricSystemFormationException - if any error occurs while forming CalendricSystem from given URL

Method Detail

getUrl

public java.net.URL getUrl()

Returns url of this CalendricSystem's specification file.

Returns:

URL url of this CalendricSystem

getAllCalendars

public Calendar[] getAllCalendars()

Returns all Calendars in this CalendricSystem.

Returns:

array of Calendars

getDefaultRegex

public java.lang.String getDefaultRegex()

Returns default regular expression for this CalendricSystem

getMappings

public Mapping[] getMappings()

Returns Mappings of this CalendricSystem.

Returns:

an array of Mappings

getDefaultGranularity

public Granularity getDefaultGranularity()

Returns default Granularity of this CalendricSystem.

Returns:

Granularity, which is the default Granularity

getOrderedCalendars

public Calendar[] getOrderedCalendars(Property overrideInputOrderProperty)
                               throws CalendricSystemServiceException

Returns an array of ordered list of Calendars for converting a temporal data type to corresponding output string.

Parameters:

overrideInputOrderProperty - Property that will be used when forming an ordered input calendar list

Returns:

array of ordered Calendars

Throws:

CalendricSystemServiceException - if any problem occurs when forming an ordered Calendar list

toString

public java.lang.String toString()

Returns url of this CalendricSystem.

Overrides:

toString in class java.lang.Object

Returns:

String representation of a URL

printGranularityLattice

public void printGranularityLattice()

getCalendar

public Calendar getCalendar(java.lang.String calendarName)

castDeterminantInstant

public Granule castDeterminantInstant(Granule granule,
                                      Granularity toGranularity)
                               throws CalendricSystemServiceException

CalendricSystemServiceException

castDeterminantInterval

public Granule castDeterminantInterval(Granule granule,
                                       Granularity toGranularity)
                                throws CalendricSystemServiceException

CalendricSystemServiceException

isCoarser

public boolean isCoarser(Granularity g1,
                         Granularity g2)
                  throws CalendricSystemServiceException

CalendricSystemServiceException

isEquivalent

public boolean isEquivalent(Granularity g1,
                            Granularity g2)
                     throws CalendricSystemServiceException

CalendricSystemServiceException

isFiner

public boolean isFiner(Granularity g1,
                       Granularity g2)
                throws CalendricSystemServiceException

CalendricSystemServiceException

isIncomparable

public boolean isIncomparable(Granularity g1,
                              Granularity g2)
                       throws CalendricSystemServiceException

CalendricSystemServiceException

clearCaches

public void clearCaches()