com.bbn.bue.common.evaluation

Interface Alignment<LeftT,RightT>

Type Parameters:

LeftT - The type of objects in the left set. Covariant.

RightT - The type of objects in the right set. Covariant.

All Known Subinterfaces:

ProvenancedAlignment<LeftT,LeftProvT,RightT,RightProvT>

All Known Implementing Classes:

EquivalenceBasedProvenancedAlignment, MultimapAlignment

@Beta
public interface Alignment<LeftT,RightT>

Represents a 'pairing up' of two groups of objects of the same type, the key set and the test set. Alignments are intended to be immutable, so it is always safe to case an Alignment<T> to Alignment<S> for any super-type of T. The objects being aligned must have hash codes and equality methods compatible with use in sets and maps.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<RightT>	alignedToLeftItem(Object leftItem) Get all items in the right set, if any, which align to the provided left set item.
Collection<LeftT>	alignedToRightItem(Object rightItem) Get all items in the left set, if any, which align to the provided right set item.
Set<LeftT>	allLeftItems()
Set<RightT>	allRightItems()
Set<LeftT>	leftAligned() Those items in the left set which were paired with something in the right.
Set<LeftT>	leftUnaligned() Those items in the left set which were not paired with anything in the right.
Set<RightT>	rightAligned() Those items in the right set which were paired with something in the right.
Set<RightT>	rightUnaligned() Those items in the right set which were not paired with anything in the right.

Method Detail

leftUnaligned

Set<LeftT> leftUnaligned()

Those items in the left set which were not paired with anything in the right.

rightUnaligned

Set<RightT> rightUnaligned()

Those items in the right set which were not paired with anything in the right.

leftAligned

Set<LeftT> leftAligned()

Those items in the left set which were paired with something in the right.

rightAligned

Set<RightT> rightAligned()

Those items in the right set which were paired with something in the right.

alignedToRightItem

Collection<LeftT> alignedToRightItem(Object rightItem)

Get all items in the left set, if any, which align to the provided right set item. If x is in alignedToRightItem(y), then y is in alignedToRightItem(x).

alignedToLeftItem

Collection<RightT> alignedToLeftItem(Object leftItem)

Get all items in the right set, if any, which align to the provided left set item. If x is in alignedToRightItem(y), then y is in alignedToRightItem(x).

allLeftItems

Set<LeftT> allLeftItems()

allRightItems

Set<RightT> allRightItems()