com.bbn.bue.common.evaluation

Class MultimapAlignment<LeftT,RightT>

java.lang.Object

com.bbn.bue.common.evaluation.MultimapAlignment<LeftT,RightT>

All Implemented Interfaces:

Alignment<LeftT,RightT>

@Beta
public final class MultimapAlignment<LeftT,RightT>
extends Object
implements Alignment<LeftT,RightT>

A default implementation for Alignment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultimapAlignment.Builder<LeftT,RightT>

Method Summary

Methods

Modifier and Type	Method and Description
Set<RightT>	alignedToLeftItem(Object leftItem) Get all items in the right set, if any, which align to the provided left set item.
Set<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()
static <LeftT,RightT> MultimapAlignment.Builder<LeftT,RightT>	builder()
static <LeftT,RightT> Alignment<LeftT,RightT>	create(Iterable<? extends LeftT> leftItems, Iterable<? extends RightT> rightItems, com.google.common.collect.Multimap<? extends LeftT,? extends RightT> leftToRight, com.google.common.collect.Multimap<? extends RightT,? extends LeftT> rightToLeft) Creates an Alignment from Multimaps.
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.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <LeftT,RightT> Alignment<LeftT,RightT> create(Iterable<? extends LeftT> leftItems,
                                            Iterable<? extends RightT> rightItems,
                                            com.google.common.collect.Multimap<? extends LeftT,? extends RightT> leftToRight,
                                            com.google.common.collect.Multimap<? extends RightT,? extends LeftT> rightToLeft)

Creates an Alignment from Multimaps.

Parameters:

leftItems - all items in the left alignment set.

rightItems - all items in the right alignment set.

leftToRight - the mapping from left items to their right partners.

rightToLeft - the mapping from right items to their left partners.

leftUnaligned

public Set<LeftT> leftUnaligned()

Description copied from interface: Alignment

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

Specified by:

leftUnaligned in interface Alignment<LeftT,RightT>

rightUnaligned

public Set<RightT> rightUnaligned()

Description copied from interface: Alignment

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

Specified by:

rightUnaligned in interface Alignment<LeftT,RightT>

leftAligned

public Set<LeftT> leftAligned()

Description copied from interface: Alignment

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

Specified by:

leftAligned in interface Alignment<LeftT,RightT>

rightAligned

public Set<RightT> rightAligned()

Description copied from interface: Alignment

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

Specified by:

rightAligned in interface Alignment<LeftT,RightT>

alignedToRightItem

public Set<LeftT> alignedToRightItem(Object rightItem)

Description copied from interface: Alignment

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).

Specified by:

alignedToRightItem in interface Alignment<LeftT,RightT>

alignedToLeftItem

public Set<RightT> alignedToLeftItem(Object leftItem)

Description copied from interface: Alignment

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).

Specified by:

alignedToLeftItem in interface Alignment<LeftT,RightT>

allLeftItems

public Set<LeftT> allLeftItems()

Specified by:

allLeftItems in interface Alignment<LeftT,RightT>

allRightItems

public Set<RightT> allRightItems()

Specified by:

allRightItems in interface Alignment<LeftT,RightT>

builder

public static <LeftT,RightT> MultimapAlignment.Builder<LeftT,RightT> builder()