Package org.opencms.search
Class CmsSearchParameters.CmsSearchFieldQuery
- java.lang.Object
-
- org.opencms.search.CmsSearchParameters.CmsSearchFieldQuery
-
- Enclosing class:
- CmsSearchParameters
public static class CmsSearchParameters.CmsSearchFieldQuery extends java.lang.Object
Describes a specific search field query.
-
-
Constructor Summary
Constructors Constructor Description 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.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.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description 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()
Deprecated.usegetSearchTerms()
insteadjava.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)
Deprecated.usesetSearchTerms(List)
insteadvoid
setSearchTerms(java.util.List<java.lang.String> searchTerms)
Sets the search terms.
-
-
-
Constructor Detail
-
CmsSearchFieldQuery
public 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.- Parameters:
fieldName
- the field namefieldOccur
- the occur parameter for this fieldtermList
- the search term listtermOccur
- the occur parameter used for the search term combination
-
CmsSearchFieldQuery
public 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
.- Parameters:
fieldName
- the field namesearchTerm
- the search termfieldOccur
- the occur parameter for this field
-
-
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 for this field query.- Returns:
- the occur parameter for this field query
-
getSearchQuery
@Deprecated public java.lang.String getSearchQuery()
Deprecated.usegetSearchTerms()
insteadReturns the first entry from the term list.- Returns:
- the search query
-
getSearchTerms
public java.util.List<java.lang.String> getSearchTerms()
Returns the search term list.- Returns:
- 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.- Returns:
- 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.- Parameters:
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.- Parameters:
occur
- the occur parameter to set
-
setSearchQuery
@Deprecated public void setSearchQuery(java.lang.String searchQuery)
Deprecated.usesetSearchTerms(List)
insteadSets the search keywords to just a single entry.- Parameters:
searchQuery
- the single search keyword to set
-
setSearchTerms
public void setSearchTerms(java.util.List<java.lang.String> searchTerms)
Sets the search terms.- Parameters:
searchTerms
- the search terms to set
-
-