edu.northwestern.at.monk.model
Class MoodCategory

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

All Implemented Interfaces:

Feature, java.lang.Comparable<MoodCategory>

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

A mood part of speech category.

See Also:

MONK Datastore Overview, Licensing Agreement

Nested Class Summary

static class	MoodCategory.Comparator A multi-column mood category comparator.
static class	MoodCategory.SortOption Mood category sorting options.

Method Summary

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

Gets a mood category by tag.

Parameters:

tag - Tag.

Returns:

Mood category, or null if none.

getAll

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

Gets all the mood categories.

Returns:

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

find

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

Finds mood categories.

Parameters:

criteria - Search criteria.

Returns:

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

Finds mood categories.

Parameters:

criteria - Collection of search criteria.

Returns:

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

Finds mood categories.

Parameters:

criteria - Search criteria.

Returns:

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

Sorts an array of mood categories.

Parameters:

array - Array of mood categories.

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

sort

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

Sorts a collection of mood categories.

Parameters:

collection - Collection of mood categories.

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

Returns:

Sorted array of mood categories.

compare

public static int compare(MoodCategory cat1,
                          MoodCategory cat2)

Compares two mood categories with null values permitted.

Mood 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 mood category.

cat2 - Second mood 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(MoodCategory other)

Compares this instance with another.

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

Specified by:

compareTo in interface java.lang.Comparable<MoodCategory>

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.