org.geolatte.geom.crs.CrsIdentifiable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of geolatte-geom Show documentation
This geoLatte-geom library offers a geometry model that conforms to the OGC Simple Features for SQL specification.
The newest version!
/*
 * This file is part of the GeoLatte project.
 *
 *     GeoLatte is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Lesser General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     GeoLatte 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 Lesser General Public License for more details.
 *
 *     You should have received a copy of the GNU Lesser General Public License
 *     along with GeoLatte.  If not, see .
 *
 * Copyright (C) 2010 - 2011 and Ownership of code is shared by:
 * Qmino bvba - Romeinsestraat 18 - 3001 Heverlee  (http://www.qmino.com)
 * Geovise bvba - Generaal Eisenhowerlei 9 - 2140 Antwerpen (http://www.geovise.com)
 */

package org.geolatte.geom.crs;

import java.io.Serializable;

/**
 * Abstract base class for classes the are identified by a CrsId (e.g. by EPSG-code).
 *
 * Warning: identity of CrsIdentifiables:
 * In theory the CrsId should identify uniquely the CoordinateReferenceSystem-related objects
 * (whether CRS, datum, projection, etc.). In practice this is not always the case. Users, for example, can add their own
 * definitions for som Projections or Ellipsoids.
 *
 * @author Karel Maesen, Geovise BVBA
 *         creation-date: 11/21/11
 */
abstract public class CrsIdentifiable implements Serializable {

    private static final long serialVersionUID = 6884205871950410216L;

    private final CrsId crsId;
    private final String name;

    /**
     * Constructs an instance.
     *
     * @param crsId the code
     * @param name
     */
    protected CrsIdentifiable(CrsId crsId, String name) {
        if (crsId == null || name == null) throw new IllegalArgumentException(("No null values allowed"));
        this.crsId = crsId;
        this.name = name;
    }


    /**
     * Returns the identifier for this CoordinateReferenceSystem.
     *
     * @return
     */
    public CrsId getCrsId() {
        return crsId;
    }

    /**
     * Returns the name of this CoordinateReferenceSystem.
     *
     * @return the name
     */
    public String getName() {
        return name;
    }

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

        CrsIdentifiable that = (CrsIdentifiable) o;

        if (crsId != null ? !crsId.equals(that.crsId) : that.crsId != null) return false;
        return true;
    }

    @Override
    public int hashCode() {
        int result = crsId != null ? crsId.hashCode() : 0;
        result = 31 * result + (name != null ? name.hashCode() : 0);
        return result;
    }
}