org.apache.cocoon.bean.query
Interface SimpleLuceneCriterion

All Known Implementing Classes:
SimpleLuceneCriterionBean

public interface SimpleLuceneCriterion

The interface of a criterion bean.

This component defines an interface for searching. The idea is to abstract the process of searching into a Bean to be manipulated by CForms.

Version:
CVS $Id: SimpleLuceneCriterion.java 433543 2006-08-22 06:22:54Z crossley $

Field Summary
static String ALL_MATCH
          The ALL_MATCH name of this bean.
static String ANY_FIELD
          The ANY_FIELD name of this bean.
static String ANY_MATCH
          The ANY_MATCH name of this bean.
static String LIKE_MATCH
          The LIKE_MATCH name of this bean.
static String NOT_MATCH
          The NOT_MATCH name of this bean.
static String PHRASE_MATCH
          The PHRASE_MATCH name of this bean.
 
Method Summary
 org.apache.lucene.search.Query getQuery(org.apache.lucene.analysis.Analyzer analyzer)
          Gets the org.apache.lucene.search.Query from the Criterion
 boolean isProhibited()
          Gets the prohibited status from the Criterion
 

Field Detail

ANY_FIELD

static final String ANY_FIELD
The ANY_FIELD name of this bean.

The value representing a query on any field in the index. ie. any

See Also:
Constant Field Values

ANY_MATCH

static final String ANY_MATCH
The ANY_MATCH name of this bean.

The value representing a match on any of the terms in this criterion. ie. any

See Also:
Constant Field Values

ALL_MATCH

static final String ALL_MATCH
The ALL_MATCH name of this bean.

The value representing a match on all of the terms in this criterion. ie. all

See Also:
Constant Field Values

LIKE_MATCH

static final String LIKE_MATCH
The LIKE_MATCH name of this bean.

The value representing a fuzzy match on any of the terms in this criterion. ie. like

See Also:
Constant Field Values

NOT_MATCH

static final String NOT_MATCH
The NOT_MATCH name of this bean.

The value representing a prohibition on any of the terms in this criterion. ie. like

See Also:
Constant Field Values

PHRASE_MATCH

static final String PHRASE_MATCH
The PHRASE_MATCH name of this bean.

The value representing a phrase match using all of the terms in this criterion. ie. like

See Also:
Constant Field Values
Method Detail

getQuery

org.apache.lucene.search.Query getQuery(org.apache.lucene.analysis.Analyzer analyzer)
Gets the org.apache.lucene.search.Query from the Criterion

The analyzer specifies which org.apache.lucene.analysis.Analyzer to use for this search

Parameters:
analyzer - The org.apache.lucene.analysis.Analyzer to use to extract the Terms from this Criterion

isProhibited

boolean isProhibited()
Gets the prohibited status from the Criterion



Copyright ? 1999-2007 The Apache Software Foundation. All Rights Reserved.