edu.northwestern.at.monk.model
Class NumberCategory

java.lang.Object
  edu.northwestern.at.monk.model.TaggedObject
      edu.northwestern.at.monk.model.CoreObject
          edu.northwestern.at.monk.model.NumberCategory

All Implemented Interfaces:

Feature, java.lang.Comparable<NumberCategory>

public class NumberCategory
extends CoreObject
implements Feature, java.lang.Comparable<NumberCategory>

A number part of speech category.

See Also:

MONK Datastore Overview, Licensing Agreement

Nested Class Summary

static class	NumberCategory.Comparator A multi-column number category comparator.
static class	NumberCategory.SortOption Number category sorting options.

Method Summary

static int	compare(NumberCategory cat1, NumberCategory cat2) Compares two number categories with null values permitted.
int	compareTo(NumberCategory other) Compares this instance with another.
static java.util.Collection<NumberCategory>	find(java.util.Collection<SearchCriterion> criteria) Finds number categories.
static java.util.Collection<NumberCategory>	find(SearchCriteria criteria) Finds number categories.
static java.util.Collection<NumberCategory>	find(SearchCriterion... criteria) Finds number categories.
static NumberCategory	get(java.lang.String tag) Gets a number category by tag.
static java.util.Collection<NumberCategory>	getAll() Gets all the number categories.
static NumberCategory[]	sort(java.util.Collection<NumberCategory> collection, NumberCategory.SortOption... options) Sorts a collection of number categories.
static void	sort(NumberCategory[] array, NumberCategory.SortOption... options) Sorts an array of number categories.

Methods inherited from class edu.northwestern.at.monk.model.TaggedObject

getTag

Methods inherited from class java.lang.Object

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

Method Detail

get

public static NumberCategory get(java.lang.String tag)

Gets a number category by tag.

Parameters:

tag - Tag.

Returns:

Number category, or null if none.

getAll

public static java.util.Collection<NumberCategory> getAll()

Gets all the number categories.

Returns:

Unmodifiable collection of all the number categories in case and diacritical-insensitive alphabetical order by tag.

find

public static java.util.Collection<NumberCategory> find(SearchCriterion... criteria)
                                                 throws ModelException

Finds number categories.

Parameters:

criteria - Search criteria.

Returns:

Collection of number categories, in an undefined order. If you want the result to be ordered, you must call a sort method.

Throws:

ModelException -
Unable to execute search

find

public static java.util.Collection<NumberCategory> find(java.util.Collection<SearchCriterion> criteria)
                                                 throws ModelException

Finds number categories.

Parameters:

criteria - Collection of search criteria.

Returns:

Collection of number categories, in an undefined order. If you want the result to be ordered, you must call a sort method.

Throws:

ModelException -
Unable to execute search

find

public static java.util.Collection<NumberCategory> find(SearchCriteria criteria)
                                                 throws ModelException

Finds number categories.

Parameters:

criteria - Search criteria.

Returns:

Collection of number categories, in an undefined order. If you want the result to be ordered, you must call a sort method.

Throws:

ModelException -
Unable to execute search

sort

public static void sort(NumberCategory[] array,
                        NumberCategory.SortOption... options)

Sorts an array of number categories.

Parameters:

array - Array of number categories.

options - Sort options, or null to use the natural ordering.

sort

public static NumberCategory[] sort(java.util.Collection<NumberCategory> collection,
                                    NumberCategory.SortOption... options)

Sorts a collection of number categories.

Parameters:

collection - Collection of number categories.

options - Sort options, or null to use the natural ordering.

Returns:

Sorted array of number categories.

compare

public static int compare(NumberCategory cat1,
                          NumberCategory cat2)

Compares two number categories with null values permitted.

Number categories are ordered in case and diacritical-insensitve increasing alphabetical order by tag. Null values are equal to each other but greater than all other values.

Parameters:

cat1 - First number category.

cat2 - Second number category.

Returns:

A negative integer, zero, or a positive integer as this instance is less than, equal to, or greater than the specified instance.

compareTo

public int compareTo(NumberCategory other)

Compares this instance with another.

Number categories are ordered in case and diacritical-insensitve increasing alphabetical order by tag.

Specified by:

compareTo in interface java.lang.Comparable<NumberCategory>

Parameters:

other - The other instance to be compared.

Returns:

A negative integer, zero, or a positive integer as this instance is less than, equal to, or greater than the specified instance.