org.grouplens.lenskit.eval.graph.GVSubgraph Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lenskit-eval Show documentation

Facilities for evaluating recommender algorithms.

There is a newer version: 3.0-T5

/*
 * LensKit, an open source recommender systems toolkit.
 * Copyright 2010-2014 LensKit Contributors.  See CONTRIBUTORS.md.
 * Work on LensKit has been funded by the National Science Foundation under
 * grants IIS 05-34939, 08-08692, 08-12148, and 10-17697.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of the
 * License, or (at your option) any later version.
 *
 * This program 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 General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package org.grouplens.lenskit.eval.graph;

import com.google.common.collect.ImmutableList;

import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

/**
 * A subgraph in GraphViz.
 */
class GVSubgraph {
    private final String name;
    private final Map attributes;
    private final List nodes;
    private final List edges;

    /**
     * Construct a new subgraph. Don't call this, use {@link SubgraphBuilder}.
     * @param attrs The attributes.
     * @param ns The nodes.
     * @param es The edges.
     */
    GVSubgraph(String name, Map attrs, List ns, List es) {
        this.name = name;
        attributes = Collections.unmodifiableMap(new LinkedHashMap(attrs));
        nodes = ImmutableList.copyOf(ns);
        edges = ImmutableList.copyOf(es);
    }

    /**
     * Get the subgraph's name.
     * @return The subgraph's name.
     */
    public String getName() {
        return name;
    }

    /**
     * Get the subgraph's attributes.
     * @return The subgraph's attributes.
     */
    public Map getAttributes() {
        return attributes;
    }

    /**
     * Get the subgraph's nodes.
     * @return The subgraph's nodes
     */
    public List getNodes() {
        return nodes;
    }

    /**
     * Get the subgraph's edges.
     * @return The subgraph's edges.
     */
    public List getEdges() {
        return edges;
    }
}