public class SolrQuery extends ModifiableSolrParams
Modifier and Type | Class and Description |
---|---|
static class |
SolrQuery.ORDER |
Modifier and Type | Field and Description |
---|---|
private static java.util.regex.Pattern |
scorePattern |
Constructor and Description |
---|
SolrQuery() |
SolrQuery(java.lang.String q)
Create a new SolrQuery
|
Modifier and Type | Method and Description |
---|---|
SolrQuery |
addDateRangeFacet(java.lang.String field,
java.util.Date start,
java.util.Date end,
java.lang.String gap)
Add a numeric range facet.
|
SolrQuery |
addFacetField(java.lang.String... fields)
Add field(s) for facet computation.
|
SolrQuery |
addFacetQuery(java.lang.String f)
add a faceting query
|
SolrQuery |
addField(java.lang.String field) |
SolrQuery |
addFilterQuery(java.lang.String... fq) |
SolrQuery |
addHighlightField(java.lang.String f)
add highlight field
|
SolrQuery |
addNumericRangeFacet(java.lang.String field,
java.lang.Number start,
java.lang.Number end,
java.lang.Number gap)
Add a numeric range facet.
|
SolrQuery |
addSortField(java.lang.String field,
SolrQuery.ORDER order) |
void |
addStatsFieldFacets(java.lang.String field,
java.lang.String... facets) |
SolrQuery |
addTermsField(java.lang.String field) |
private SolrQuery |
addValueToParam(java.lang.String name,
java.lang.String value) |
SolrQuery |
getCopy()
get a deep copy of this object
|
java.lang.String[] |
getFacetFields()
get the facet fields
|
int |
getFacetLimit()
get current facet limit
|
int |
getFacetMinCount()
get facet minimum count
|
java.lang.String[] |
getFacetQuery()
get facet queries
|
boolean |
getFacetSort()
Deprecated.
Use
getFacetSortString() instead. |
java.lang.String |
getFacetSortString()
get facet sort
|
java.lang.String |
getFields() |
java.lang.String[] |
getFilterQueries() |
boolean |
getHighlight() |
java.lang.String[] |
getHighlightFields()
get list of highlighted fields
|
int |
getHighlightFragsize() |
boolean |
getHighlightRequireFieldMatch() |
java.lang.String |
getHighlightSimplePost() |
java.lang.String |
getHighlightSimplePre() |
int |
getHighlightSnippets() |
java.lang.String |
getQuery() |
java.lang.String |
getQueryType() |
java.lang.Integer |
getRows() |
java.lang.String |
getSortField() |
java.lang.String[] |
getSortFields() |
java.lang.Integer |
getStart() |
boolean |
getTerms() |
java.lang.String[] |
getTermsFields() |
int |
getTermsLimit() |
java.lang.String |
getTermsLower() |
boolean |
getTermsLowerInclusive() |
int |
getTermsMaxCount() |
int |
getTermsMinCount() |
java.lang.String |
getTermsPrefix() |
boolean |
getTermsRaw() |
java.lang.String |
getTermsRegex() |
java.lang.String[] |
getTermsRegexFlags() |
java.lang.String |
getTermsSortString() |
java.lang.String |
getTermsUpper() |
boolean |
getTermsUpperInclusive() |
java.lang.Integer |
getTimeAllowed()
Get the maximum time allowed for this query.
|
private java.lang.String |
join(java.lang.String[] vals,
java.lang.String sep,
java.lang.String removeVal) |
private java.lang.String |
join(java.lang.String a,
java.lang.String b,
java.lang.String sep) |
boolean |
removeFacetField(java.lang.String name)
remove a facet field
|
boolean |
removeFacetQuery(java.lang.String q)
remove a facet query
|
boolean |
removeFilterQuery(java.lang.String fq) |
boolean |
removeHighlightField(java.lang.String f)
remove a field for highlighting
|
SolrQuery |
removeSortField(java.lang.String field,
SolrQuery.ORDER order) |
SolrQuery |
setFacet(boolean b)
enable/disable faceting.
|
SolrQuery |
setFacetLimit(int lim)
set the facet limit
|
SolrQuery |
setFacetMinCount(int cnt)
set facet minimum count
|
SolrQuery |
setFacetMissing(java.lang.Boolean v)
Sets facet missing boolean flag
|
SolrQuery |
setFacetPrefix(java.lang.String prefix) |
SolrQuery |
setFacetPrefix(java.lang.String field,
java.lang.String prefix) |
SolrQuery |
setFacetSort(boolean sort)
Deprecated.
Use
setFacetSort(String) instead, true corresponds to
FacetParams.FACET_SORT_COUNT and false to FacetParams.FACET_SORT_INDEX . |
SolrQuery |
setFacetSort(java.lang.String sort)
set facet sort
|
SolrQuery |
setFields(java.lang.String... fields) |
SolrQuery |
setFilterQueries(java.lang.String... fq) |
void |
setGetFieldStatistics(boolean v) |
void |
setGetFieldStatistics(java.lang.String field) |
SolrQuery |
setHighlight(boolean b) |
SolrQuery |
setHighlightFragsize(int num) |
SolrQuery |
setHighlightRequireFieldMatch(boolean flag) |
SolrQuery |
setHighlightSimplePost(java.lang.String f) |
SolrQuery |
setHighlightSimplePre(java.lang.String f) |
SolrQuery |
setHighlightSnippets(int num) |
SolrQuery |
setIncludeScore(boolean includeScore) |
SolrQuery |
setMissing(java.lang.String fld)
Deprecated.
|
SolrQuery |
setParam(java.lang.String name,
boolean value) |
SolrQuery |
setParam(java.lang.String name,
java.lang.String... values) |
SolrQuery |
setQuery(java.lang.String query) |
SolrQuery |
setQueryType(java.lang.String qt)
Query type used to determine the request handler.
|
SolrQuery |
setRows(java.lang.Integer rows) |
void |
setShowDebugInfo(boolean showDebugInfo) |
SolrQuery |
setSortField(java.lang.String field,
SolrQuery.ORDER order) |
SolrQuery |
setStart(java.lang.Integer start) |
SolrQuery |
setTerms(boolean b)
enable/disable terms.
|
SolrQuery |
setTermsLimit(int limit) |
SolrQuery |
setTermsLower(java.lang.String lower) |
SolrQuery |
setTermsLowerInclusive(boolean b) |
SolrQuery |
setTermsMaxCount(int cnt) |
SolrQuery |
setTermsMinCount(int cnt) |
SolrQuery |
setTermsPrefix(java.lang.String prefix) |
SolrQuery |
setTermsRaw(boolean b) |
SolrQuery |
setTermsRegex(java.lang.String regex) |
SolrQuery |
setTermsRegexFlag(java.lang.String flag) |
SolrQuery |
setTermsSortString(java.lang.String type) |
SolrQuery |
setTermsUpper(java.lang.String upper) |
SolrQuery |
setTermsUpperInclusive(boolean b) |
SolrQuery |
setTimeAllowed(java.lang.Integer milliseconds)
Set the maximum time allowed for this query.
|
private java.lang.String |
toSortString(java.lang.String field,
SolrQuery.ORDER order) |
add, add, clear, get, getParameterNames, getParameterNamesIterator, getParams, remove, remove, set, set, set, toString
fpname, get, getBool, getBool, getDouble, getDouble, getFieldBool, getFieldBool, getFieldDouble, getFieldDouble, getFieldFloat, getFieldFloat, getFieldInt, getFieldInt, getFieldParam, getFieldParam, getFieldParams, getFloat, getFloat, getInt, getInt, parseBool, required, toMap, toMultiMap, toNamedList, toSolrParams, wrapAppended, wrapDefaults
public SolrQuery()
public SolrQuery(java.lang.String q)
q
- query stringpublic SolrQuery setTerms(boolean b)
b
- flag to indicate terms should be enabled. public boolean getTerms()
public SolrQuery addTermsField(java.lang.String field)
public java.lang.String[] getTermsFields()
public SolrQuery setTermsLower(java.lang.String lower)
public java.lang.String getTermsLower()
public SolrQuery setTermsUpper(java.lang.String upper)
public java.lang.String getTermsUpper()
public SolrQuery setTermsUpperInclusive(boolean b)
public boolean getTermsUpperInclusive()
public SolrQuery setTermsLowerInclusive(boolean b)
public boolean getTermsLowerInclusive()
public SolrQuery setTermsLimit(int limit)
public int getTermsLimit()
public SolrQuery setTermsMinCount(int cnt)
public int getTermsMinCount()
public SolrQuery setTermsMaxCount(int cnt)
public int getTermsMaxCount()
public SolrQuery setTermsPrefix(java.lang.String prefix)
public java.lang.String getTermsPrefix()
public SolrQuery setTermsRaw(boolean b)
public boolean getTermsRaw()
public SolrQuery setTermsSortString(java.lang.String type)
public java.lang.String getTermsSortString()
public SolrQuery setTermsRegex(java.lang.String regex)
public java.lang.String getTermsRegex()
public SolrQuery setTermsRegexFlag(java.lang.String flag)
public java.lang.String[] getTermsRegexFlags()
public SolrQuery addFacetField(java.lang.String... fields)
fields
- Array of field names from the IndexSchemapublic SolrQuery addNumericRangeFacet(java.lang.String field, java.lang.Number start, java.lang.Number end, java.lang.Number gap)
field
- The fieldstart
- The start of rangeend
- The end of the rangegap
- The gap between each countpublic SolrQuery addDateRangeFacet(java.lang.String field, java.util.Date start, java.util.Date end, java.lang.String gap)
field
- The fieldstart
- The start of rangeend
- The end of the rangegap
- The gap between each countpublic java.lang.String[] getFacetFields()
public boolean removeFacetField(java.lang.String name)
name
- Name of the facet field to be removed.public SolrQuery setFacet(boolean b)
b
- flag to indicate faceting should be enabled. public SolrQuery setFacetPrefix(java.lang.String prefix)
public SolrQuery setFacetPrefix(java.lang.String field, java.lang.String prefix)
public SolrQuery addFacetQuery(java.lang.String f)
f
- facet querypublic java.lang.String[] getFacetQuery()
public boolean removeFacetQuery(java.lang.String q)
q
- the facet query to removepublic SolrQuery setFacetLimit(int lim)
lim
- number facet items to returnpublic int getFacetLimit()
public SolrQuery setFacetMinCount(int cnt)
cnt
- facets having less that cnt hits will be excluded from teh facet listpublic int getFacetMinCount()
public SolrQuery setFacetMissing(java.lang.Boolean v)
v
- flag to indicate the field of FacetParams.FACET_MISSING
.@Deprecated public SolrQuery setMissing(java.lang.String fld)
setFacetMissing(Boolean)
public java.lang.String getFacetSortString()
FacetParams.FACET_SORT_COUNT
@Deprecated public boolean getFacetSort()
getFacetSortString()
instead.FacetParams.FACET_SORT_COUNT
and FacetParams.FACET_SORT_INDEX
public SolrQuery setFacetSort(java.lang.String sort)
sort
- sort facets@Deprecated public SolrQuery setFacetSort(boolean sort)
setFacetSort(String)
instead, true corresponds to
FacetParams.FACET_SORT_COUNT
and false to FacetParams.FACET_SORT_INDEX
.sort
- sort facetspublic SolrQuery addHighlightField(java.lang.String f)
f
- field to enable for highlightingpublic boolean removeHighlightField(java.lang.String f)
f
- field name to not highlightpublic java.lang.String[] getHighlightFields()
public SolrQuery setHighlightSnippets(int num)
public int getHighlightSnippets()
public SolrQuery setHighlightFragsize(int num)
public int getHighlightFragsize()
public SolrQuery setHighlightRequireFieldMatch(boolean flag)
public boolean getHighlightRequireFieldMatch()
public SolrQuery setHighlightSimplePre(java.lang.String f)
public java.lang.String getHighlightSimplePre()
public SolrQuery setHighlightSimplePost(java.lang.String f)
public java.lang.String getHighlightSimplePost()
public SolrQuery setSortField(java.lang.String field, SolrQuery.ORDER order)
public SolrQuery addSortField(java.lang.String field, SolrQuery.ORDER order)
public SolrQuery removeSortField(java.lang.String field, SolrQuery.ORDER order)
public java.lang.String[] getSortFields()
public java.lang.String getSortField()
public void setGetFieldStatistics(boolean v)
public void setGetFieldStatistics(java.lang.String field)
public void addStatsFieldFacets(java.lang.String field, java.lang.String... facets)
public SolrQuery setFilterQueries(java.lang.String... fq)
public SolrQuery addFilterQuery(java.lang.String... fq)
public boolean removeFilterQuery(java.lang.String fq)
public java.lang.String[] getFilterQueries()
public boolean getHighlight()
public SolrQuery setHighlight(boolean b)
public SolrQuery setFields(java.lang.String... fields)
public SolrQuery addField(java.lang.String field)
public java.lang.String getFields()
public SolrQuery setIncludeScore(boolean includeScore)
public SolrQuery setQuery(java.lang.String query)
public java.lang.String getQuery()
public SolrQuery setRows(java.lang.Integer rows)
public java.lang.Integer getRows()
public void setShowDebugInfo(boolean showDebugInfo)
public SolrQuery setStart(java.lang.Integer start)
public java.lang.Integer getStart()
public SolrQuery setQueryType(java.lang.String qt)
qt
- Query Type that corresponds to the query request handler on the server.QueryRequest.getPath()
public java.lang.String getQueryType()
public SolrQuery setParam(java.lang.String name, java.lang.String... values)
name
- values
- ModifiableSolrParams.set(String,String[])
public SolrQuery setParam(java.lang.String name, boolean value)
name
- value
- ModifiableSolrParams.set(String, boolean)
public SolrQuery getCopy()
public SolrQuery setTimeAllowed(java.lang.Integer milliseconds)
milliseconds
- the time in milliseconds allowed for this querypublic java.lang.Integer getTimeAllowed()
private java.lang.String toSortString(java.lang.String field, SolrQuery.ORDER order)
private java.lang.String join(java.lang.String a, java.lang.String b, java.lang.String sep)
private SolrQuery addValueToParam(java.lang.String name, java.lang.String value)
private java.lang.String join(java.lang.String[] vals, java.lang.String sep, java.lang.String removeVal)