org.lcsim.event

Interface RelationalTable<F,T>

All Known Implementing Classes:

BaseRelationalTable

public interface RelationalTable<F,T>

A relational table allows associations between objects. It is designed to be persisted to/from LCIO files as a collection of LCRelations, but to add considerably more functionality than a raw collection of relations. It can be set to mode 1-1, 1-n, n-1, n-m. When adding new relations they will silently replace existing relationships based on the mode. It allows weights to be associated with each relation, unless it is set to weighting mode UNWEIGHTED.

Author:

tonyj

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RelationalTable.Mode
static class	RelationalTable.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.
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.
RelationalTable.Mode	getMode()
RelationalTable.Weighting	getWeighting()
boolean	remove(F from, T to) Remove any relationship between from and 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.
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.

Method Detail

add

boolean add(F from,
          T to)

Add a new unweighted relation.

add

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

Add a new weighted relation.

Throws:

IllegalArgumentExeption - if table in unweighted and weight is not 1

allFrom

Set<T> allFrom(F from)

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

allFromWithWeights

Map<T,Double> allFromWithWeights(F from)

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

allTo

Set<F> allTo(T to)

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.

allToWithWeights

Map<F,Double> allToWithWeights(T to)

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

from

F from(T to)

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

Throws:

IllegalArgumentException - if more than one to object corresponds to to

getMode

RelationalTable.Mode getMode()

getWeighting

RelationalTable.Weighting getWeighting()

remove

boolean remove(F from,
             T to)

Remove any relationship between from and to

Returns:

true if the table contained the relationship

size

int size()

Returns the total number of relationships in this table.

to

T to(F from)

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

Throws:

IllegalArgumentException - if more than one to object corresponds to from

weightFromTo

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.