org.opencms.search
Class CmsSearchParameters.CmsSearchFieldQuery

java.lang.Object
  org.opencms.search.CmsSearchParameters.CmsSearchFieldQuery

Enclosing class:

CmsSearchParameters

public class CmsSearchParameters.CmsSearchFieldQuery
extends java.lang.Object

Describes a specific search field query.

Constructor Summary

CmsSearchParameters.CmsSearchFieldQuery(java.lang.String fieldName, java.lang.String searchQuery, org.apache.lucene.search.BooleanClause.Occur occur)

Method Summary

java.lang.String	getFieldName() Returns the field name.
org.apache.lucene.search.BooleanClause.Occur	getOccur() Returns the occur parameter required for this field / query.
java.lang.String	getSearchQuery() Returns the search query.
void	setFieldName(java.lang.String fieldName) Sets the field name.
void	setOccur(org.apache.lucene.search.BooleanClause.Occur occur) Sets the occur parameter for this field / query.
void	setSearchQuery(java.lang.String searchQuery) Sets the search query.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsSearchParameters.CmsSearchFieldQuery

public CmsSearchParameters.CmsSearchFieldQuery(java.lang.String fieldName,
                                               java.lang.String searchQuery,
                                               org.apache.lucene.search.BooleanClause.Occur occur)

Parameters:

fieldName - the field name

searchQuery - the search query

occur - the occur parameter required for this field / query

Method Detail

getFieldName

public java.lang.String getFieldName()

Returns the field name.

Returns:

the field name

getOccur

public org.apache.lucene.search.BooleanClause.Occur getOccur()

Returns the occur parameter required for this field / query.

Returns:

the occur parameter required for this field / query

getSearchQuery

public java.lang.String getSearchQuery()

Returns the search query.

Returns:

the search query

setFieldName

public void setFieldName(java.lang.String fieldName)

Sets the field name.

Parameters:

fieldName - the field name to set

setOccur

public void setOccur(org.apache.lucene.search.BooleanClause.Occur occur)

Sets the occur parameter for this field / query.

Parameters:

occur - the occur parameter to set

setSearchQuery

public void setSearchQuery(java.lang.String searchQuery)

Sets the search query.

Parameters:

searchQuery - the search query to set