edu.northwestern.at.monk.model
Class SpellingCriterion

java.lang.Object
  edu.northwestern.at.monk.model.SearchCriterion
      edu.northwestern.at.monk.model.CoreObjectCriterion
          edu.northwestern.at.monk.model.SpellingCriterion

public class SpellingCriterion
extends CoreObjectCriterion

A spelling search criterion.

See Also:

MONK Datastore Overview, Licensing Agreement

Constructor Summary

SpellingCriterion(java.util.Collection<?> values)
Creates a new spelling search criterion.

SpellingCriterion(Spelling... spellings)
Creates a new spelling search criterion.

SpellingCriterion(java.lang.String... tags)
Creates a new spelling search criterion.

Method Summary

Spelling	getSpelling() Gets the spelling.
java.util.Collection<Spelling>	getSpellings() Gets the spellings.
java.lang.String	getTag() Gets the tag.
java.util.Collection<java.lang.String>	getTags() Gets the tags.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpellingCriterion

public SpellingCriterion(java.lang.String... tags)
                  throws ModelException

Creates a new spelling search criterion.

Parameters:

tags - Tags.

Throws:

ModelException -
No such spelling tag

SpellingCriterion

public SpellingCriterion(Spelling... spellings)
                  throws ModelException

Creates a new spelling search criterion.

Parameters:

spellings - Spellings.

Throws:

ModelException -
Should never be thrown.

SpellingCriterion

public SpellingCriterion(java.util.Collection<?> values)
                  throws ModelException

Creates a new spelling search criterion.

Parameters:

values - Collection of tags and/or spellings.

Throws:

ModelException -
No such spelling tag
Collection element is neither String nor Spelling

Method Detail

getSpellings

public java.util.Collection<Spelling> getSpellings()

Gets the spellings.

Returns:

Collection of spellings, or null if none.

getSpelling

public Spelling getSpelling()

Gets the spelling.

Returns:

Spelling, or null if none or more than one.

getTags

public java.util.Collection<java.lang.String> getTags()

Gets the tags.

Returns:

The tags, or null if none.

getTag

public java.lang.String getTag()

Gets the tag.

Returns:

Tag, or null if none or more than one.