edu.northwestern.at.monk.model
Class PatternCriterion

java.lang.Object
  extended by edu.northwestern.at.monk.model.SearchCriterion
      extended by edu.northwestern.at.monk.model.PatternCriterion
Direct Known Subclasses:
AuthorFlourishedPatternCriterion, AuthorGenderPatternCriterion, AuthorNamePatternCriterion, AuthorOriginPatternCriterion, ContextPatternCriterion, CorpusTitlePatternCriterion, LemmaHeadWordPatternCriterion, LemmaPatternCriterion, PosPatternCriterion, SpellingPatternCriterion, StandardSpellingPatternCriterion, WorkAvailabilityPatternCriterion, WorkGenrePatternCriterion, WorkPartTagPatternCriterion, WorkPartTitlePatternCriterion, WorkPartTypePatternCriterion, WorkSubgenrePatternCriterion, WorkTagPatternCriterion, WorkTitlePatternCriterion

public abstract class PatternCriterion
extends SearchCriterion

A pattern search criterion.

Pattern criteria are used to match string value attributes.

Patterns may use the following metacharacters:

* Matches any sequence of zero or more characters.
. Matches any single character.
| p1 | p2 matches the pattern p1 or the pattern p2.

Each pattern criterion class offers a single constructor of the following form, where T is the type of the criterion:

T (String pattern)

An empty or "no-op" criterion that matches any value can be constructed with a null or empty value for the pattern.

See Also:
MONK Datastore Overview, Licensing Agreement

Method Summary
 java.lang.String getPattern()
          Gets the pattern.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getPattern

public java.lang.String getPattern()
Gets the pattern.

Returns:
Pattern, or null if none.