org.opengis.temporal.Instant Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gt-opengis Show documentation

Standard interfaces implemented throughout the library.

There is a newer version: 24.2-oss84-1

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2005, Open Geospatial Consortium Inc.
 *
 *    All Rights Reserved. http://www.opengis.org/legal/
 */
package org.opengis.temporal;

import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;

import java.util.Collection;
import org.opengis.annotation.UML;

/**
 * A zero-dimensional geometric primitive that represents position in time, equivalent to a point in
 * space.
 *
 * @author Stephane Fellah (Image Matters)
 * @author Alexander Petkov TODO There is a bit of a conflict in the spec document as to what should
 *     be returned for "position." The diagram shows that Position should be returned, while the
 *     text in the document demands that TemporalPosition should represent position in time.
 */
@UML(identifier = "TM_Instant", specification = ISO_19108)
public interface Instant extends TemporalGeometricPrimitive {
    /** Get the position of this instant. */
    @UML(identifier = "position", obligation = MANDATORY, specification = ISO_19108)
    Position getPosition();

    /**
     * Get the Collection of temporal {@link Period}s, for which this Instant is the beginning. The
     * collection may be empty.
     *
     * @see Period#begin
     */
    @UML(identifier = "begunBy", obligation = OPTIONAL, specification = ISO_19108)
    Collection getBegunBy();

    /**
     * Get the Collection of temporal {@link Period}s, for which this Instant is the end. The
     * collection may be empty.
     *
     * @see Period#end
     */
    @UML(identifier = "endedBy", obligation = OPTIONAL, specification = ISO_19108)
    Collection getEndedBy();
}