es.usc.citius.hipster.graph.GraphBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hipster-core Show documentation
There is a newer version: 1.0.1
/*
 * Copyright 2014 CITIUS , University of Santiago de Compostela.
 *
 *    Licensed 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.
 */

package es.usc.citius.hipster.graph;

import java.util.LinkedList;
import java.util.List;

/**
 * Graph builder assistant to create a Hipster graph. Usage example:
 *  * {@code
 * HipsterGraph =
 * GraphBuilder.create()
 * .connect("A").to("B").withEdge(4d)
 * .connect("A").to("C").withEdge(2d)
 * .connect("B").to("C").withEdge(5d)
 * .createDirectedGraph();
 * }
 * 
 */
public class GraphBuilder {

    private class Connection {
        private V vertex1;
        private V vertex2;
        private E edge;

        private Connection(V vertex1, V vertex2, E edge) {
            this.vertex1 = vertex1;
            this.vertex2 = vertex2;
            this.edge = edge;
        }

        private Connection(V vertex1, V vertex2) {
            this.vertex1 = vertex1;
            this.vertex2 = vertex2;
            this.edge = (E) new Object();
        }

        public V getVertex1() {
            return vertex1;
        }

        public void setVertex1(V vertex1) {
            this.vertex1 = vertex1;
        }

        public V getVertex2() {
            return vertex2;
        }

        public void setVertex2(V vertex2) {
            this.vertex2 = vertex2;
        }

        public E getEdge() {
            return edge;
        }

        public void setEdge(E edge) {
            this.edge = edge;
        }

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

            Connection that = (Connection) o;

            if (!vertex1.equals(that.vertex1)) return false;
            return vertex2.equals(that.vertex2);

        }
    }

    private List connections = new LinkedList();

    private GraphBuilder() {}

    public static  GraphBuilder create() {
        return new GraphBuilder();
    }

    public Vertex1 connect(V vertex) {
        return new Vertex1(vertex);
    }

    public GraphBuilder connect(V vertex1, V vertex2) {
        Vertex1 vertex = new Vertex1(vertex1);
        vertex.to(vertex2);
        return this;
    }

    public HipsterDirectedGraph createDirectedGraph() {
        HashBasedHipsterDirectedGraph graph = HashBasedHipsterDirectedGraph.create();
        for (Connection c : connections) {
            graph.add(c.vertex1);
            graph.add(c.vertex2);
            graph.connect(c.vertex1, c.vertex2, c.edge);
        }
        return graph;
    }

    public HipsterGraph createUndirectedGraph() {
        HashBasedHipsterGraph graph = HashBasedHipsterGraph.create();
        for (Connection c : connections) {
            graph.add(c.vertex1);
            graph.add(c.vertex2);
            graph.connect(c.vertex1, c.vertex2, c.edge);
        }
        return graph;
    }

    /**
     * @see GraphBuilder#createDirectedGraph()
     * @return type-erased directed graph
     */
    @Deprecated
    public HipsterDirectedGraph buildDirectedGraph(){
        return createDirectedGraph();
    }

    /**
     * @see GraphBuilder#createUndirectedGraph()
     * @return type-erased undirected graph
     */
    @Deprecated
    public HipsterGraph buildUndirectedGraph(){
        return createUndirectedGraph();
    }


    public final class Vertex1 {
        V vertex1;

        private Vertex1(V vertex) {
            this.vertex1 = vertex;
        }

        public Vertex2 to(V vertex) {
            return new Vertex2(vertex);
        }

        public class Vertex2 {
            V vertex2;

            private Vertex2(V vertex) {
                this.vertex2 = vertex;
                connections.add(new Connection(vertex1, vertex2));
            }

            public GraphBuilder withEdge(E edge) {
                Connection connection = new Connection(vertex1, vertex2);
                int connectionIndex = connections.indexOf(connection);
                if(connectionIndex != -1 ) {
                    connections.get(connectionIndex).setEdge(edge);
                } else {
                    connection.setEdge(edge);
                    connections.add(connection);
                }
                return GraphBuilder.this;
            }
        }
    }

}