openlr.location.PoiAccessLocation.java Source code

Java tutorial

Introduction

Here is the source code for openlr.location.PoiAccessLocation.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 openlr.LocationType;
import openlr.location.data.Orientation;
import openlr.location.data.SideOfRoad;
import openlr.map.GeoCoordinates;
import openlr.map.GeoCoordinatesImpl;
import openlr.map.InvalidMapDataException;
import openlr.map.Line;

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

/**
 * Implementation of the location interface for poi with access point locations.
 * 
 * <p>
 * OpenLR is a trade mark of TomTom International B.V.
 * <p>
 * email: software@openlr.org
 * 
 * @author TomTom International B.V.
 */
public class PoiAccessLocation extends PointLocation {

    /** The poi. */
    private final GeoCoordinates poi;

    /**
     * Instantiates a new poi with access point location.
     *
     * @param idString the id string
     * @param l the l
     * @param poff the poff
     * @param lonDeg the lon deg
     * @param latDeg the lat deg
     * @param s the s
     * @param o the o
     * @throws InvalidMapDataException if coordinates are out of range
     */
    protected PoiAccessLocation(final String idString, final Line l, final int poff, final double lonDeg,
            final double latDeg, final SideOfRoad s, final Orientation o) throws InvalidMapDataException {
        super(idString, LocationType.POI_WITH_ACCESS_POINT, l, poff, s, o);
        poi = new GeoCoordinatesImpl(lonDeg, latDeg);
    }

    /**
     * Instantiates a new poi with access point location.
     *
     * @param idString the id string
     * @param l the l
     * @param poff the poff
     * @param lonDeg the lon deg
     * @param latDeg the lat deg
     * @param s the s
     * @throws InvalidMapDataException if coordinates are out of range
     */
    PoiAccessLocation(final String idString, final Line l, final int poff, final double lonDeg, final double latDeg,
            final SideOfRoad s) throws InvalidMapDataException {
        this(idString, l, poff, lonDeg, latDeg, s, Orientation.getDefault());
    }

    /**
     * Instantiates a new poi with access point location.
     *
     * @param idString the id string
     * @param l the l
     * @param poff the poff
     * @param lonDeg the lon deg
     * @param latDeg the lat deg
     * @param o the o
     * @throws InvalidMapDataException if coordinates are out of range
     */
    PoiAccessLocation(final String idString, final Line l, final int poff, final double lonDeg, final double latDeg,
            final Orientation o) throws InvalidMapDataException {
        this(idString, l, poff, lonDeg, latDeg, SideOfRoad.getDefault(), o);
    }

    /**
     * Instantiates a new poi with access point location.
     *
     * @param idString the id string
     * @param l the l
     * @param poff the poff
     * @param lonDeg the lon deg
     * @param latDeg the lat deg
     * @throws InvalidMapDataException if coordinates are out of range
     */
    PoiAccessLocation(final String idString, final Line l, final int poff, final double lonDeg, final double latDeg)
            throws InvalidMapDataException {
        this(idString, l, poff, lonDeg, latDeg, SideOfRoad.getDefault(), Orientation.getDefault());
    }

    // **************** POI WITH ACCESS AT NODE ***********************/

    /**
     * Instantiates a new poi with access point location at a network node.
     *
     * @param idString the id string
     * @param l the l
     * @param lonDeg the lon deg
     * @param latDeg the lat deg
     * @param s the s
     * @param o the o
     * @throws InvalidMapDataException if coordinates are out of range
     */
    PoiAccessLocation(final String idString, final Line l, final double lonDeg, final double latDeg,
            final SideOfRoad s, final Orientation o) throws InvalidMapDataException {
        super(idString, LocationType.POI_WITH_ACCESS_POINT, l, 0, s, o);
        poi = new GeoCoordinatesImpl(lonDeg, latDeg);
    }

    /**
     * Instantiates a new poi with access point location at a network node.
     *
     * @param idString the id string
     * @param l the l
     * @param lonDeg the lon deg
     * @param latDeg the lat deg
     * @throws InvalidMapDataException if coordinates are out of range
     */
    PoiAccessLocation(final String idString, final Line l, final double lonDeg, final double latDeg)
            throws InvalidMapDataException {
        this(idString, l, 0, lonDeg, latDeg, SideOfRoad.getDefault(), Orientation.getDefault());
    }

    /**
     * Instantiates a new poi with access point location at a network node.
     *
     * @param idString the id string
     * @param l the l
     * @param lonDeg the lon deg
     * @param latDeg the lat deg
     * @param s the s
     * @throws InvalidMapDataException if coordinates are out of range
     */
    PoiAccessLocation(final String idString, final Line l, final double lonDeg, final double latDeg,
            final SideOfRoad s) throws InvalidMapDataException {
        this(idString, l, 0, lonDeg, latDeg, s, Orientation.getDefault());
    }

    /**
     * Instantiates a new poi with access point location at a network node.
     *
     * @param idString the id string
     * @param l the l
     * @param lonDeg the lon deg
     * @param latDeg the lat deg
     * @param o the o
     * @throws InvalidMapDataException if coordinates are out of range
     */
    PoiAccessLocation(final String idString, final Line l, final double lonDeg, final double latDeg,
            final Orientation o) throws InvalidMapDataException {
        this(idString, l, 0, lonDeg, latDeg, SideOfRoad.getDefault(), o);
    }

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

    /**
     * Instantiates a copy of location l.
     * 
     * @param l
     *            the location be copied
     */
    public PoiAccessLocation(final PoiAccessLocation l) {
        super(l);
        poi = l.getPointLocation();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final GeoCoordinates getPointLocation() {
        return poi;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("id: ").append(id);
        sb.append(" loc type: ").append(locType);
        sb.append(" posOff: ").append(posOff);
        if (lineForPoint != null) {
            sb.append(" lineForPoint: ").append(lineForPoint.getID());
        }
        sb.append(" poi: ").append(poi);
        sb.append(" access: ").append(access);
        sb.append(" sideOfRoad: ").append(sideOfRoad);
        sb.append(" orientation: ").append(orientation);
        return sb.toString();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final int calculateHashCode() {
        HashCodeBuilder builder = new HashCodeBuilder();
        builder.append(posOff).append(lineForPoint).append(poi).append(access).append(sideOfRoad)
                .append(orientation).append(locType);
        return builder.toHashCode();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final boolean equals(final Object obj) {
        if (!(obj instanceof PoiAccessLocation)) {
            return false;
        }
        if (this == obj) {
            return true;
        }
        PoiAccessLocation other = (PoiAccessLocation) obj;
        EqualsBuilder builder = new EqualsBuilder();
        builder.append(posOff, other.posOff).append(lineForPoint, other.lineForPoint).append(poi, other.poi)
                .append(access, other.access).append(sideOfRoad, other.sideOfRoad)
                .append(orientation, other.orientation).append(locType, other.locType);
        return builder.isEquals();
    }

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

}