001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2006-2012 Open Geospatial Consortium, Inc.
006     *    All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007     *
008     *    Permission to use, copy, and modify this software and its documentation, with
009     *    or without modification, for any purpose and without fee or royalty is hereby
010     *    granted, provided that you include the following on ALL copies of the software
011     *    and documentation or portions thereof, including modifications, that you make:
012     *
013     *    1. The full text of this NOTICE in a location viewable to users of the
014     *       redistributed or derivative work.
015     *    2. Notice of any changes or modifications to the OGC files, including the
016     *       date changes were made.
017     *
018     *    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019     *    NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020     *    TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021     *    THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022     *    PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023     *
024     *    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025     *    CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026     *
027     *    The name and trademarks of copyright holders may NOT be used in advertising or
028     *    publicity pertaining to the software without specific, written prior permission.
029     *    Title to copyright in this software and any associated documentation will at all
030     *    times remain with copyright holders.
031     */
032    package org.opengis.temporal;
033    
034    import java.util.Collection;
035    import java.lang.Number;
036    import org.opengis.annotation.UML;
037    
038    import static org.opengis.annotation.Obligation.*;
039    import static org.opengis.annotation.Specification.*;
040    
041    
042    /**
043     * A data type that shall be used to identify a temporal position within a day.
044     * Because {@linkplain TemporalPosition temporal position} cannot by itself completely
045     * identify a single temporal position; it shall be used with {@linkplain CalendarDate
046     * calendar date} for that purpose. It may be also used to identify the time of occurrence
047     * of an event that recurs every day.
048     *
049     * @author Stephane Fellah (Image Matters)
050     * @author Alexander Petkov
051     */
052    @UML(identifier="TM_ClockTime", specification=ISO_19108)
053    public interface ClockTime extends TemporalPosition {
054        /**
055         * A sequence of numbers with a structure similar to that of {@link CalendarDate#getCalendarDate
056         * CalendarDate}. The first number integer identifies a specific instance of the unit used at the
057         * highest level of the clock hierarchy, the second number identifies a specific instance of the
058         * unit used at the next lower level, and so on. All but the last number in the sequence shall be
059         * integers; the last number may be integer or real.
060         *
061         * @return Instance of the units, from highest level to lowest level of the clock hierarchy.
062         */
063        @UML(identifier="clkTime", obligation=MANDATORY, specification=ISO_19108)
064        Number[] getClockTime();
065    }