edu.northwestern.at.monk.model
Class NegativeCategory

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

All Implemented Interfaces:

Feature, java.lang.Comparable<NegativeCategory>

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

A negative part of speech category.

See Also:

MONK Datastore Overview, Licensing Agreement

Nested Class Summary

static class	NegativeCategory.Comparator A multi-column number category comparator
static class	NegativeCategory.SortOption Negative category sorting options.

Method Summary

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

Gets a negative category by tag.

Parameters:

tag - Tag.

Returns:

Negative category, or null if none.

getAll

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

Gets all the negative categories.

Returns:

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

find

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

Finds negative catgories.

Parameters:

criteria - Search criteria.

Returns:

Collection of negative catgories, 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<NegativeCategory> find(java.util.Collection<SearchCriterion> criteria)
                                                   throws ModelException

Finds negative catgories.

Parameters:

criteria - Collection of search criteria.

Returns:

Collection of negative catgories, 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<NegativeCategory> find(SearchCriteria criteria)
                                                   throws ModelException

Finds negative categories.

Parameters:

criteria - Search criteria.

Returns:

Collection of negative 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(NegativeCategory[] array,
                        NegativeCategory.SortOption... options)

Sorts an array of negative categories.

Parameters:

array - Array of negative categories.

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

sort

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

Sorts a collection of negative categories.

Parameters:

collection - Collection of negative categories.

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

Returns:

Sorted array of negative categories.

compare

public static int compare(NegativeCategory cat1,
                          NegativeCategory cat2)

Compares two negative categories with null values permitted.

Negative 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 negative category.

cat2 - Second negative 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(NegativeCategory other)

Compares this instance with another.

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

Specified by:

compareTo in interface java.lang.Comparable<NegativeCategory>

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.