CmsSolrQuery

java.lang.Object
- org.apache.solr.common.params.SolrParams
- - org.apache.solr.common.params.ModifiableSolrParams
  - - org.apache.solr.client.solrj.SolrQuery
    - - org.opencms.search.solr.CmsSolrQuery

所有已实现的接口:

java.io.Serializable
```
public class CmsSolrQuery
extends org.apache.solr.client.solrj.SolrQuery
```
A Solr search query.

另请参阅:
序列化表格

嵌套类概要
- 从类继承的嵌套类/接口 org.apache.solr.client.solrj.SolrQuery
  org.apache.solr.client.solrj.SolrQuery.ORDER, org.apache.solr.client.solrj.SolrQuery.SortClause

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`ALL_RETURN_FIELDS` A constant to add the score field to the result documents.
`static java.lang.String`	`DEFAULT_FACET_DATE_GAP` The default facet date gap.
`static java.lang.String`	`DEFAULT_QUERY` The default query.
`static java.lang.String`	`DEFAULT_QUERY_TYPE` The query type.
`static java.lang.Integer`	`DEFAULT_ROWS` The default search result count.
`static java.lang.String`	`MINIMUM_FIELDS` A constant to add the score field to the result documents.
`static java.lang.String`	`STRUCTURE_FIELDS` A constant to add the score field to the result documents.

构造器概要

构造器
构造器和说明
`CmsSolrQuery()` Default constructor.
`CmsSolrQuery(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> queryParams)` Public constructor.

方法概要

方法
限定符和类型	方法和说明
`void`	`addFilterQuery(java.lang.String fieldName, java.util.List<java.lang.String> vals, boolean all, boolean useQuotes)` Creates and adds a filter query.
`void`	`addSortFieldOrders(java.util.Map<java.lang.String,org.apache.solr.client.solrj.SolrQuery.ORDER> sortFields)` Adds the given fields/orders to the existing sort fields.
`CmsSolrQuery`	`clone()`
`void`	`ensureParameters()` Ensures that the initial request parameters will overwrite the member values.
`static java.lang.String`	`getResourceType(java.lang.String[] fqs)` Returns the resource type if only one is set as filter query.
`void`	`removeExpiration()` Removes the expiration flag.
`void`	`setCategories(java.util.List<java.lang.String> categories)` Sets the categories only if not set in the query parameters.
`void`	`setCategories(java.lang.String... categories)` Sets the categories only if not set in the query parameters.
`void`	`setDateRanges(java.util.Map<java.lang.String,CmsPair<java.util.Date,java.util.Date>> dateRanges)` Sets date ranges.
`void`	`setFacetDateGap(java.lang.String facetDateGap)` Sets the facetDateGap.
`void`	`setLocales(java.util.List<java.util.Locale> locales)` Sets the locales only if not set in the query parameters.
`void`	`setLocales(java.util.Locale... locales)` Sets the locales only if not set in the query parameters.
`void`	`setResourceTypes(java.util.List<java.lang.String> resourceTypes)` Sets the resource types only if not set in the query parameters.
`void`	`setResourceTypes(java.lang.String... resourceTypes)` Sets the resource types only if not set in the query parameters.
`void`	`setSearchRoots(java.util.List<java.lang.String> searchRoots)` Sets the search roots only if not set as query parameter.
`void`	`setSearchRoots(java.lang.String... searchRoots)` Sets the search roots only if not set as query parameter.
`void`	`setStructureQuery(boolean structureQuery)` Sets the return fields 'fl' to a predefined set that does not contain content specific fields.
`void`	`setText(java.lang.String text)` Sets the text.
`void`	`setTextSearchFields(java.util.List<java.lang.String> textSearchFields)` Sets the textSearchFields.
`void`	`setTextSearchFields(java.lang.String... textSearchFields)` Sets the textSearchFields.
`java.lang.String`	`toString()`

从类继承的方法 org.apache.solr.client.solrj.SolrQuery
addDateRangeFacet, addFacetField, addFacetPivotField, addFacetQuery, addField, addFilterQuery, addHighlightField, addNumericRangeFacet, addOrUpdateSort, addOrUpdateSort, addSort, addSort, addSortField, addStatsFieldFacets, addTermsField, clearSorts, getCopy, getFacetFields, getFacetLimit, getFacetMinCount, getFacetQuery, getFacetSort, getFacetSortString, getFields, getFilterQueries, getHighlight, getHighlightFields, getHighlightFragsize, getHighlightRequireFieldMatch, getHighlightSimplePost, getHighlightSimplePre, getHighlightSnippets, getQuery, getQueryType, getRequestHandler, getRows, getSortField, getSortFields, getSorts, getStart, getTerms, getTermsFields, getTermsLimit, getTermsLower, getTermsLowerInclusive, getTermsMaxCount, getTermsMinCount, getTermsPrefix, getTermsRaw, getTermsRegex, getTermsRegexFlags, getTermsSortString, getTermsUpper, getTermsUpperInclusive, getTimeAllowed, removeFacetField, removeFacetQuery, removeFilterQuery, removeHighlightField, removeSort, removeSort, removeSortField, setFacet, setFacetLimit, setFacetMinCount, setFacetMissing, setFacetPrefix, setFacetPrefix, setFacetSort, setFacetSort, setFields, setFilterQueries, setGetFieldStatistics, setGetFieldStatistics, setHighlight, setHighlightFragsize, setHighlightRequireFieldMatch, setHighlightSimplePost, setHighlightSimplePre, setHighlightSnippets, setIncludeScore, setMissing, setParam, setParam, setQuery, setQueryType, setRequestHandler, setRows, setShowDebugInfo, setSort, setSort, setSortField, setSorts, setStart, setTerms, setTermsLimit, setTermsLower, setTermsLowerInclusive, setTermsMaxCount, setTermsMinCount, setTermsPrefix, setTermsRaw, setTermsRegex, setTermsRegexFlag, setTermsSortString, setTermsUpper, setTermsUpperInclusive, setTimeAllowed

从类继承的方法 org.apache.solr.common.params.ModifiableSolrParams
add, add, clear, get, getParameterNames, getParameterNamesIterator, getParams, remove, remove, set, set, set

从类继承的方法 org.apache.solr.common.params.SolrParams
fpname, get, getBool, getBool, getDouble, getDouble, getFieldBool, getFieldBool, getFieldDouble, getFieldDouble, getFieldFloat, getFieldFloat, getFieldInt, getFieldInt, getFieldParam, getFieldParam, getFieldParams, getFloat, getFloat, getInt, getInt, required, toMap, toMultiMap, toNamedList, toSolrParams, wrapAppended, wrapDefaults

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - ALL_RETURN_FIELDS
```
public static final java.lang.String ALL_RETURN_FIELDS
```
    A constant to add the score field to the result documents.
    
    另请参阅:
    常量字段值
  - DEFAULT_FACET_DATE_GAP
```
public static final java.lang.String DEFAULT_FACET_DATE_GAP
```
    The default facet date gap.
    
    另请参阅:
    常量字段值
  - DEFAULT_QUERY
```
public static final java.lang.String DEFAULT_QUERY
```
    The default query.
    
    另请参阅:
    常量字段值
  - DEFAULT_QUERY_TYPE
```
public static final java.lang.String DEFAULT_QUERY_TYPE
```
    The query type.
    
    另请参阅:
    常量字段值
  - DEFAULT_ROWS
```
public static final java.lang.Integer DEFAULT_ROWS
```
    The default search result count.
  - MINIMUM_FIELDS
```
public static final java.lang.String MINIMUM_FIELDS
```
    A constant to add the score field to the result documents.
    
    另请参阅:
    常量字段值
  - STRUCTURE_FIELDS
```
public static final java.lang.String STRUCTURE_FIELDS
```
    A constant to add the score field to the result documents.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsSolrQuery
```
public CmsSolrQuery()
```
    Default constructor.
  - CmsSolrQuery
```
public CmsSolrQuery(CmsObject cms,
            java.util.Map<java.lang.String,java.lang.String[]> queryParams)
```
    Public constructor.
    
    参数:
    cms - the current OpenCms context
    queryParams - the Solr query parameters
- 方法详细资料
  - getResourceType
```
public static java.lang.String getResourceType(java.lang.String[] fqs)
```
    Returns the resource type if only one is set as filter query.
    
    参数:
    fqs - the field queries to check
    
    返回:
    the type or null
  - addFilterQuery
```
public void addFilterQuery(java.lang.String fieldName,
                  java.util.List<java.lang.String> vals,
                  boolean all,
                  boolean useQuotes)
```
    Creates and adds a filter query.
    
    参数:
    fieldName - the field name to create a filter query on
    vals - the values that should match for the given field
    all - true to combine the given values with 'AND', false for 'OR'
    useQuotes - true to surround the given values with double quotes, false otherwise
  - addSortFieldOrders
```
public void addSortFieldOrders(java.util.Map<java.lang.String,org.apache.solr.client.solrj.SolrQuery.ORDER> sortFields)
```
    Adds the given fields/orders to the existing sort fields.
    
    参数:
    sortFields - the sortFields to set
  - clone
```
public CmsSolrQuery clone()
```
    覆盖:
    
    clone 在类中 java.lang.Object
    
    另请参阅:
    Object.clone()
  - ensureParameters
```
public void ensureParameters()
```
    Ensures that the initial request parameters will overwrite the member values.
    You can initialize the query with an HTTP request parameter then make some method calls and finally re-ensure that the initial request parameters will overwrite the changes made in the meanwhile.
  - removeExpiration
```
public void removeExpiration()
```
    Removes the expiration flag.
  - setCategories
```
public void setCategories(java.util.List<java.lang.String> categories)
```
    Sets the categories only if not set in the query parameters.
    
    参数:
    categories - the categories to set
  - setCategories
```
public void setCategories(java.lang.String... categories)
```
    Sets the categories only if not set in the query parameters.
    
    参数:
    categories - the categories to set
  - setDateRanges
```
public void setDateRanges(java.util.Map<java.lang.String,CmsPair<java.util.Date,java.util.Date>> dateRanges)
```
    Sets date ranges.
    This call will overwrite all existing date ranges for the given keys (name of the date facet field).
    The parameter Map uses as:
    - keys: Solr field name CmsSearchField and
    - values: pairs with min date as first and max date as second CmsPair
    Alternatively you can use Solr standard query syntax like:
    - +created:[* TO NOW]
    - +lastmodified:[' + date + ' TO NOW]
    whereby date is Solr formated: CmsSolrDocument.DF
    参数:
    dateRanges - the ranges map with field name as key and a CmsPair with min date as first and max date as second
  - setFacetDateGap
```
public void setFacetDateGap(java.lang.String facetDateGap)
```
    Sets the facetDateGap.
    
    参数:
    facetDateGap - the facetDateGap to set
  - setLocales
```
public void setLocales(java.util.List<java.util.Locale> locales)
```
    Sets the locales only if not set in the query parameters.
    
    参数:
    locales - the locales to set
  - setLocales
```
public void setLocales(java.util.Locale... locales)
```
    Sets the locales only if not set in the query parameters.
    
    参数:
    locales - the locales to set
  - setResourceTypes
```
public void setResourceTypes(java.util.List<java.lang.String> resourceTypes)
```
    Sets the resource types only if not set in the query parameters.
    
    参数:
    resourceTypes - the resourceTypes to set
  - setResourceTypes
```
public void setResourceTypes(java.lang.String... resourceTypes)
```
    Sets the resource types only if not set in the query parameters.
    
    参数:
    resourceTypes - the resourceTypes to set
  - setSearchRoots
```
public void setSearchRoots(java.util.List<java.lang.String> searchRoots)
```
    Sets the search roots only if not set as query parameter.
    
    参数:
    searchRoots - the searchRoots to set
  - setSearchRoots
```
public void setSearchRoots(java.lang.String... searchRoots)
```
    Sets the search roots only if not set as query parameter.
    
    参数:
    searchRoots - the searchRoots to set
  - setStructureQuery
```
public void setStructureQuery(boolean structureQuery)
```
    Sets the return fields 'fl' to a predefined set that does not contain content specific fields.
    
    参数:
    structureQuery - the true to return only structural fields
  - setText
```
public void setText(java.lang.String text)
```
    Sets the text.
    
    参数:
    text - the text to set
  - setTextSearchFields
```
public void setTextSearchFields(java.util.List<java.lang.String> textSearchFields)
```
    Sets the textSearchFields.
    
    参数:
    textSearchFields - the textSearchFields to set
  - setTextSearchFields
```
public void setTextSearchFields(java.lang.String... textSearchFields)
```
    Sets the textSearchFields.
    
    参数:
    textSearchFields - the textSearchFields to set
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 org.apache.solr.common.params.ModifiableSolrParams
    
    另请参阅:
    ModifiableSolrParams.toString()

类 CmsSolrQuery

嵌套类概要

从类继承的嵌套类/接口 org.apache.solr.client.solrj.SolrQuery

字段概要

构造器概要

方法概要

从类继承的方法 org.apache.solr.client.solrj.SolrQuery

从类继承的方法 org.apache.solr.common.params.ModifiableSolrParams

从类继承的方法 org.apache.solr.common.params.SolrParams

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

字段详细资料

ALL_RETURN_FIELDS

DEFAULT_FACET_DATE_GAP

DEFAULT_QUERY

DEFAULT_QUERY_TYPE

DEFAULT_ROWS

MINIMUM_FIELDS

STRUCTURE_FIELDS

构造器详细资料

CmsSolrQuery

CmsSolrQuery

方法详细资料

getResourceType

addFilterQuery

addSortFieldOrders

clone

ensureParameters

removeExpiration

setCategories

setCategories

setDateRanges

setFacetDateGap

setLocales

setLocales

setResourceTypes

setResourceTypes

setSearchRoots

setSearchRoots

setStructureQuery

setText

setTextSearchFields

setTextSearchFields

toString