er.extensions.eof.qualifiers
Class ERXFullTextQualifier

java.lang.Object
  com.webobjects.eocontrol.EOQualifier
      er.extensions.eof.qualifiers.ERXFullTextQualifier

All Implemented Interfaces:

com.webobjects.eocontrol.EOQualifierEvaluation, java.io.Serializable, java.lang.Cloneable

public class ERXFullTextQualifier
extends com.webobjects.eocontrol.EOQualifier
implements java.lang.Cloneable, com.webobjects.eocontrol.EOQualifierEvaluation

ERXFullTextQualifier provides a qualifier implementation for searching with a fulltext index. This depends on ERXSQLHelper.sqlForFullTextQuery providing an implementation for your particular database. Note that because of differences in implementions of fulltext indexing on various databases, the results you obtain using this qualifier will vary across implementations. Additionally, executing this qualifier on an array of EO's may differ from executing the qualifier in your database. When qualifying on an array, the qualifier does not address stemming and stop words.

See Also:

Serialized Form

Author:

mschrag

Nested Class Summary

static class

ERXFullTextQualifier.MatchType

Nested classes/interfaces inherited from class com.webobjects.eocontrol.EOQualifier

com.webobjects.eocontrol.EOQualifier.Comparison, com.webobjects.eocontrol.EOQualifier.ComparisonSupport, com.webobjects.eocontrol.EOQualifier.QualifierVariableSubstitutionException

Field Summary

static com.webobjects.foundation.NSSelector	FullTextContainsSelector
static java.lang.String	FullTextContainsSelectorName

Fields inherited from class com.webobjects.eocontrol.EOQualifier

_CLASS, QualifierOperatorCaseInsensitiveLike, QualifierOperatorContains, QualifierOperatorEqual, QualifierOperatorGreaterThan, QualifierOperatorGreaterThanOrEqualTo, QualifierOperatorLessThan, QualifierOperatorLessThanOrEqualTo, QualifierOperatorLike, QualifierOperatorNotEqual

Fields inherited from interface com.webobjects.eocontrol.EOQualifierEvaluation

_CLASS

Constructor Summary

ERXFullTextQualifier(java.lang.String keyPath, ERXFullTextQualifier.MatchType matchType, com.webobjects.foundation.NSArray<java.lang.String> terms)
Constructs an ERXFullTextQualifier defaulting indexName to the same as keyPath.

ERXFullTextQualifier(java.lang.String keyPath, ERXFullTextQualifier.MatchType matchType, java.lang.String... terms)
Constructs an ERXFullTextQualifier defaulting indexName to the same as keyPath.

ERXFullTextQualifier(java.lang.String keyPath, java.lang.String indexName, ERXFullTextQualifier.MatchType matchType, com.webobjects.foundation.NSArray<java.lang.String> terms)
Constructs an ERXFullTextQualifier.

ERXFullTextQualifier(java.lang.String keyPath, java.lang.String indexName, ERXFullTextQualifier.MatchType matchType, java.lang.String... terms)
Constructs an ERXFullTextQualifier.

Method Summary

void	addQualifierKeysToSet(com.webobjects.foundation.NSMutableSet keys)
ERXFullTextQualifier	clone()
boolean	evaluateWithObject(java.lang.Object object)
java.lang.String	indexName() Returns the index name for this qualifier.
java.lang.String	keyPath() Returns the keypath for this qualifier.
ERXFullTextQualifier.MatchType	matchType() Returns the match type (ANY or ALL) for this qualifier.
com.webobjects.eocontrol.EOQualifier	qualifierWithBindings(com.webobjects.foundation.NSDictionary bindings, boolean requiresAll)
com.webobjects.foundation.NSArray<java.lang.String>	terms() Returns the array of search terms for this qualifier.
void	validateKeysWithRootClassDescription(com.webobjects.eocontrol.EOClassDescription classDescription)

Methods inherited from class com.webobjects.eocontrol.EOQualifier

_accept, _isEmpty, allQualifierKeys, allQualifierOperators, bindingKeys, filterArrayWithQualifier, filteredArrayWithQualifier, keyPathForBindingKey, operatorSelectorForSelectorNamed, operatorSelectorForString, qualifierToMatchAllValues, qualifierToMatchAnyValue, qualifierWithQualifierFormat, relationalQualifierOperators, stringForOperatorSelector

Methods inherited from class java.lang.Object

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

Field Detail

FullTextContainsSelectorName

public static final java.lang.String FullTextContainsSelectorName

See Also:

Constant Field Values

FullTextContainsSelector

public static final com.webobjects.foundation.NSSelector FullTextContainsSelector

Constructor Detail

ERXFullTextQualifier

public ERXFullTextQualifier(java.lang.String keyPath,
                            java.lang.String indexName,
                            ERXFullTextQualifier.MatchType matchType,
                            com.webobjects.foundation.NSArray<java.lang.String> terms)

Constructs an ERXFullTextQualifier.

Parameters:

keyPath - the keypath to qualify on (some databases may ignore this)

indexName - the name of the index to use (some databases may ignore this)

matchType - ANY or ALL

terms - the array of search terms

ERXFullTextQualifier

public ERXFullTextQualifier(java.lang.String keyPath,
                            java.lang.String indexName,
                            ERXFullTextQualifier.MatchType matchType,
                            java.lang.String... terms)

Constructs an ERXFullTextQualifier.

Parameters:

keyPath - the keypath to qualify on (some databases may ignore this)

indexName - the name of the index to use (some databases may ignore this)

matchType - ANY or ALL

terms - the list of search terms

ERXFullTextQualifier

public ERXFullTextQualifier(java.lang.String keyPath,
                            ERXFullTextQualifier.MatchType matchType,
                            com.webobjects.foundation.NSArray<java.lang.String> terms)

Constructs an ERXFullTextQualifier defaulting indexName to the same as keyPath.

Parameters:

keyPath - the keypath to qualify on (some databases may ignore this)

matchType - ANY or ALL

terms - the array of search terms

ERXFullTextQualifier

public ERXFullTextQualifier(java.lang.String keyPath,
                            ERXFullTextQualifier.MatchType matchType,
                            java.lang.String... terms)

Constructs an ERXFullTextQualifier defaulting indexName to the same as keyPath.

Parameters:

keyPath - the keypath to qualify on (some databases may ignore this)

matchType - ANY or ALL

terms - the list of search terms

Method Detail

keyPath

public java.lang.String keyPath()

Returns the keypath for this qualifier.

Returns:

the keypath for this qualifier

indexName

public java.lang.String indexName()

Returns the index name for this qualifier.

Returns:

the index name for this qualifier

matchType

public ERXFullTextQualifier.MatchType matchType()

Returns the match type (ANY or ALL) for this qualifier.

Returns:

the match type (ANY or ALL) for this qualifier

terms

public com.webobjects.foundation.NSArray<java.lang.String> terms()

Returns the array of search terms for this qualifier.

Returns:

the array of search terms for this qualifier

clone

public ERXFullTextQualifier clone()

Overrides:

clone in class com.webobjects.eocontrol.EOQualifier

addQualifierKeysToSet

public void addQualifierKeysToSet(com.webobjects.foundation.NSMutableSet keys)

Specified by:

addQualifierKeysToSet in class com.webobjects.eocontrol.EOQualifier

qualifierWithBindings

public com.webobjects.eocontrol.EOQualifier qualifierWithBindings(com.webobjects.foundation.NSDictionary bindings,
                                                                  boolean requiresAll)

Specified by:

qualifierWithBindings in class com.webobjects.eocontrol.EOQualifier

validateKeysWithRootClassDescription

public void validateKeysWithRootClassDescription(com.webobjects.eocontrol.EOClassDescription classDescription)

Specified by:

validateKeysWithRootClassDescription in class com.webobjects.eocontrol.EOQualifier

evaluateWithObject

public boolean evaluateWithObject(java.lang.Object object)

Specified by:

evaluateWithObject in interface com.webobjects.eocontrol.EOQualifierEvaluation

Overrides:

evaluateWithObject in class com.webobjects.eocontrol.EOQualifier