HierarchicalDirectedGraph.java

/*
Copyright 2008-2010 Gephi
Authors : Mathieu Bastian <mathieu.bastian@gephi.org>
Website : http://www.gephi.org

This file is part of Gephi.

Gephi is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

Gephi 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with Gephi.  If not, see <http://www.gnu.org/licenses/>.
*/
package org.gephi.graph.api;

/**
 * Hierarchical directed graph.
 * 
 * @author Mathieu Bastian
 * @see GraphModel
 */
public interface HierarchicalDirectedGraph extends HierarchicalGraph, DirectedGraph {

    /**
     * Returns incoming meta edges incident to <code>node</code>.
     * @param node the node whose incoming meta edges are to be returned
     * @return an edge iterable of <code>node</code>'s incoming meta edges
     * @throws IllegalArgumentException if <code>node</code> is <code>null</code> or not legal in
     * the graph
     */
    public EdgeIterable getMetaInEdges(Node node);

    /**
     * Returns incoming edges and meta edges incident to <code>node</code>.
     * @param node the node whose incoming edges and meta edges are to be returned
     * @return an edge iterable of <code>node</code>'s incoming edges and meta edges
     * @throws IllegalArgumentException if <code>node</code> is <code>null</code> or not legal in
     * the graph
     */
    public EdgeIterable getInEdgesAndMetaInEdges(Node node);

    /**
     * Returns outgoing meta edges incident to <code>node</code>.
     * @param node the node whose outgoing meta edges are to be returned
     * @return an edge iterable of <code>node</code>'s outgoing meta edges
     * @throws IllegalArgumentException if <code>node</code> is <code>null</code> or not legal in
     * the graph
     */
    public EdgeIterable getMetaOutEdges(Node node);

    /**
     * Returns outgoing edges and meta edges incident to <code>node</code>.
     * @param node the node whose outgoing edges and meta edges are to be returned
     * @return an edge iterable of <code>node</code>'s outgoing edges and meta edges
     * @throws IllegalArgumentException if <code>node</code> is <code>null</code> or not legal in
     * the graph
     */
    public EdgeIterable getOutEdgesAndMetaOutEdges(Node node);

    /**
     * Returns the number of <code>node</code>'s incoming meta edges.
     * <p><b>Warning:</b> This method is not thread safe, be sure to call it in a locked
     * statement.
     * @param node the node whose meta in-degree is queried
     * @return the number of meta edges incoming to <code>node</code>
     * @throws IllegalArgumentException if <code>node</code> is <code>null</code> or not legal in
     * the graph.
     */
    public int getMetaInDegree(Node node);

    /**
     * Returns the sum of the in-degree for edges and meta-edge. Equivalent to
     * <code>getInDegree(Node) + getMetaInDegree(Node)</code>.
     * <p><b>Warning:</b> This method is not thread safe, be sure to call it in a locked
     * statement.
     * @param node the node whose total in-degree is queried
     * @return the number of edges and meta edges incoming to <code>node</code>
     * @throws IllegalArgumentException if <code>node</code> is <code>null</code> or not legal in
     * the graph.
     */
    public int getTotalInDegree(Node node);

    /**
     * Returns the sum of the out-degree for edges and meta-edge. Equivalent to
     * <code>getOutDegree(Node) + getMetaOutDegree(Node)</code>.
     * <p><b>Warning:</b> This method is not thread safe, be sure to call it in a locked
     * statement.
     * @param node the node whose total out-degree is queried
     * @return the number of edges and meta edges outgoing from <code>node</code>
     * @throws IllegalArgumentException if <code>node</code> is <code>null</code> or not legal in
     * the graph.
     */
    public int getTotalOutDegree(Node node);

    /**
     * Returns the number of <code>node</code>'s outgoing meta edges.
     * <p><b>Warning:</b> This method is not thread safe, be sure to call it in a locked
     * statement.
     * @param node the node whose meta out-degree is queried
     * @return the number of meta edges outgoing from <code>node</code>
     * @throws IllegalArgumentException if <code>node</code> is <code>null</code> or not legal in
     * the graph.
     */
    public int getMetaOutDegree(Node node);

    /**
     * Finds and returns a meta-edge that connects <code>source</code> and
     * <code>target</code>. Returns <code>null</code> if no such meta-edge is found.
     * <p><b>Warning:</b> This method is not thread safe, be sure to call it in a locked
     * statement.
     * @param source the first incident node of the queried edge
     * @param target thge second incident node of the queried edge
     * @return an edge that connects <code>source</code> and <code>target</code>
     * or <code>null</code> if no such edge exists
     * @throws IllegalArgumentException if <code>source</code> or <code>target</code>
     * are <code>null</code> or not legal nodes in the graph
    */
    public MetaEdge getMetaEdge(Node source, Node target);
}