edu.northwestern.at.monk.model
Class DegreeCategory

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

All Implemented Interfaces:

Feature, java.lang.Comparable<DegreeCategory>

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

A degree part of speech category.

See Also:

MONK Datastore Overview, Licensing Agreement

Nested Class Summary

static class	DegreeCategory.Comparator A multi-column degree category comparator.
static class	DegreeCategory.SortOption Degree category sorting options.

Method Summary

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

Gets a degree category by tag.

Parameters:

tag - Tag.

Returns:

Degree category, or null if none.

getAll

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

Gets all the degree categories.

Returns:

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

find

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

Finds degree categories.

Parameters:

criteria - Search criteria.

Returns:

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

Finds degree categories.

Parameters:

criteria - Collection of search criteria.

Returns:

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

Finds degree categories.

Parameters:

criteria - Search criteria.

Returns:

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

Sorts an array of degree categories.

Parameters:

array - Array of degree categories.

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

sort

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

Sorts a collection of degree categories.

Parameters:

collection - Collection of degree categories.

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

Returns:

Sorted array of degree categories.

compare

public static int compare(DegreeCategory cat1,
                          DegreeCategory cat2)

Compares two degree categories with null values permitted.

Degree 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 degree category.

cat2 - Second degree 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(DegreeCategory other)

Compares this instance with another.

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

Specified by:

compareTo in interface java.lang.Comparable<DegreeCategory>

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.