com.arsdigita.glossary
Class WordCollection

java.lang.Object
  extended bycom.arsdigita.domain.DomainQuery
      extended bycom.arsdigita.domain.DomainCollection
          extended bycom.arsdigita.glossary.WordCollection
All Implemented Interfaces:
com.arsdigita.persistence.DataQuery

public class WordCollection
extends com.arsdigita.domain.DomainCollection

Version:
$Revision: #2 $
Author:
Kevin Scaldeferri (kevin@arsdigita.com)

Field Summary
 
Fields inherited from class com.arsdigita.domain.DomainCollection
m_dataCollection, versionId
 
Fields inherited from class com.arsdigita.domain.DomainQuery
m_dataQuery
 
Method Summary
 void contains(String search)
          Filters the collection to search for the specified string in either the word or the definition.
 void duplicates(String word, GlossaryWord gw)
          Filters the collection to return exact matches to the specified String which are not the specified GlossaryWord
 void exactMatch(String word)
          Filters the collection to return only exact matches to the specified word
 com.arsdigita.domain.DomainObject getDomainObject()
           
 GlossaryWord getWord()
          Wrapper to getDomainObject which casts to a GlossaryWord
 void startsWith(String start)
          Filters the collection to only return GlossaryWords which start with the specified string.
 
Methods inherited from class com.arsdigita.domain.DomainQuery
addEqualsFilter, addFilter, addFilter, addInSubqueryFilter, addInSubqueryFilter, addNotEqualsFilter, addNotInSubqueryFilter, addOrder, addOrderWithNull, addPath, alias, clearFilter, clearOrder, close, first, get, getFilterFactory, getParameter, getPosition, getPropertyValues, getType, hasProperty, isAfterLast, isBeforeFirst, isEmpty, isFirst, isLast, last, next, previous, removeFilter, reset, rewind, setFilter, setOrder, setParameter, setRange, setRange, setReturnsLowerBound, setReturnsUpperBound, size
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

startsWith

public void startsWith(String start)
Filters the collection to only return GlossaryWords which start with the specified string. If the string is null, then all words are included in the collection


exactMatch

public void exactMatch(String word)
Filters the collection to return only exact matches to the specified word


duplicates

public void duplicates(String word,
                       GlossaryWord gw)
Filters the collection to return exact matches to the specified String which are not the specified GlossaryWord


contains

public void contains(String search)
Filters the collection to search for the specified string in either the word or the definition. A null search string will return no results. (This usually indicates an error condition.)


getDomainObject

public com.arsdigita.domain.DomainObject getDomainObject()

getWord

public GlossaryWord getWord()
Wrapper to getDomainObject which casts to a GlossaryWord



Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 19 2004:2349 UTC