ERXFullTextQualifier Class Reference

Inherits com::webobjects::eocontrol::EOQualifier, and com::webobjects::eocontrol::EOQualifierEvaluation.

Collaboration diagram for ERXFullTextQualifier:

[legend]

List of all members.

Public Types
enum	MatchType { ALL, ANY }
Public Member Functions
void	addQualifierKeysToSet (NSMutableSet keys)
ERXFullTextQualifier	clone ()
	ERXFullTextQualifier (String keyPath, MatchType matchType, String...terms)
	ERXFullTextQualifier (String keyPath, MatchType matchType, NSArray< String > terms)
	ERXFullTextQualifier (String keyPath, String indexName, MatchType matchType, String...terms)
	ERXFullTextQualifier (String keyPath, String indexName, MatchType matchType, NSArray< String > terms)
boolean	evaluateWithObject (Object object)
String	indexName ()
String	keyPath ()
MatchType	matchType ()
EOQualifier	qualifierWithBindings (NSDictionary bindings, boolean requiresAll)
NSArray< String >	terms ()
void	validateKeysWithRootClassDescription (EOClassDescription classDescription)
Static Public Attributes
static final NSSelector	FullTextContainsSelector = new NSSelector(ERXFullTextQualifier.FullTextContainsSelectorName, new Class[] { String.class })
static final String	FullTextContainsSelectorName = "fulltextContains"
Private Attributes
String	_indexName
String	_keyPath
MatchType	_matchType
NSArray< String >	_terms

---

Detailed Description

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.

Author:

mschrag

---

Member Enumeration Documentation

enum MatchType

Enumerator:

ALL	All search terms must match for the qualifier to match.
ANY	Only one search term must match for the qualifier to match.

---

Constructor & Destructor Documentation

ERXFullTextQualifier	(	String	keyPath,
		String	indexName,
		MatchType	matchType,
		NSArray< 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	(	String	keyPath,
		String	indexName,
		MatchType	matchType,
		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	(	String	keyPath,
		MatchType	matchType,
		NSArray< 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	(	String	keyPath,
		MatchType	matchType,
		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

---

Member Function Documentation

void addQualifierKeysToSet

(

NSMutableSet

keys

)

ERXFullTextQualifier clone

(

)

boolean evaluateWithObject

(

Object

object

)

String indexName

(

)

Returns the index name for this qualifier.

Returns:

the index name for this qualifier

String keyPath

(

)

Returns the keypath for this qualifier.

Returns:

the keypath for this qualifier

MatchType matchType

(

)

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

Returns:

the match type (ANY or ALL) for this qualifier

EOQualifier qualifierWithBindings	(	NSDictionary	bindings,
		boolean	requiresAll
	)

NSArray<String> terms

(

)

Returns the array of search terms for this qualifier.

Returns:

the array of search terms for this qualifier

void validateKeysWithRootClassDescription

(

EOClassDescription

classDescription

)

---

Member Data Documentation

String _indexName [private]

String _keyPath [private]

MatchType _matchType [private]

NSArray<String> _terms [private]

final NSSelector FullTextContainsSelector = new NSSelector(ERXFullTextQualifier.FullTextContainsSelectorName, new Class[] { String.class }) [static]

final String FullTextContainsSelectorName = "fulltextContains" [static]

---

The documentation for this class was generated from the following file:

• /opt/source/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/qualifiers/ERXFullTextQualifier.java