org.neo4j.graphdb.spatial.Coordinate 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 java.util.Arrays;
import org.neo4j.annotations.api.PublicApi;

/**
 * A coordinate is used to describe a position in space.
 * 
 * A coordinate is described by at least two numbers and must adhere to the following ordering
 * 

 * x, y, z ordering in a cartesian reference system
 * east, north, altitude in a projected coordinate reference system
 * longitude, latitude, altitude in a geographic reference system
 * 
 * 
 * Additional numbers are allowed and the meaning of these additional numbers depends on the coordinate reference
 * system
 * (see ${@link CRS})
 */
@PublicApi
public final class Coordinate {
    private final double[] coordinate;

    public Coordinate(double... coordinate) {
        if (coordinate.length < 2) {
            throw new IllegalArgumentException("A coordinate must have at least two elements");
        }
        this.coordinate = coordinate;
    }

    public double[] getCoordinate() {
        return coordinate;
    }

    public double[] getCoordinateCopy() {
        return Arrays.copyOf(coordinate, coordinate.length);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        Coordinate that = (Coordinate) o;

        return Arrays.equals(coordinate, that.coordinate);
    }

    @Override
    public int hashCode() {
        return Arrays.hashCode(coordinate);
    }
}