org.dishevelled.venn.model

Class TernaryVennModelImpl<E>

java.lang.Object

org.dishevelled.venn.model.TernaryVennModelImpl<E>

Type Parameters:

E - value type

All Implemented Interfaces:

TernaryVennModel<E>, VennModel<E>

public final class TernaryVennModelImpl<E>
extends Object
implements TernaryVennModel<E>

Immutable implementation of TernaryVennModel.

Version:

$Revision$ $Date$

Author:

Michael Heuer

Constructor Summary

Constructors

Constructor and Description
TernaryVennModelImpl() Create a new empty ternary venn model.
TernaryVennModelImpl(Set<? extends E> first, Set<? extends E> second, Set<? extends E> third) Create a new ternary venn model with the specified sets.

Method Summary

Methods

Modifier and Type	Method and Description
Set<E>	exclusiveTo(int index, int... additional) Return an immutable set view of the elements exclusive to the sets in this venn model identified by the specified indices.
ObservableSet<E>	first() Return a mutable observable view of the first set for this ternary venn model.
Set<E>	firstOnly() Return an immutable view of the elements unique to the first set for this ternary venn model.
Set<E>	firstSecond() Return an immutable view of the elements unique to the intersection of the first and second sets for this ternary venn model.
Set<E>	firstThird() Return an immutable view of the elements unique to the intersection of the first and third sets for this ternary venn model.
Set<E>	get(int index) Return the set at the specified index in this venn model.
Set<E>	intersection() Return an immutable view of the intersection of the first, second, and third sets for this ternary venn model.
ObservableSet<E>	second() Return a mutable observable view of the second set for this ternary venn model.
Set<E>	secondOnly() Return an immutable view of the elements unique to the second set for this ternary venn model.
Set<E>	secondThird() Return an immutable view of the elements unique to the intersection of the second and third sets for this ternary venn model.
ObservableSet<E>	selection() Return a mutable observable view of the selection for this ternary venn model.
int	size() Return the number of sets in this venn model.
ObservableSet<E>	third() Return a mutable observable view of the third set for this ternary venn model.
Set<E>	thirdOnly() Return an immutable view of the elements unique to the third set for this ternary venn model.
Set<E>	union() Return an immutable view of the union of the first, second, and third sets for this ternary venn model.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TernaryVennModelImpl

public TernaryVennModelImpl()

Create a new empty ternary venn model.

TernaryVennModelImpl

public TernaryVennModelImpl(Set<? extends E> first,
                    Set<? extends E> second,
                    Set<? extends E> third)

Create a new ternary venn model with the specified sets.

Parameters:

first - first set, must not be null

second - second set, must not be null

third - third set, must not be null

Method Detail

size

public int size()

Return the number of sets in this venn model.

Specified by:

size in interface VennModel<E>

Returns:

the number of sets in this venn model

first

public ObservableSet<E> first()

Return a mutable observable view of the first set for this ternary 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.

Specified by:

first in interface TernaryVennModel<E>

Returns:

an observable view of the first set for this ternary venn model

second

public ObservableSet<E> second()

Return a mutable observable view of the second set for this ternary 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.

Specified by:

second in interface TernaryVennModel<E>

Returns:

an observable view of the second set for this ternary venn model

third

public ObservableSet<E> third()

Return a mutable observable view of the third set for this ternary 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.

Specified by:

third in interface TernaryVennModel<E>

Returns:

an observable view of the third set for this ternary venn model

get

public Set<E> get(int index)

Return the set at the specified index in this venn model.

Specified by:

get in interface VennModel<E>

Parameters:

index - index

Returns:

the set at the specified index in this venn model

firstOnly

public Set<E> firstOnly()

Return an immutable view of the elements unique to the first set for this ternary venn model. The first only view will reflect changes made to the first, second, and third views (i.e. TernaryVennModel.first(), TernaryVennModel.second(), and TernaryVennModel.third()).

Specified by:

firstOnly in interface TernaryVennModel<E>

Returns:

an immutable view of the elements unique to the first set for this ternary venn model

secondOnly

public Set<E> secondOnly()

Return an immutable view of the elements unique to the second set for this ternary venn model. The second only view will reflect changes made to the first, second, and third views (i.e. TernaryVennModel.first(), TernaryVennModel.second(), and TernaryVennModel.third()).

Specified by:

secondOnly in interface TernaryVennModel<E>

Returns:

an immutable view of the elements unique to the second set for this ternary venn model

thirdOnly

public Set<E> thirdOnly()

Return an immutable view of the elements unique to the third set for this ternary venn model. The third only view will reflect changes made to the first, second, and third views (i.e. TernaryVennModel.first(), TernaryVennModel.second(), and TernaryVennModel.third()).

Specified by:

thirdOnly in interface TernaryVennModel<E>

Returns:

an immutable view of the elements unique to the third set for this ternary venn model

firstSecond

public Set<E> firstSecond()

Return an immutable view of the elements unique to the intersection of the first and second sets for this ternary venn model. The first and second view will reflect changes made to the first, second, and third views (i.e. TernaryVennModel.first(), TernaryVennModel.second(), and TernaryVennModel.third()).

Specified by:

firstSecond in interface TernaryVennModel<E>

Returns:

an immutable view of the elements unique to the intersection of the first and second sets for this ternary venn model

firstThird

public Set<E> firstThird()

Return an immutable view of the elements unique to the intersection of the first and third sets for this ternary venn model. The first and third view will reflect changes made to the first, second, and third views (i.e. TernaryVennModel.first(), TernaryVennModel.second(), and TernaryVennModel.third()).

Specified by:

firstThird in interface TernaryVennModel<E>

Returns:

an immutable view of the elements unique to the intersection of the first and third sets for this ternary venn model

secondThird

public Set<E> secondThird()

Return an immutable view of the elements unique to the intersection of the second and third sets for this ternary venn model. The second and third view will reflect changes made to the first, second, and third views (i.e. TernaryVennModel.first(), TernaryVennModel.second(), and TernaryVennModel.third()).

Specified by:

secondThird in interface TernaryVennModel<E>

Returns:

an immutable view of the elements unique to the intersection of the second and third sets for this ternary venn model

intersection

public Set<E> intersection()

Return an immutable view of the intersection of the first, second, and third sets for this ternary venn model. The intersection view will reflect changes made to the first, second, and third views (i.e. TernaryVennModel.first(), TernaryVennModel.second(), and TernaryVennModel.third()).

Specified by:

intersection in interface TernaryVennModel<E>

Specified by:

intersection in interface VennModel<E>

Returns:

an immutable view of the intersection of the first, second, and third sets for this ternary venn model

exclusiveTo

public Set<E> exclusiveTo(int index,
                 int... additional)

Return an immutable set view of the elements exclusive to the sets in this venn model identified by the specified indices. For example, for n = 3

 VennModel<String> vennModel = ...;
 Set<String> first = vennModel.get(0);
 Set<String> second = vennModel.get(1);
 Set<String> third = vennModel.get(2);
 Set<String> firstOnly = vennModel.exclusiveTo(0);
 Set<String> firstSecond = vennModel.exclusiveTo(0, 1);
 Set<String> intersection = vennModel.exclusiveTo(0, 1, 2);
 

This is equivalent to the difference of the intersection of the sets in this venn model identified by the specified indices and the union of the remainder sets in this venn model.

Specified by:

exclusiveTo in interface VennModel<E>

Parameters:

index - first index

additional - variable number of additional indices, if any

Returns:

an immutable set view of the elements exclusive to the sets in this venn model identified by the specified indices

union

public Set<E> union()

Return an immutable view of the union of the first, second, and third sets for this ternary venn model. The union view will reflect changes made to the first, second, and third views (i.e. TernaryVennModel.first(), TernaryVennModel.second(), and TernaryVennModel.third()).

Specified by:

union in interface TernaryVennModel<E>

Specified by:

union in interface VennModel<E>

Returns:

an immutable view of the union of the first, second, and third sets for this ternary venn model

selection

public ObservableSet<E> selection()

Return a mutable observable view of the selection for this ternary venn model. The selection view will reflect changes made to the first, second, and third views (i.e. TernaryVennModel.first(), TernaryVennModel.second(), and TernaryVennModel.third()), and may not contain any elements not present in the union (TernaryVennModel.union()).

Specified by:

selection in interface TernaryVennModel<E>

Returns:

an observable view of the selection for this ternary venn model