org.opencms.search

类 CmsSearchParameters.CmsSearchFieldQuery

java.lang.Object

org.opencms.search.CmsSearchParameters.CmsSearchFieldQuery

封闭类:

CmsSearchParameters

public static class CmsSearchParameters.CmsSearchFieldQuery
extends java.lang.Object

Describes a specific search field query.

构造器概要

构造器

构造器和说明
CmsSearchParameters.CmsSearchFieldQuery(java.lang.String fieldName, org.apache.lucene.search.BooleanClause.Occur fieldOccur, java.util.List<java.lang.String> termList, org.apache.lucene.search.BooleanClause.Occur termOccur) Creates a new search field query with a variable length search term list.
CmsSearchParameters.CmsSearchFieldQuery(java.lang.String fieldName, java.lang.String searchTerm, org.apache.lucene.search.BooleanClause.Occur fieldOccur) Creates a new search field query with just a single search term.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getFieldName() Returns the field name.
org.apache.lucene.search.BooleanClause.Occur	getOccur() Returns the occur parameter for this field query.
java.lang.String	getSearchQuery() 已过时。 use getSearchTerms() instead
java.util.List<java.lang.String>	getSearchTerms() Returns the search term list.
org.apache.lucene.search.BooleanClause.Occur	getTermOccur() Returns the occur parameter used for the search term combination of this field query.
void	setFieldName(java.lang.String fieldName) Sets the name of the field to use this query for.
void	setOccur(org.apache.lucene.search.BooleanClause.Occur occur) Sets the occur parameter for this field query.
void	setSearchQuery(java.lang.String searchQuery) 已过时。 use setSearchTerms(List) instead
void	setSearchTerms(java.util.List<java.lang.String> searchTerms) Sets the search terms.

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsSearchParameters.CmsSearchFieldQuery

public CmsSearchParameters.CmsSearchFieldQuery(java.lang.String fieldName,
                                       org.apache.lucene.search.BooleanClause.Occur fieldOccur,
                                       java.util.List<java.lang.String> termList,
                                       org.apache.lucene.search.BooleanClause.Occur termOccur)

Creates a new search field query with a variable length search term list.

参数:

fieldName - the field name

fieldOccur - the occur parameter for this field

termList - the search term list

termOccur - the occur parameter used for the search term combination

CmsSearchParameters.CmsSearchFieldQuery

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

Creates a new search field query with just a single search term.

Please note: Since there is only one term, the ocucr parameter for the term combination is not required and set to null.

参数:

fieldName - the field name

searchTerm - the search term

fieldOccur - the occur parameter for this field

方法详细资料

getFieldName

public java.lang.String getFieldName()

Returns the field name.

返回:

the field name

getOccur

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

Returns the occur parameter for this field query.

返回:

the occur parameter for this field query

getSearchQuery

@Deprecated
public java.lang.String getSearchQuery()

已过时。 use getSearchTerms() instead

Returns the first entry from the term list.

返回:

the search query

getSearchTerms

public java.util.List<java.lang.String> getSearchTerms()

Returns the search term list.

返回:

the search term list

getTermOccur

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

Returns the occur parameter used for the search term combination of this field query.

返回:

the occur parameter used for the search term combination of this field query

setFieldName

public void setFieldName(java.lang.String fieldName)

Sets the name of the field to use this query for.

参数:

fieldName - the name of the field to use this query for

setOccur

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

Sets the occur parameter for this field query.

参数:

occur - the occur parameter to set

setSearchQuery

@Deprecated
public void setSearchQuery(java.lang.String searchQuery)

已过时。 use setSearchTerms(List) instead

Sets the search keywords to just a single entry.

参数:

searchQuery - the single search keyword to set

setSearchTerms

public void setSearchTerms(java.util.List<java.lang.String> searchTerms)

Sets the search terms.

参数:

searchTerms - the search terms to set