org.lcsim.event.base

Class BaseRelationalTable<F,T>

java.lang.Object

org.lcsim.event.base.BaseRelationalTable<F,T>

All Implemented Interfaces:

RelationalTable<F,T>

public class BaseRelationalTable<F,T>
extends Object
implements RelationalTable<F,T>

An implementation of RealtionalTable

Author:

tonyj

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	BaseRelationalTable.FromWeightComparator
private static class	BaseRelationalTable.OneMany
private static class	BaseRelationalTable.Relation<F,T>
private class	BaseRelationalTable.ToWeightComparator

Nested classes/interfaces inherited from interface org.lcsim.event.RelationalTable

RelationalTable.Mode, RelationalTable.Weighting

Field Summary

Fields

Modifier and Type	Field and Description
private Map<F,T>	fromMap
private Map<F,Set<T>>	fromMultiMap
private RelationalTable.Mode	mode
private Map<T,F>	toMap
private Map<T,Set<F>>	toMultiMap
private Set<BaseRelationalTable.Relation<F,T>>	unweightedRelations
private static double	WEIGHT_ONE
private static double	WEIGHT_ZERO
private Map<BaseRelationalTable.Relation<F,T>,Double>	weightedRelations
private RelationalTable.Weighting	weighting

Constructor Summary

Constructors

Constructor and Description
BaseRelationalTable() Creates an empty ManyToMany relational table, in ManyToMany mode and with weights
BaseRelationalTable(RelationalTable.Mode mode, RelationalTable.Weighting weighting)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(F from, T to) Add a new unweighted relation.
boolean	add(F from, T to, double weight) Add a new weighted relation.
private boolean	addRelation(F from, T to, double weight)
void	addRelations(Collection<LCRelation> relations)
Set<T>	allFrom(F from) Returns the list of to objects corresponding to a given from object.
Map<T,Double>	allFromWithWeights(F from) Returns the map of to objects in the table, with their weights.
Set<F>	allTo(T to) Returns the list of from objects corresponding to a given to object.
Map<F,Double>	allToWithWeights(T to) Returns the map of from objects in the table, with their weights.
F	from(T to) Gets the (unique) from object corresponding to object to.
private BaseRelationalTable.OneMany	fromMode()
RelationalTable.Mode	getMode()
RelationalTable.Weighting	getWeighting()
private Set<BaseRelationalTable.Relation<F,T>>	relations()
boolean	remove(F from, T to) Remove any relationship between from and to
private boolean	removeRelation(F from, T to)
int	size() Returns the total number of relationships in this table.
T	to(F from) Gets the (unique) to object corresponding to object from.
private BaseRelationalTable.OneMany	toMode()
double	weightFromTo(F from, T to) Returns the weight of the relationship between from and to Returns 0.0 if there is no relationship, and 1.0 if there is an unweighted relationship.

Methods inherited from class java.lang.Object

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

Field Detail

WEIGHT_ONE

private static final double WEIGHT_ONE

See Also:

Constant Field Values

WEIGHT_ZERO

private static final double WEIGHT_ZERO

See Also:

Constant Field Values

mode

private final RelationalTable.Mode mode

weighting

private final RelationalTable.Weighting weighting

weightedRelations

private Map<BaseRelationalTable.Relation<F,T>,Double> weightedRelations

unweightedRelations

private Set<BaseRelationalTable.Relation<F,T>> unweightedRelations

fromMultiMap

private Map<F,Set<T>> fromMultiMap

toMultiMap

private Map<T,Set<F>> toMultiMap

fromMap

private Map<F,T> fromMap

toMap

private Map<T,F> toMap

Constructor Detail

BaseRelationalTable

public BaseRelationalTable()

Creates an empty ManyToMany relational table, in ManyToMany mode and with weights

BaseRelationalTable

public BaseRelationalTable(RelationalTable.Mode mode,
                   RelationalTable.Weighting weighting)

Method Detail

fromMode

private BaseRelationalTable.OneMany fromMode()

toMode

private BaseRelationalTable.OneMany toMode()

add

public boolean add(F from,
          T to)

Description copied from interface: RelationalTable

Add a new unweighted relation.

Specified by:

add in interface RelationalTable<F,T>

add

public boolean add(F from,
          T to,
          double weight)

Description copied from interface: RelationalTable

Add a new weighted relation.

Specified by:

add in interface RelationalTable<F,T>

relations

private Set<BaseRelationalTable.Relation<F,T>> relations()

removeRelation

private boolean removeRelation(F from,
                     T to)

addRelation

private boolean addRelation(F from,
                  T to,
                  double weight)

remove

public boolean remove(F from,
             T to)

Description copied from interface: RelationalTable

Remove any relationship between from and to

Specified by:

remove in interface RelationalTable<F,T>

Returns:

true if the table contained the relationship

to

public T to(F from)

Description copied from interface: RelationalTable

Gets the (unique) to object corresponding to object from.

Specified by:

to in interface RelationalTable<F,T>

from

public F from(T to)

Description copied from interface: RelationalTable

Gets the (unique) from object corresponding to object to.

Specified by:

from in interface RelationalTable<F,T>

allFrom

public Set<T> allFrom(F from)

Description copied from interface: RelationalTable

Returns the list of to objects corresponding to a given from object. The natural ordering of the elements will be in decreasing weight.

Specified by:

allFrom in interface RelationalTable<F,T>

allFromWithWeights

public Map<T,Double> allFromWithWeights(F from)

Description copied from interface: RelationalTable

Returns the map of to objects in the table, with their weights. The natural ordering of the keys will be by decreasing weight.

Specified by:

allFromWithWeights in interface RelationalTable<F,T>

allTo

public Set<F> allTo(T to)

Description copied from interface: RelationalTable

Returns the list of from objects corresponding to a given to object. If the table is weighted, the returned list will be returned with the highest weighting first.

Specified by:

allTo in interface RelationalTable<F,T>

allToWithWeights

public Map<F,Double> allToWithWeights(T to)

Description copied from interface: RelationalTable

Returns the map of from objects in the table, with their weights. The natural ordering of the keys will be by decreasing weight.

Specified by:

allToWithWeights in interface RelationalTable<F,T>

weightFromTo

public double weightFromTo(F from,
                  T to)

Description copied from interface: RelationalTable

Returns the weight of the relationship between from and to Returns 0.0 if there is no relationship, and 1.0 if there is an unweighted relationship.

Specified by:

weightFromTo in interface RelationalTable<F,T>

getMode

public RelationalTable.Mode getMode()

Specified by:

getMode in interface RelationalTable<F,T>

getWeighting

public RelationalTable.Weighting getWeighting()

Specified by:

getWeighting in interface RelationalTable<F,T>

size

public int size()

Description copied from interface: RelationalTable

Returns the total number of relationships in this table.

Specified by:

size in interface RelationalTable<F,T>

addRelations

public void addRelations(Collection<LCRelation> relations)