Edge.java

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Reinventing Geospatial, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.rgi.store.routingnetworks;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * Representation of a network edge
 *
 * @author Luke Lambert
 *
 */
public class Edge
{
    /**
     * Constructor
     * @param identifier         Unique identifier
     * @param fromNode           The origin node of an edge
     * @param toNode             The destination node of an edge
     * @param edgeDirectionality Specifies whether or not the edge can be traversed in both directions
     * @param attributes         List of other attributes associated with the node
     */
    public Edge(final int                 identifier,
                final int                 fromNode,
                final int                 toNode,
                final EdgeDirecctionality edgeDirectionality,
                final List<Object>        attributes)
    {
        this.identifier         = identifier;
        this.from               = fromNode;
        this.to                 = toNode;
        this.edgeDirectionality = edgeDirectionality;
        this.attributes         = new ArrayList<>(attributes);
    }

    public int getIdentifier()
    {
        return this.identifier;
    }

    public int getFrom()
    {
        return this.from;
    }

    public int getTo()
    {
        return this.to;
    }

    public EdgeDirecctionality getEdgeDirectionality()
    {
        return this.edgeDirectionality;
    }

    public List<Object> getAttributes()
    {
        return Collections.unmodifiableList(this.attributes);
    }

    private final int                 identifier;
    private final int                 from;
    private final int                 to;
    private final EdgeDirecctionality edgeDirectionality;
    private final List<Object>        attributes;
}