Package org.gvsig.timesupport

Interface TimeSupportManager

public interface TimeSupportManager

This class is responsible of the management of the library's business logic. It is the library's main entry point.

Version:

$Id$

Author:

gvSIG team

Method Summary

Modifier and Type	Method	Description
void	addRelativeInstantPattern(String relativeInstantPattern)	Add a time pattern that is used to parse a relative instant
AbsoluteInstant	createAbsoluteInstant()	Creates an AbsoluteInstant without any value.
AbsoluteInstant	createAbsoluteInstant(int[] types, int[] values)	Creates an AbsoluteInstant with a set of types and an array of values.
AbsoluteInstant	createAbsoluteInstant(int[] typess, int[] values, Chronology chronology)	Creates an AbsoluteInstant with a set of types and an array of values.
AbsoluteInstant	createAbsoluteInstant(int type, int value)	Creates an AbsoluteInstant with a type and a value.
AbsoluteInstant	createAbsoluteInstant(int type, int value, Chronology chronology)	Creates an AbsoluteInstant with a type and a value and using a chronology.
AbsoluteInstant	createAbsoluteInstant(Chronology chronology)	Creates an AbsoluteInstant without any value and using a chronology.
AbsoluteInterval	createAbsoluteInterval(int years, int months, int weeks, int days, int hours, int minutes, int seconds, int millis)	Creates an AbsoluteInterval from individual fields.
AbsoluteInterval	createAbsoluteInterval(int years, int months, int weeks, int days, int hours, int minutes, int seconds, int millis, Chronology chronology)	Creates an AbsoluteInterval from individual fields and a chronology.
AbsoluteInterval	createAbsoluteInterval(AbsoluteInstant startAbsoluteInstant, int years, int months, int weeks, int days, int hours, int minutes, int seconds, int millis)	Creates an AbsoluteInterval from a start instant and an increment of the time fields.
AbsoluteInterval	createAbsoluteInterval(AbsoluteInstant startAbsoluteInstant, int years, int months, int weeks, int days, int hours, int minutes, int seconds, int millis, Chronology chronology)	Creates an AbsoluteInterval from a start instant and an increment of the time fields and a chronology.
AbsoluteInterval	createAbsoluteInterval(AbsoluteInstant startInstant, AbsoluteInstant endInstant)	Creates an AbsoluteInterval from a start and an end instants.
AbsoluteInterval	createAbsoluteInterval(AbsoluteInstant startInstant, AbsoluteInstant endInstant, Chronology chronology)	Creates an AbsoluteInterval from a start and an end instants and a chronology.
RelativeInstant	createRelativeInstant(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond)	Creates a RelativeInstant using the datetime field values.
RelativeInstant	createRelativeInstant(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond, int chronology)	Creates a RelativeInstant using the datetime field values and using a chronology code.
RelativeInstant	createRelativeInstant(int year, int monthOfYear, int dayOfMonth, int hourOfDay, int minuteOfHour, int secondOfMinute, int millisOfSecond, Chronology chronology)	Creates a RelativeInstant using the datetime field values and using a chronology.
RelativeInstant	createRelativeInstant(long instant)	Creates a RelativeInstant using the number of milliseconds from 1970-01-01T00:00Z.
RelativeInstant	createRelativeInstant(long instant, Chronology chronology)	Creates a RelativeInstant using the number of milliseconds from 1970-01-01T00:00Z and using a chronology.
RelativeInstant	createRelativeInstant(Date date)	Creates a RelativeInstant using a Date.
RelativeInstant	createRelativeInstant(Date date, Chronology chronology)	Creates a RelativeInstant using a Date and using a chronology.
RelativeInstant	createRelativeInstant(Chronology chronology)	Creates a RelativeInstant using the current system time and using a chronology.
RelativeInterval	createRelativeInterval(long startInstant, long endInstant)	Creates a RelativeInterval from a start and an end instants.
RelativeInterval	createRelativeInterval(long startInstant, long endInstant, Chronology chronology)	Creates a RelativeInterval from a start and an end instants, and using a chonology.
RelativeInterval	createRelativeInterval(RelativeInstant startDateTime, RelativeInstant endDateTime)	Creates a RelativeInterval from a start and an end instants.
TimeAnimation	createTimeAnimation(TimeAnimation.TimeAnimationRenderer renderer)	Creates a time animation object.
AbsoluteInstantType	getAbsoluteInstantType(int type)	Gets an AbsoluteInstantType by code.
AbsoluteIntervalType	getAbsoluteIntervalType(int type)	Gets an AbsoluteIntervalType by code.
Chronology	getChronology(int typechronology)	Gets an Chronology by code.
RelativeInstant	parseRelativeInstant(String relativeInstantString)	Creates a relative instant from a string.
void	registerAbsoluteInstantType(AbsoluteInstantType absoluteInstantType)	Registers a new AbsoluteInstantType that can be used in the creation of an AbsoluteInstant.
void	registerAbsoluteIntervalType(AbsoluteIntervalType absoluteIntervalType)	Registers a new AbsoluteIntervalType that can be used in the creation of an AbsoluteInterval.
void	registerChronology(Chronology chronology)	Registers a new Chronology that can be used in the creation of any temporal object.
void	setDefaultChronology(int chronology)	Sets the default chronology.

Method Details

registerAbsoluteInstantType

void registerAbsoluteInstantType(AbsoluteInstantType absoluteInstantType)

Registers a new AbsoluteInstantType that can be used in the creation of an AbsoluteInstant.

Parameters:

absoluteInstantType - the AbsoluteInstantType to register

getAbsoluteInstantType

AbsoluteInstantType getAbsoluteInstantType(int type)
                                    throws AbsoluteInstantTypeNotRegisteredException

Gets an AbsoluteInstantType by code.

Parameters:

type - the code of the AbsoluteInstantType to retrieve.

Returns:

an AbsoluteInstantType with a concrete code.

Throws:

AbsoluteInstantTypeNotRegisteredException - if the AbsoluteInstantType doen's exist.

registerAbsoluteIntervalType

void registerAbsoluteIntervalType(AbsoluteIntervalType absoluteIntervalType)

Registers a new AbsoluteIntervalType that can be used in the creation of an AbsoluteInterval.

Parameters:

absoluteInstantType - the AbsoluteIntervalType to register

getAbsoluteIntervalType

AbsoluteIntervalType getAbsoluteIntervalType(int type)
                                      throws AbsoluteIntervalTypeNotRegisteredException

Gets an AbsoluteIntervalType by code.

Parameters:

type - the code of the AbsoluteIntervalType to retrieve.

Returns:

an AbsoluteIntervalType with a concrete code.

Throws:

AbsoluteIntervalTypeNotRegisteredException - if the AbsoluteIntervalType doen's exist.

registerChronology

void registerChronology(Chronology chronology)

Registers a new Chronology that can be used in the creation of any temporal object.

Parameters:

chronology - the chronology to register

getChronology

Chronology getChronology(int typechronology)

Gets an Chronology by code.

Parameters:

type - the code of the Chronology to retrieve.

Returns:

an Chronology with a concrete code.

setDefaultChronology

void setDefaultChronology(int chronology)

Sets the default chronology. This chronology is used in all the time object creation if the chronology is not fixed.

Parameters:

chronology - the default chronology.

createRelativeInstant

RelativeInstant createRelativeInstant(long instant)

Creates a RelativeInstant using the number of milliseconds from 1970-01-01T00:00Z. It uses the chronology defined by the setDefaultChronology(int) method.

Parameters:

instant - the milliseconds from 1970-01-01T00:00:00Z

Returns:

a relative instant

createRelativeInstant

RelativeInstant createRelativeInstant(long instant,
 Chronology chronology)

Creates a RelativeInstant using the number of milliseconds from 1970-01-01T00:00Z and using a chronology.

Parameters:

instant - the milliseconds from 1970-01-01T00:00:00Z.

chronology - the chronology.

Returns:

a relative instant

createRelativeInstant

RelativeInstant createRelativeInstant(Date date)

Creates a RelativeInstant using a Date. It uses the chronology defined by the setDefaultChronology(int) method.

Parameters:

date - the java.util.Date

Returns:

a relative instant

createRelativeInstant

RelativeInstant createRelativeInstant(Date date,
 Chronology chronology)

Creates a RelativeInstant using a Date and using a chronology.

Parameters:

date - the java.util.Date

chronology - the chronology.

Returns:

a relative instant

createRelativeInstant

RelativeInstant createRelativeInstant(Chronology chronology)

Creates a RelativeInstant using the current system time and using a chronology.

Parameters:

chronology - the chronology.

date - the java.util.Date

Returns:

a relative instant

createRelativeInstant

RelativeInstant createRelativeInstant(int year,
 int monthOfYear,
 int dayOfMonth,
 int hourOfDay,
 int minuteOfHour,
 int secondOfMinute,
 int millisOfSecond)

Creates a RelativeInstant using the datetime field values. It uses the chronology defined by the setDefaultChronology(int) method.

Parameters:

year - the year

monthOfYear - the month of the year

dayOfMonth - the day of the month

hourOfDay - the hour of the day

minuteOfHour - the minute of the hour

secondOfMinute - the second of the minute

millisOfSecond - the millisecond of the second

Returns:

a relative instant

createRelativeInstant

RelativeInstant createRelativeInstant(int year,
 int monthOfYear,
 int dayOfMonth,
 int hourOfDay,
 int minuteOfHour,
 int secondOfMinute,
 int millisOfSecond,
 Chronology chronology)

Creates a RelativeInstant using the datetime field values and using a chronology.

Parameters:

year - the year

monthOfYear - the month of the year

dayOfMonth - the day of the month

hourOfDay - the hour of the day

minuteOfHour - the minute of the hour

secondOfMinute - the second of the minute

millisOfSecond - the millisecond of the second

chronology - the chronology.

Returns:

a relative instant

createRelativeInstant

RelativeInstant createRelativeInstant(int year,
 int monthOfYear,
 int dayOfMonth,
 int hourOfDay,
 int minuteOfHour,
 int secondOfMinute,
 int millisOfSecond,
 int chronology)

Creates a RelativeInstant using the datetime field values and using a chronology code.

Parameters:

year - the year

monthOfYear - the month of the year

dayOfMonth - the day of the month

hourOfDay - the hour of the day

minuteOfHour - the minute of the hour

secondOfMinute - the second of the minute

millisOfSecond - the millisecond of the second

chronology - the chronology code.

Returns:

a relative instant

createAbsoluteInstant

AbsoluteInstant createAbsoluteInstant()

Creates an AbsoluteInstant without any value. It uses the chronology defined by the setDefaultChronology(int) method.

Returns:

an absolute instant

createAbsoluteInstant

AbsoluteInstant createAbsoluteInstant(Chronology chronology)

Creates an AbsoluteInstant without any value and using a chronology.

Parameters:

chronology - the chronology.

Returns:

an absolute instant

createAbsoluteInstant

AbsoluteInstant createAbsoluteInstant(int type,
 int value)
                               throws AbsoluteInstantTypeNotRegisteredException

Creates an AbsoluteInstant with a type and a value. It uses the chronology defined by the setDefaultChronology(int) method.

Parameters:

type - the single type to create the instant. It has to be one of the values specified in AbsoluteInstantType.

value - the value of the field.

Returns:

an absolute instant.

Throws:

AbsoluteInstantTypeNotRegisteredException - if there is not an AbsoluteInstantType with this code.

createAbsoluteInstant

AbsoluteInstant createAbsoluteInstant(int type,
 int value,
 Chronology chronology)
                               throws AbsoluteInstantTypeNotRegisteredException

Creates an AbsoluteInstant with a type and a value and using a chronology.

Parameters:

type - the single type to create the instant. It has to be one of the values specified in AbsoluteInstantType.

value - the value of the field.

chronology - the chronology.

Returns:

an absolute instant.

Throws:

AbsoluteInstantTypeNotRegisteredException - if there is not an AbsoluteInstantType with this code.

createAbsoluteInstant

AbsoluteInstant createAbsoluteInstant(int[] types,
 int[] values)
                               throws AbsoluteInstantTypeNotRegisteredException

Creates an AbsoluteInstant with a set of types and an array of values. The length of both arrays has to be the same. It uses the chronology defined by the setDefaultChronology(int) method.

Parameters:

types - the types to create the instant. All of them have to be one of the values specified in AbsoluteInstantType.

values - the values of every field.

Returns:

an absolute instant.

Throws:

AbsoluteInstantTypeNotRegisteredException - if there is not an AbsoluteInstantType with the codes.

createAbsoluteInstant

AbsoluteInstant createAbsoluteInstant(int[] typess,
 int[] values,
 Chronology chronology)
                               throws AbsoluteInstantTypeNotRegisteredException

Creates an AbsoluteInstant with a set of types and an array of values. It uses a chronology. and the length of both arrays has to be the same.

Parameters:

values - the values of every field.

chronology - the chronology.

types - the types to create the instant. All of them have to be one of the values specified in AbsoluteInstantType.

Returns:

an absolute instant.

Throws:

AbsoluteInstantTypeNotRegisteredException - if there is not an AbsoluteInstantType with the codes.

createRelativeInterval

RelativeInterval createRelativeInterval(long startInstant,
 long endInstant)

Creates a RelativeInterval from a start and an end instants. It uses the chronology defined by the setDefaultChronology(int) method.

Parameters:

startInstant - start of this interval, as milliseconds from 1970-01-01T00:00:00Z.

endInstant - end of this interval, as milliseconds from 1970-01-01T00:00:00Z.

Returns:

a relative interval

Throws:

IllegalArgumentException - if the end is before the start

createRelativeInterval

RelativeInterval createRelativeInterval(long startInstant,
 long endInstant,
 Chronology chronology)

Creates a RelativeInterval from a start and an end instants, and using a chonology.

Parameters:

startInstant - start of this interval, as milliseconds from 1970-01-01T00:00:00Z.

endInstant - end of this interval, as milliseconds from 1970-01-01T00:00:00Z.

chronology - the chronology.

Returns:

a relative interval

Throws:

IllegalArgumentException - if the end is before the start

createRelativeInterval

RelativeInterval createRelativeInterval(RelativeInstant startDateTime,
 RelativeInstant endDateTime)

Creates a RelativeInterval from a start and an end instants. It uses the chronology defined by the setDefaultChronology(int) method.

Parameters:

startInstant - start of this interval, null means now

endInstant - end of this interval, null means now

Returns:

a relative interval

Throws:

IllegalArgumentException - if the end is before the start

createAbsoluteInterval

AbsoluteInterval createAbsoluteInterval(AbsoluteInstant startInstant,
 AbsoluteInstant endInstant)
                                 throws AbsoluteIntervalTypeNotRegisteredException

Creates an AbsoluteInterval from a start and an end instants. It uses the chronology defined by the setDefaultChronology(int) method.

Parameters:

startInstant - start of this interval, null means now

endInstant - end of this interval, null means now

Returns:

an absolute interval

Throws:

IllegalArgumentException - if the end is before the start

AbsoluteIntervalTypeNotRegisteredException

createAbsoluteInterval

AbsoluteInterval createAbsoluteInterval(AbsoluteInstant startInstant,
 AbsoluteInstant endInstant,
 Chronology chronology)
                                 throws AbsoluteIntervalTypeNotRegisteredException

Creates an AbsoluteInterval from a start and an end instants and a chronology.

Parameters:

startInstant - start of this interval

endInstant - end of this interval

chronology - the chronology.

Returns:

an absolute interval

Throws:

IllegalArgumentException - if the end is before the start

AbsoluteIntervalTypeNotRegisteredException - if there is not the necessary AbsoluteIntervalType.

createAbsoluteInterval

AbsoluteInterval createAbsoluteInterval(AbsoluteInstant startAbsoluteInstant,
 int years,
 int months,
 int weeks,
 int days,
 int hours,
 int minutes,
 int seconds,
 int millis)
                                 throws AbsoluteIntervalTypeNotRegisteredException

Creates an AbsoluteInterval from a start instant and an increment of the time fields. It uses the chronology defined by the setDefaultChronology(int) method.

Parameters:

startAbsoluteInstant - start of this interval

years - the years to increment the instant.

months - the months to increment the instant.

weeks - the weeks to increment the instant.

days - the days to increment the instant.

hours - the hours to increment the instant.

minutes - the minutes to increment the instant.

seconds - the seconds to increment the instant.

millis - the milliseconds to increment the instant.

Returns:

an absolute instant

Throws:

IllegalArgumentException - if the end is before the start

AbsoluteIntervalTypeNotRegisteredException - if there is not the necessary AbsoluteIntervalType.

createAbsoluteInterval

AbsoluteInterval createAbsoluteInterval(AbsoluteInstant startAbsoluteInstant,
 int years,
 int months,
 int weeks,
 int days,
 int hours,
 int minutes,
 int seconds,
 int millis,
 Chronology chronology)
                                 throws AbsoluteIntervalTypeNotRegisteredException

Creates an AbsoluteInterval from a start instant and an increment of the time fields and a chronology. The seconds instant is defined by all the individual fields.

Parameters:

startAbsoluteInstant - start of this interval

years - the years to increment the instant.

months - the months to increment the instant.

weeks - the weeks to increment the instant.

days - the days to increment the instant.

hours - the hours to increment the instant.

minutes - the minutes to increment the instant.

seconds - the seconds to increment the instant.

millis - the milliseconds to increment the instant.

chronology - the chronology

Returns:

an absolute instant

Throws:

IllegalArgumentException - if the end is before the start

AbsoluteIntervalTypeNotRegisteredException - if there is not the necessary AbsoluteIntervalType.

createAbsoluteInterval

AbsoluteInterval createAbsoluteInterval(int years,
 int months,
 int weeks,
 int days,
 int hours,
 int minutes,
 int seconds,
 int millis)
                                 throws AbsoluteIntervalTypeNotRegisteredException

Creates an AbsoluteInterval from individual fields. The start interval is the time 0. It uses the chronology defined by the setDefaultChronology(int) method.

Parameters:

years - the years of the end instant.

months - the months of the end instant.

weeks - the weeks of the end instant.

days - the days of the end instant.

hours - the hours of the end instant.

minutes - the minutes of the end instant.

seconds - the seconds of the end instant.

millis - the milliseconds of the end instant.

Returns:

an absolute instant

Throws:

AbsoluteIntervalTypeNotRegisteredException - if there is not the necessary AbsoluteIntervalType.

createAbsoluteInterval

AbsoluteInterval createAbsoluteInterval(int years,
 int months,
 int weeks,
 int days,
 int hours,
 int minutes,
 int seconds,
 int millis,
 Chronology chronology)
                                 throws AbsoluteIntervalTypeNotRegisteredException

Creates an AbsoluteInterval from individual fields and a chronology. The start interval is the time 0.

Parameters:

years - the years of the end instant.

months - the months of the end instant.

weeks - the weeks of the end instant.

days - the days of the end instant.

hours - the hours of the end instant.

minutes - the minutes of the end instant.

seconds - the seconds of the end instant.

millis - the milliseconds of the end instant.

chronology - the chronology

Returns:

an absolute instant

Throws:

AbsoluteIntervalTypeNotRegisteredException - if there is not the necessary AbsoluteIntervalType.

addRelativeInstantPattern

void addRelativeInstantPattern(String relativeInstantPattern)

Add a time pattern that is used to parse a relative instant

Parameters:

relativeInstantPattern - the pattern tor parse the instant

parseRelativeInstant

RelativeInstant parseRelativeInstant(String relativeInstantString)

Creates a relative instant from a string. It tries to parse the string using the patterns added with the addRelativeInstantPattern(String) method.

Parameters:

relativeInstantString - the relative instant like a string

Returns:

the relative instant or null.

createTimeAnimation

TimeAnimation createTimeAnimation(TimeAnimation.TimeAnimationRenderer renderer)

Creates a time animation object.

Parameters:

renderer -

Returns: