org.mmbase.storage.search
Interface StringSearchConstraint

All Superinterfaces:

Constraint, FieldConstraint

All Known Implementing Classes:

BasicStringSearchConstraint

public interface StringSearchConstraint

extends FieldConstraint

A constraint specifically for advanced types of text searches.

In addition to searchterms, a search type and a match type can be specified:

The search type specifies how the search is performed: Must be one of:

• SEARCH_TYPE_WORD_ORIENTED - searches for the most occurrences of the words in the search terms. Order and proximity of words is not significant.
• SEARCH_TYPE_PHRASE_ORIENTED - searches for occurrence of the sequence of words in the search terms.
• SEARCH_TYPE_PROXIMITY_ORIENTED - searches for the most occurrences of the words within a given word distance. Order of words is not important.

The match type specifies how individual words in the search terms are matched with words in the searched text.

• MATCH_TYPE_LITERAL - exact match only
• MATCH_TYPE_FUZZY - fuzzy match: matches words within the specified number of typo's as well (specified by parameter PARAM_FUZZINESS)
• MATCH_TYPE_SYNONYM - matches synonyms as well

The searchterms may containt the following wildchard characters as well:

• % for any string
• _ for a single character

Depending on searchtype and searchmode, the following parameters can be set:

• PARAM_FUZZINESS - Float, specifies maximum allowed number of typo's per word, expressed as fraction of word length. (E.g. 0,2 means: maximum 2 typo's for 10 letter words.).
  This parameter is only relevant when used with match type MATCH_TYPE_FUZZY. It can only be set for this match type, and is cleared when the match type is set to another value.
• PARAM_PROXIMITY_LIMIT - Integer, specifies maximum distance between searched words.
  This parameter is only relevant when used with search type SEARCH_TYPE_PROXIMITY_ORIENTED. It can only be set for this search type, and is cleared when the search type is set to another value.

Since:

MMBase-1.7

Version:

$Id: StringSearchConstraint.java,v 1.4 2005/04/25 14:56:57 pierre Exp $

Author:

Rob van Maris

Field Summary

static String[]	MATCH_TYPE_DESCRIPTIONS Match type descriptions corresponding to the match type values: MATCH_TYPE_LITERAL, MATCH_TYPE_FUZZY, and MATCH_TYPE_SYNONYM
static int	MATCH_TYPE_FUZZY Match type for fuzzy matching.
static int	MATCH_TYPE_LITERAL Match type for literal matching.
static int	MATCH_TYPE_SYNONYM Match type for synonym matching.
static String	PARAM_FUZZINESS Name for parameter specifying fuzziness for fuzzy matching.
static String	PARAM_PROXIMITY_LIMIT Name for parameter specifying proximity limit for proximity oriented search.
static String[]	SEARCH_TYPE_DESCRIPTIONS Search type descriptions corresponding to the search type values: SEARCH_TYPE_WORD_ORIENTED, SEARCH_TYPE_PHRASE_ORIENTED, and SEARCH_TYPE_PROXIMITY_ORIENTED
static int	SEARCH_TYPE_PHRASE_ORIENTED Search type for phrase oriented search.
static int	SEARCH_TYPE_PROXIMITY_ORIENTED Search type for proximity oriented search.
static int	SEARCH_TYPE_WORD_ORIENTED Search type for word oriented search.

Method Summary

int	getMatchType() Gets the match type.
Map	getParameters() Gets value of additional parameters.
List	getSearchTerms() Gets the list of searchterms.
int	getSearchType() Gets the search type, this specifies how the search is performed.
String	toString() Returns a string representation of this StringSearchConstraint.

Methods inherited from interface org.mmbase.storage.search.FieldConstraint

getField, isCaseSensitive

Methods inherited from interface org.mmbase.storage.search.Constraint

equals, getBasicSupportLevel, hashCode, isInverse

Field Detail

SEARCH_TYPE_WORD_ORIENTED

public static final int SEARCH_TYPE_WORD_ORIENTED

Search type for word oriented search.

See Also:

Constant Field Values

SEARCH_TYPE_PHRASE_ORIENTED

public static final int SEARCH_TYPE_PHRASE_ORIENTED

Search type for phrase oriented search.

See Also:

Constant Field Values

SEARCH_TYPE_PROXIMITY_ORIENTED

public static final int SEARCH_TYPE_PROXIMITY_ORIENTED

Search type for proximity oriented search.

See Also:

Constant Field Values

SEARCH_TYPE_DESCRIPTIONS

public static final String[] SEARCH_TYPE_DESCRIPTIONS

Search type descriptions corresponding to the search type values: SEARCH_TYPE_WORD_ORIENTED, SEARCH_TYPE_PHRASE_ORIENTED, and SEARCH_TYPE_PROXIMITY_ORIENTED

MATCH_TYPE_LITERAL

public static final int MATCH_TYPE_LITERAL

Match type for literal matching.

See Also:

Constant Field Values

MATCH_TYPE_FUZZY

public static final int MATCH_TYPE_FUZZY

Match type for fuzzy matching.

See Also:

Constant Field Values

MATCH_TYPE_SYNONYM

public static final int MATCH_TYPE_SYNONYM

Match type for synonym matching.

See Also:

Constant Field Values

MATCH_TYPE_DESCRIPTIONS

public static final String[] MATCH_TYPE_DESCRIPTIONS

Match type descriptions corresponding to the match type values: MATCH_TYPE_LITERAL, MATCH_TYPE_FUZZY, and MATCH_TYPE_SYNONYM

PARAM_FUZZINESS

public static final String PARAM_FUZZINESS

Name for parameter specifying fuzziness for fuzzy matching.

See Also:

Constant Field Values

PARAM_PROXIMITY_LIMIT

public static final String PARAM_PROXIMITY_LIMIT

Name for parameter specifying proximity limit for proximity oriented search.

See Also:

Constant Field Values

Method Detail

getSearchType

public int getSearchType()

Gets the search type, this specifies how the search is performed.

getParameters

public Map getParameters()

Gets value of additional parameters.

Returns:

The parameters, as an unmodifiable Map.

getMatchType

public int getMatchType()

Gets the match type.

getSearchTerms

public List getSearchTerms()

Gets the list of searchterms.

Returns:

The searchterms, as an unmodifiable List.

toString

public String toString()

Returns a string representation of this StringSearchConstraint. The string representation has the form "StringSearchConstraint(inverse:<:inverse>, field:<field>, casesensitive:<casesensitive>, searchtype:<searchtype>, matchtype:<matchtype>, parameters:<parameters>, searchterms:<searchterms>)" where

• <inverse>is the value returned by isInverse()
• <field> is the field alias returned by getField().getAlias()
• <casesensitive> is the value returned by isCaseSensitive()
• <searchtype> is the value returned by getSearchType()
• <matchtype> is the value returned by getMatchType()
• <parameters> is the map returned by getParameters()
• <searchterms> is the list returned by getParameters()

  Returns:

  A string representation of this FieldValueConstraint.