org.geolatte.geom.crs.ProjectedCoordinateReferenceSystem 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 org.geolatte.geom.*;

import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * A projected CoordinateReferenceSystem.
 *
 * A projected coordinate reference system is a coordinate reference system derived
 * from a two-dimensional geographic coordinate reference system by applying a map projection and
 * using a Cartesian coordinate system. (see 
 OGC Abstract Specifications, Topic 2: Spatial Referencing By coordinates, section 4 )

 *
 * @author Karel Maesen, Geovise BVBA
 *         creation-date: 8/2/11
 */
public class ProjectedCoordinateReferenceSystem extends SingleCoordinateReferenceSystem {

    private final Projection projection;
    private final GeographicCoordinateReferenceSystem geoCRS;
    private final List parameters;
    private final Extension extension;

    /**
     * Constructs a ProjectedCoordinateReferenceSystem.
     *
     *
     * @param crsId      the CrsId that identifies this CoordinateReferenceSystem uniquely
     * @param name       the commonly used name for this CoordinateReferenceSystem
     * @param geoCRS     the GeographicCoordinateReferenceSystem for this projection
     * @param projection the map projection method
     * @param parameters the projection parameters for the projection method
     * @param crs        the 2D cartesian coordinate system for this coordinate reference system
     */
    public ProjectedCoordinateReferenceSystem(CrsId crsId, String name, GeographicCoordinateReferenceSystem geoCRS,
                                              Projection projection, List parameters,
                                              CartesianCoordinateSystem2D crs) {
        this(crsId, name, geoCRS, projection, parameters, crs, null);
    }


    /**
     * Constructs a ProjectedCoordinateReferenceSystem.
     *
     *
     * @param crsId      the CrsId that identifies this CoordinateReferenceSystem uniquely
     * @param name       the commonly used name for this CoordinateReferenceSystem
     * @param geoCRS     the GeographicCoordinateReferenceSystem for this projection
     * @param projection the map projection method
     * @param parameters the projection parameters for the projection method
     * @param crs        the 2D cartesian coordinate system for this coordinate reference system
     * @param extension the optional extension key-value pair for this CoordinateReferenceSystem
     */
    public ProjectedCoordinateReferenceSystem(CrsId crsId, String name, GeographicCoordinateReferenceSystem geoCRS,
                                              Projection projection, List parameters,
                                              CartesianCoordinateSystem2D crs, Extension extension) {
        super(crsId, name, crs);
        this.geoCRS = geoCRS;
        this.projection = projection;
        this.parameters = parameters;
        this.extension = extension;
    }


    /**
     * Returns the projection parameters
     *
     * @return a list of CrsParameters.
     */
    public List getParameters() {
        return Collections.unmodifiableList(parameters);
    }

    /**
     * Returns the base GeographicCoordinateReferenceSystem of this
     * projected reference system.
     *
     * @return
     */
    public GeographicCoordinateReferenceSystem getGeographicCoordinateSystem() {
        return geoCRS;
    }

    /**
     * Returns the map projection for this projected cooordinate system.
     * @return
     */
    public Projection getProjection() {
        return projection;
    }

    /**
     * Returns an extension value by key
     * @return the extension object, if any
     */
    public Extension getExtension() {
        return extension;
    }

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

        ProjectedCoordinateReferenceSystem that = (ProjectedCoordinateReferenceSystem) o;

        if (!geoCRS.equals(that.geoCRS)) return false;
        if (!parameters.equals(that.parameters)) return false;
        if (!projection.equals(that.projection)) return false;

        return true;
    }

    @Override
    public int hashCode() {
        int result = super.hashCode();
        result = 31 * result + projection.hashCode();
        result = 31 * result + geoCRS.hashCode();
        result = 31 * result + parameters.hashCode();
        return result;
    }

}