org.neo4j.graphdb.spatial.Point Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-graphdb-api Show documentation

Graph Database API for Neo4j.

There is a newer version: 5.25.1

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.graphdb.spatial;

import org.neo4j.annotations.api.PublicApi;

/**
 * A point is a geometry described by a single coordinate in space.
 * 
 * A call to {@link #getCoordinates()} must return a single element list.
 */
@PublicApi
public interface Point extends Geometry {
    /**
     * Returns the single coordinate in space defining this point.
     *
     * @return The coordinate of this point.
     */
    default Coordinate getCoordinate() {
        return getCoordinates().get(0);
    }

    @Override
    default String getGeometryType() {
        return "Point";
    }
}