edu.northwestern.at.monk.model
Class SyntaxCategory

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

All Implemented Interfaces:

Feature, java.lang.Comparable<SyntaxCategory>

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

A syntax part of speech category.

See Also:

MONK Datastore Overview, Licensing Agreement

Nested Class Summary

static class	SyntaxCategory.Comparator A multi-column syntax category comparator.
static class	SyntaxCategory.SortOption Syntax category sorting options.

Method Summary

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

Gets a syntax category by tag.

Parameters:

tag - Tag.

Returns:

Syntax category, or null if none.

getAll

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

Gets all the syntax categories.

Returns:

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

find

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

Finds syntax categories.

Parameters:

criteria - Search criteria.

Returns:

Collection of syntax 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<SyntaxCategory> find(java.util.Collection<SearchCriterion> criteria)
                                                 throws ModelException

Finds syntax categories.

Parameters:

criteria - Collection of search criteria.

Returns:

Collection of syntax 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<SyntaxCategory> find(SearchCriteria criteria)
                                                 throws ModelException

Finds syntax categories.

Parameters:

criteria - Search criteria.

Returns:

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

Sorts an array of syntax categories.

Parameters:

array - Array of syntax categories.

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

sort

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

Sorts a collection of syntax categories.

Parameters:

collection - Collection of syntax categories.

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

Returns:

Sorted array of syntax categories.

compare

public static int compare(SyntaxCategory cat1,
                          SyntaxCategory cat2)

Compares two syntax categories with null values permitted.

Syntax 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 syntax category.

cat2 - Second syntax 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(SyntaxCategory other)

Compares this instance with another.

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

Specified by:

compareTo in interface java.lang.Comparable<SyntaxCategory>

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.