org.neo4j.jdbc.values.Point Maven / Gradle / Ivy
/*
* Copyright (c) 2023-2024 "Neo4j,"
* Neo4j Sweden AB [https://neo4j.com]
*
* This file is part of Neo4j.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.neo4j.jdbc.values;
/**
* Represents a single point in a particular coordinate reference system.
*
* Value that represents a point can be created using
* {@link Values#point(int, double, double)} or
* {@link Values#point(int, double, double, double)} method.
*
* @author Neo4j Drivers Team
* @since 6.0.0
*/
public interface Point {
/**
* Retrieve identifier of the coordinate reference system for this point.
* @return coordinate reference system identifier.
*/
int srid();
/**
* Retrieve {@code x} coordinate of this point.
* @return the {@code x} coordinate value.
*/
double x();
/**
* Retrieve {@code y} coordinate of this point.
* @return the {@code y} coordinate value.
*/
double y();
/**
* Retrieve {@code z} coordinate of this point.
* @return the {@code z} coordinate value or {@link Double#NaN} if not applicable.
*/
@SuppressWarnings("SameReturnValue")
double z();
}