com.mtnfog.entity.comparators

Class EntityComparator

java.lang.Object

com.mtnfog.entity.comparators.EntityComparator

All Implemented Interfaces:

Comparator<Entity>

public class EntityComparator
extends Object
implements Comparator<Entity>

Comparator for entities. Supports sorting by entity confidence and entity text.

Author:

Mountain Fog, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityComparator.Order

Constructor Summary

Constructors

Constructor and Description
EntityComparator(EntityComparator.Order sortingBy) Creates a new EntityComparator with the given sorting method.

Method Summary

Modifier and Type	Method and Description
int	compare(Entity entity1, Entity entity2)
EntityComparator.Order	getSortingBy() Gets the sorting order.
static Set<Entity>	sort(Set<Entity> entities, EntityComparator.Order sortingBy) Sort the entities.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

EntityComparator

public EntityComparator(EntityComparator.Order sortingBy)

Creates a new EntityComparator with the given sorting method.

Parameters:

sortingBy - The EntityComparator.Order to sort the entities.

Method Detail

compare

public int compare(Entity entity1,
                   Entity entity2)

Specified by:

compare in interface Comparator<Entity>

getSortingBy

public EntityComparator.Order getSortingBy()

Gets the sorting order.

Returns:

The EntityComparator.Order.

sort

public static Set<Entity> sort(Set<Entity> entities,
                               EntityComparator.Order sortingBy)

Sort the entities.

Parameters:

entities - The set of entities.

sortingBy - The sorting method.

Returns:

A set of sorted entities.