org.dishevelled.venn.BinaryVennModel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dsh-venn Show documentation
Lightweight components for venn diagrams.
There is a newer version: 1.2
/*

    dsh-venn  Lightweight components for venn diagrams.
    Copyright (c) 2009-2013 held jointly by the individual authors.

    This library 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 3 of the License, or (at
    your option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
    License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this library;  if not, write to the Free Software Foundation,
    Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA.

    > http://www.fsf.org/licensing/licenses/lgpl.html
    > http://www.opensource.org/licenses/lgpl-license.php

*/
package org.dishevelled.venn;

import java.util.Set;

import org.dishevelled.observable.ObservableSet;

/**
 * Binary venn diagram model.
 *
 * @param  value type
 * @author  Michael Heuer
 * @version $Revision$ $Date$
 */
public interface BinaryVennModel extends VennModel
{

    /**
     * Return a mutable observable view of the first set for
     * this binary venn model.  Changes made to this view are
     * reflected in the other views provided by this venn model.
     * Changes made to the original set are not.
     *
     * @return an observable view of the first set for
     *    this binary venn model
     */
    ObservableSet first();

    /**
     * Return a mutable observable view of the second set for
     * this binary venn model.  Changes made to this view are
     * reflected in the other views provided by this venn model.
     * Changes made to the original set are not.
     *
     * @return an observable view of the second set for
     *    this binary venn model
     */
    ObservableSet second();

    /**
     * Return an immutable view of the elements unique to the first
     * set for this binary venn model.  The first only view will reflect changes
     * made to the first and second views (i.e. {@link #first()},
     * {@link #second()}).
     *
     * @return an immutable view of the elements unique to the first
     *    set for this binary venn model
     */
    Set firstOnly();

    /**
     * Return an immutable view of the elements unique to the second
     * set for this binary venn model.  The second only view will reflect changes
     * made to the first and second views (i.e. {@link #first()},
     * {@link #second()}).
     *
     * @return an immutable view of the elements unique to the second
     *    set for this binary venn model
     */
    Set secondOnly();

    /**
     * Return an immutable view of the intersection of the first and second
     * sets for this binary venn model.  The intersection view will reflect changes
     * made to the first and second views (i.e. {@link #first()},
     * {@link #second()}).
     *
     * @return an immutable view of the intersection of the first and second
     *    sets for this binary venn model
     */
    Set intersection();

    /**
     * Return an immutable view of the union of the first and second
     * sets for this binary venn model.  The union view will reflect changes
     * made to the first and second views (i.e. {@link #first()},
     * {@link #second()}).
     *
     * @return an immutable view of the union of the first and second
     *    sets for this binary venn model
     */
    Set union();

    /**
     * Return a mutable observable view of the selection for this
     * binary venn model.  The selection view will reflect changes
     * made to the first and second views (i.e. {@link #first()},
     * {@link #second()}), and may not contain any elements not present
     * in the union ({@link #union()}).
     *
     * @return an observable view of the selection for
     *    this binary venn model
     */
    ObservableSet selection();
}