openlr.location.GridLocation.java Source code

Introduction

Here is the source code for openlr.location.GridLocation.java

Source

/**
 * Licensed to the TomTom International B.V. under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  TomTom International B.V.
 * licenses this file to you 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
 *
 * http://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.
 */
/**
 *  Copyright (C) 2009-2012 TomTom International B.V.
 *
 *   TomTom (Legal Department)
 *   Email: legal@tomtom.com
 *
 *   TomTom (Technical contact)
 *   Email: openlr@tomtom.com
 *
 *   Address: TomTom International B.V., Oosterdoksstraat 114, 1011DK Amsterdam,
 *   the Netherlands
 */
package openlr.location;

import java.util.List;

import openlr.LocationType;
import openlr.map.GeoCoordinates;
import openlr.map.GeoCoordinatesImpl;
import openlr.map.InvalidMapDataException;
import openlr.map.RectangleCorners;

import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;

/**
 * Implementation of the location interface for grid locations.
 * 
 * <p>
 * OpenLR is a trade mark of TomTom International B.V.
 * <p>
 * email: software@openlr.org
 * 
 * @author DLR e.V. (RE)
 */
public class GridLocation extends AbstractLocation {

    /** The number of columns. */
    private final int numberOfColumns;

    /** The number of rows. */
    private final int numberOfRows;

    /** The list of corner positions. */
    private final RectangleCorners corners;

    /**
     * Instantiates a new grid area location.
     *
     * @param idString the id string
     * @param lowerLeftLonDeg the lower left lon deg
     * @param lowerLeftLatDeg the lower left lat deg
     * @param upperRightLonDeg the upper right lon deg
     * @param upperRightLatDeg the upper right lat deg
     * @param ncols the number of columns
     * @param nrows the number of rows
     * @throws InvalidMapDataException the invalid map data exception
     */
    protected GridLocation(final String idString, final double lowerLeftLonDeg, final double lowerLeftLatDeg,
            final double upperRightLonDeg, final double upperRightLatDeg, final int ncols, final int nrows)
            throws InvalidMapDataException {
        super(idString, LocationType.GRID);
        GeoCoordinates lowerLeft = new GeoCoordinatesImpl(lowerLeftLonDeg, lowerLeftLatDeg);
        GeoCoordinates upperRight = new GeoCoordinatesImpl(upperRightLonDeg, upperRightLatDeg);
        numberOfColumns = ncols;
        numberOfRows = nrows;
        corners = new RectangleCorners(lowerLeft, upperRight);
    }

    /********************** COPY CONSTRUCTOR *************************/

    /**
     * Instantiates a copy of location l.
     * 
     * @param l
     *            the location be copied
     */
    GridLocation(final GridLocation l) {
        super(l);
        numberOfColumns = l.getNumberOfColumns();
        numberOfRows = l.getNumberOfRows();
        corners = l.corners;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final List<GeoCoordinates> getCornerPoints() {
        return corners.getCornerPoints();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final GeoCoordinates getLowerLeftPoint() {
        return corners.getLowerLeft();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final GeoCoordinates getUpperRightPoint() {
        return corners.getUpperRight();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final int getNumberOfColumns() {
        return numberOfColumns;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final int getNumberOfRows() {
        return numberOfRows;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("id: ").append(id);
        sb.append(" loc type: ").append(locType);
        sb.append(" corners: ").append(corners);
        sb.append(" NCOLS: ").append(numberOfColumns);
        sb.append(" NROWS: ").append(numberOfRows);
        return sb.toString();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final int calculateHashCode() {
        HashCodeBuilder builder = new HashCodeBuilder();
        builder.append(locType).append(corners).append(corners).append(numberOfColumns).append(numberOfRows);
        return builder.toHashCode();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final boolean equals(final Object obj) {
        if (!(obj instanceof GridLocation)) {
            return false;
        }
        if (this == obj) {
            return true;
        }
        GridLocation other = (GridLocation) obj;
        EqualsBuilder builder = new EqualsBuilder();
        builder.append(corners, other.corners).append(locType, other.locType)
                .append(numberOfColumns, other.numberOfColumns).append(numberOfRows, other.numberOfRows);
        return builder.isEquals();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final int hashCode() {
        return getHashCode();
    }
}