public class DiscoverQuery extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
DiscoverQuery.SORT_ORDER
Attributes used for sorting of results
|
| Constructor and Description |
|---|
DiscoverQuery() |
| Modifier and Type | Method and Description |
|---|---|
void |
addFacetField(DiscoverFacetField facetField)
Adds a new facet field
|
void |
addFacetQuery(String facetQuery)
Adds a new facet query
|
void |
addFieldPresentQueries(String... fieldPresentQueries)
Adds a query that will ensure that a certain field is present in the index
|
void |
addFilterQueries(String... filterQueries)
Adds new filter queries
|
void |
addHitHighlightingField(DiscoverHitHighlightingField hitHighlighting) |
void |
addProperty(String property,
String value)
Adds a new search property to the misc search properties
|
void |
addSearchField(String field) |
int |
getDSpaceObjectFilter()
Gets the DSpace object filter
can be used to only return objects from a certain DSpace Object type
|
List<DiscoverFacetField> |
getFacetFields()
Gets the facets fields configured
|
int |
getFacetMinCount()
Gets the minimum number of values that need to be present before a valid facet value has been found
|
int |
getFacetOffset()
Gets the facet field offset
|
List<String> |
getFacetQueries()
Returns the facet queries
|
List<String> |
getFieldPresentQueries() |
List<String> |
getFilterQueries()
Returns the filter queries
|
DiscoverHitHighlightingField |
getHitHighlightingField(String field) |
List<DiscoverHitHighlightingField> |
getHitHighlightingFields() |
int |
getMaxResults()
The maximum number of results returned by this query
|
Map<String,List<String>> |
getProperties()
Returns the misc search properties
|
String |
getQuery() |
List<String> |
getSearchFields() |
String |
getSortField() |
DiscoverQuery.SORT_ORDER |
getSortOrder() |
int |
getStart() |
boolean |
isSpellCheck() |
void |
setDSpaceObjectFilter(int DSpaceObjectFilter)
Sets the DSpace object filter, must be an DSpace Object type integer
can be used to only return objects from a certain DSpace Object type
|
void |
setFacetMinCount(int facetMinCount)
Set the minimum number of values that need to be present before a valid facet value has been found
|
void |
setFacetOffset(int facetOffset)
Sets the facet field offset, one facet offset will be used for all the facet fields
|
void |
setMaxResults(int maxResults)
Sets the maximum number of results by this query
|
void |
setQuery(String query) |
void |
setSortField(String sortField,
DiscoverQuery.SORT_ORDER sortOrder) |
void |
setSpellCheck(boolean spellCheck) |
void |
setStart(int start) |
public void setQuery(String query)
public String getQuery()
public int getStart()
public void setStart(int start)
public void setSortField(String sortField, DiscoverQuery.SORT_ORDER sortOrder)
public String getSortField()
public DiscoverQuery.SORT_ORDER getSortOrder()
public void setDSpaceObjectFilter(int DSpaceObjectFilter)
DSpaceObjectFilter - the DSpace object filerpublic int getDSpaceObjectFilter()
public int getMaxResults()
public void setMaxResults(int maxResults)
maxResults - the number of resultspublic void addFilterQueries(String... filterQueries)
filterQueries - the filter queries to be addedpublic List<String> getFilterQueries()
public void addFieldPresentQueries(String... fieldPresentQueries)
fieldPresentQueries - the queries to be addedpublic void addFacetQuery(String facetQuery)
facetQuery - the new facet query to be addedpublic List<String> getFacetQueries()
public void addFacetField(DiscoverFacetField facetField)
facetField - the new facet field to be addedpublic List<DiscoverFacetField> getFacetFields()
public int getFacetMinCount()
public void setFacetMinCount(int facetMinCount)
facetMinCount - the minimum number of values to be present for a valid facetpublic int getFacetOffset()
public void setFacetOffset(int facetOffset)
facetOffset - an integer representing the offsetpublic void addSearchField(String field)
public Map<String,List<String>> getProperties()
public void addProperty(String property, String value)
property - the name of the propertyvalue - the value of the propertypublic DiscoverHitHighlightingField getHitHighlightingField(String field)
public List<DiscoverHitHighlightingField> getHitHighlightingFields()
public void addHitHighlightingField(DiscoverHitHighlightingField hitHighlighting)
public boolean isSpellCheck()
public void setSpellCheck(boolean spellCheck)
Copyright © 2014 DuraSpace. All Rights Reserved.