Interface TemporalFactory


  • public interface TemporalFactory
    Factory to create Temporal object.
    Since:
    2.3
    • Method Detail

      • createCalendar

        Calendar createCalendar​(Identifier name,
                                Extent domainOfValidity)
        Creates a Calendar without any referenceFrame.
        Parameters:
        name - Name that uniquely identifies the temporal reference system.
        domainOfValidity - space and time within which the reference system is applicable.
        Returns:
        expected Calendar.
      • createCalendar

        Calendar createCalendar​(Identifier name,
                                Extent domainOfValidity,
                                Collection<CalendarEra> referenceFrame,
                                Clock timeBasis)
        Creates a Calendar.
        Parameters:
        name - Name that uniquely identifies the temporal reference system.
        domainOfValidity - Space and time within which the reference system is applicable.
        referenceFrame - The calendar eras associated with the calendar being described.
        timeBasis - The time basis that is use with this calendar to define temporal position within a calendar day.
        Returns:
        expected Calendar.
      • createCalendarDate

        CalendarDate createCalendarDate​(TemporalReferenceSystem frame,
                                        IndeterminateValue indeterminatePosition,
                                        InternationalString calendarEraName,
                                        int[] calendarDate)
        Creates a CalendarDate object.
        Parameters:
        frame - The ReferenceSystem associated with this CalendarDate, if not specified, it is assumed to be an association to the Gregorian calendar and UTC.
        indeterminatePosition - Attribute provides the only value for TemporalPosition unless a subtype of TemporalPosition is used as the data type.
        calendarEraName - Name of the calendar era to which the date is referenced.
        calendarDate - Sequence of positive integers in which the first integer identifies a specific instance of the unit used at the highest level of the calendar hierarchy, the second integer identifies a specific instance of the unit used at the next lower level in the hierarchy, and so on. The format defined in ISO 8601 for dates in the Gregorian calendar may be used for any date that is composed of values for year, month and day.
        Returns:
        expected CalendarDate.
      • createCalendarEra

        CalendarEra createCalendarEra​(InternationalString name,
                                      InternationalString referenceEvent,
                                      CalendarDate referenceDate,
                                      JulianDate julianReference,
                                      Period epochOfUse)
        Create a CalendarEra object.
        Parameters:
        name - Identify the calendarEra within this calendar.
        referenceEvent - Provide the name or description of a mythical or historic event which fixes the position of the base scale of the calendar era.
        referenceDate - Provide the date of the reference referenceEvent expressed as a date in the given calendar. In most calendars, this date is the origin (i.e the first day) of the scale, but this is not always true.
        julianReference - Provide the Julian date that corresponds to the reference date.
        epochOfUse - Identify the Period for which the calendar era was used as a basis for dating, the datatype for Period.begin and Period.end shall be JulianDate.
        Returns:
        expected CalendarEra.
      • createClock

        Clock createClock​(Identifier name,
                          Extent domainOfValidity,
                          InternationalString referenceEvent,
                          ClockTime referenceTime,
                          ClockTime utcReference)
        Creates a Clock object.
        Parameters:
        name - Name that uniquely identifies the temporal reference system.
        domainOfValidity - The space and time within which the reference system is applicable.
        referenceEvent - Provide the name or description of an event, such as solar noon or sunrise.
        referenceTime - Provide the time of day associated with the reference event expressed as a time of day in the given clock, the reference time is usually the origin of the clock scale.
        utcReference - The 24-hour local or UTC time that corresponds to the reference time.
        Returns:
        expected Clock.
      • createClockTime

        ClockTime createClockTime​(TemporalReferenceSystem frame,
                                  IndeterminateValue indeterminatePosition,
                                  Number[] clockTime)
        Creates ClockTime object.
        Parameters:
        frame - The ReferenceSystem associated with this ClockTime, if not specified, it is assumed to be an association to the Gregorian calendar and UTC.
        indeterminatePosition - The only value for TemporalPosition unless a subtype of TemporalPosition is used as the data type.
        clockTime - A sequence of positive numbers with a structure similar to a CalendarDate.
        Returns:
        expected ClockTime.
      • createDateAndTime

        DateAndTime createDateAndTime​(TemporalReferenceSystem frame,
                                      IndeterminateValue indeterminatePosition,
                                      InternationalString calendarEraName,
                                      int[] calendarDate,
                                      Number[] clockTime)
        Creates a DateAndTime.
        Parameters:
        frame - The ReferenceSystem associated with this TemporalPosition, if not specified, it is assumed to be an association to the Gregorian calendar and UTC.
        indeterminatePosition - Attribute provides the only value for TemporalPosition unless a subtype of TemporalPosition is used as the data type.
        calendarEraName - Name of the calendar era to which the date is referenced.
        calendarDate - A sequence of positive integers in which the first integer identifies a specific instance of the unit used at the highest level of the calendar hierarchy, the second integer identifies a specific instance of the unit used at the next lower level in the hierarchy, and so on. The format defined in ISO 8601 for dates in the Gregorian calendar may be used for any date that is composed of values for year, month and day.
        clockTime - A sequence of positive numbers with a structure similar to a CalendarDate.
        Returns:
        expected DateAndTime
      • createInstant

        Instant createInstant​(Date date)
        Creates an Instant.
        Parameters:
        date - The date of this Instant, it shall be associated with a single temporal reference system.
        Returns:
        expected Instant.
      • createIntervalLenght

        IntervalLength createIntervalLenght​(Unit unit,
                                            int radix,
                                            int factor,
                                            int value)
        Creates an IntervalLength.
        Parameters:
        unit - Name of the unit of measure used to express the length of the interval.
        radix - Base of the multiplier of the unit.
        factor - Exponent of the base.
        value - Length of the time interval as an integer multiple of one radix(exp -factor) of the specified unit.
        Returns:
        expected IntervalLength, sub interface of Duration.
      • createJulianDate

        JulianDate createJulianDate​(TemporalReferenceSystem frame,
                                    IndeterminateValue indeterminatePosition,
                                    Number coordinateValue)
        Creates an JulianDate.
        Parameters:
        frame - The ReferenceSystem associated with this TemporalPosition, if not specified, it is assumed to be an association to the Gregorian calendar and UTC.
        indeterminatePosition - Attribute provides the only value for TemporalPosition unless a subtype of TemporalPosition is used as the data type.
        coordinateValue - The distance from the scale origin expressed as a multiple of the standard interval associated with the temporal coordinate system.
        Returns:
        expected JulianDate.
      • createOrdinalPosition

        OrdinalPosition createOrdinalPosition​(TemporalReferenceSystem frame,
                                              IndeterminateValue indeterminatePosition,
                                              OrdinalEra ordinalPosition)
        Creates an OrdinalPosition.
        Parameters:
        frame - The ReferenceSystem associated with this OrdinalPosition, if not specified, it is assumed to be an association to the Gregorian calendar and UTC.
        indeterminatePosition - Provides the only value for TemporalPosition unless a subtype of TemporalPosition is used as the data type.
        ordinalPosition - A reference to the ordinal era in which the instant occurs.
        Returns:
        expected OrdinalPosition.
      • createTemporalCoordinateSystem

        TemporalCoordinateSystem createTemporalCoordinateSystem​(Identifier name,
                                                                Extent domainOfValidity,
                                                                Date origin,
                                                                Unit<Time> interval)
        Parameters:
        name - Name that uniquely identifies the temporal reference system.
        domainOfValidity - The space and time within which the reference coordinate system is applicable.
        origin - The origin of the scale, it must be specified in the Gregorian calendar with time of day in UTC.
        interval - The name of a single unit of measure used as the base interval for the scale. it shall be one of those units of measure for time specified by ISO 31-1, or a multiple of one of those units, as specified by ISO 1000.
        Returns:
        expected TemporalCoordinateSystem.
      • createTemporalPosition

        TemporalPosition createTemporalPosition​(TemporalReferenceSystem frame,
                                                IndeterminateValue indeterminatePosition)
        Creates a TemporalPosition.
        Parameters:
        frame - The ReferenceSystem associated with this TemporalPosition, if not specified, it is assumed to be an association to the Gregorian calendar and UTC.
        indeterminatePosition - The only value for TemporalPosition unless a subtype of TemporalPosition is used as the data type.
        Returns:
        expected TemporalPosition.