SearchParameters (Alfresco 5.0.3 Public API)

org.alfresco.service.cmr.search

Class SearchParameters

org.alfresco.service.cmr.search.SearchParameters

public class SearchParameters

This class provides parameters to define a search. TODO - paging of results page number and page size - paging isolation - REPEATABLE READ, READ COMMITTED, may SEE ONCE tracking node refs in previous result sets - how long repeatable read may be held - limit by the number of permission evaluations

Field Summary
static String	ALTERNATIVE_DICTIONARY A parameter that can be passed to Solr to indicate an alternative dictionary should be used.
static org.alfresco.service.cmr.search.SearchParameters.Operator	AND AND
static org.alfresco.service.cmr.search.SearchParameters.Operator	OR OR
static org.alfresco.service.cmr.search.SearchParameters.SortDefinition	SORT_IN_DOCUMENT_ORDER_ASCENDING Sort in the order docs were added to the index - oldest docs first
static org.alfresco.service.cmr.search.SearchParameters.SortDefinition	SORT_IN_DOCUMENT_ORDER_DESCENDING Sort in the reverse order docs were added to the index - new/updateed docs first
static org.alfresco.service.cmr.search.SearchParameters.SortDefinition	SORT_IN_SCORE_ORDER_ASCENDING Sort in ascending score
static org.alfresco.service.cmr.search.SearchParameters.SortDefinition	SORT_IN_SCORE_ORDER_DESCENDING Sort in descending score order

Constructor Summary
SearchParameters() Default constructor
SearchParameters(org.alfresco.repo.search.impl.querymodel.QueryOptions options) Construct from Query Options

Method Summary
void	addAllAttribute(String attribute) Add a field for ALL expansion
void	addExtraParameter(String name, String value)
void	addFacetQuery(String facetQuery)
void	addFieldFacet(org.alfresco.service.cmr.search.SearchParameters.FieldFacet fieldFacet)
void	addLocale(Locale locale) Add a locale to include for multi-lingual text searches.
void	addQueryParameterDefinition(QueryParameterDefinition queryParameterDefinition) Add parameter definitions for the query - used to parameterise the query string
String	addQueryTemplate(String name, String template) Add/replace a query template Not all languages support query templates
void	addSort(org.alfresco.service.cmr.search.SearchParameters.SortDefinition sortDefinition) Add a sort definition.
void	addSort(String field, boolean ascending) Add a sort to the query (for those query languages that do not support it directly) The first sort added is treated as primary, the second as secondary etc.
void	addStore(StoreRef store) Set the stores to be supported - currently there can be only one.
void	addTextAttribute(String attribute) Add a field for TEXT expansion
SearchParameters	copy()
boolean	equals(Object obj)
boolean	excludeDataInTheCurrentTransaction() Is data in the current transaction excluded from the search.
void	excludeDataInTheCurrentTransaction(boolean excludeDataInTheCurrentTransaction) If true, any data in the current transaction will be ignored in the search.
Set<String>	getAllAttributes() Get the text attributes used for ALL expansion.
String	getDefaultFieldName()
org.alfresco.service.cmr.search.SearchParameters.Operator	getDefaultFTSFieldOperator() As getDefaultFTSConnective() but for field groups
org.alfresco.service.cmr.search.SearchParameters.Operator	getDefaultFTSOperator() Get the default connective used when OR and AND are not specified for the FTS contains() function.
org.alfresco.service.cmr.search.SearchParameters.Operator	getDefaultOperator() Get the default operator for query elements when they are not explicit in the query.
boolean	getExcludeTenantFilter()
Map<String>	getExtraParameters()
List<String>	getFacetQueries()
List<org.alfresco.service.cmr.search.SearchParameters.FieldFacet>	getFieldFacets()
String	getLanguage() Get the search language
int	getLimit() If limiting the result set in some way, get the limiting value used.
LimitBy	getLimitBy() Get how the result set should be limited
List<Locale>	getLocales() Get the locales used for multi-lingual text searches.
int	getMaxItems() Get the max number of rows for the result set 0 or less is unlimited
int	getMaxPermissionChecks()
long	getMaxPermissionCheckTimeMillis()
Integer	getMaxRawResultSetSizeForInMemorySort()
org.alfresco.repo.search.MLAnalysisMode	getMlAnalaysisMode() The way in which multilingual fields are treated durig a search.
String	getNamespace() Get the default namespace.
PermissionEvaluationMode	getPermissionEvaluation() Get when permissions are evaluated.
String	getQuery() Get the query.
org.alfresco.service.cmr.search.QueryConsistency	getQueryConsistency()
ArrayList<QueryParameterDefinition>	getQueryParameterDefinitions() Get the query parameters that apply to this query.
Map<String>	getQueryTemplates() Get the query templates
String	getSearchTerm()
Long	getSinceTxId() If not null, then the search should only include results from transactions after sinceTxId.
int	getSkipCount() Get the skip count - the number of rows to skip at the start of the query.
ArrayList<org.alfresco.service.cmr.search.SearchParameters.SortDefinition>	getSortDefinitions() Get the sort definitions that apply to this query.
Locale	getSortLocale()
ArrayList<StoreRef>	getStores() Get the stores in which this query should find results.
Set<String>	getTextAttributes() Get the text attributes used for text expansion.
Boolean	getUseInMemorySort()
int	hashCode()
boolean	isBulkFetchEnabled()
boolean	isSpellCheck()
void	setBulkFetchEnabled(boolean isBulkFetchEnabled)
void	setDefaultFieldName(String defaultFieldName)
void	setDefaultFTSFieldConnective(org.alfresco.service.cmr.search.SearchParameters.Operator defaultFTSFieldOperator) As setDefaultFTSConnective() but for field groups
void	setDefaultFTSOperator(org.alfresco.service.cmr.search.SearchParameters.Operator defaultFTSOperator) Set the default connective used when OR and AND are not specified for the FTS contains() function.
void	setDefaultOperator(org.alfresco.service.cmr.search.SearchParameters.Operator defaultOperator) Set the default operator for query elements when they are not explicit in the query.
void	setExcludeTenantFilter(boolean excludeTenantFilter)
void	setLanguage(String language) Set the query language.
void	setLimit(int limit) If limiting the result set in some way, set the limiting value used.
void	setLimitBy(LimitBy limitBy) Set how the result set should be limited.
void	setMaxItems(int maxItems) Set the max number of rows for the result set.
void	setMaxPermissionChecks(int maxPermissionChecks)
void	setMaxPermissionCheckTimeMillis(long maxPermissionCheckTimeMillis)
void	setMaxRawResultSetSizeForInMemorySort(Integer maxRawResultSetSizeForInMemorySort)
void	setMlAnalaysisMode(org.alfresco.repo.search.MLAnalysisMode mlAnalaysisMode) Set the way in which multilingual fields are treated durig a search.
void	setNamespace(String namespace) Set the default namespace
void	setPermissionEvaluation(PermissionEvaluationMode permissionEvaluation) Set when permissions are evaluated.
void	setQuery(String query) Set the query string.
void	setQueryConsistency(org.alfresco.service.cmr.search.QueryConsistency queryConsistency)
void	setSearchTerm(String searchTerm)
void	setSinceTxId(Long sinceTxId) If not null, then the search should only include results from transactions after sinceTxId.
void	setSkipCount(int skipCount) Set the skip count - the number of rows to skip at the start of the query.
void	setSpellCheck(boolean spellCheck)
void	setUseInMemorySort(Boolean useInMemorySort)
String	toString()
boolean	usePostSort(int length, boolean useInMemorySortDefault, int maxRawResultSetSizeForInMemorySortDefault)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

ALTERNATIVE_DICTIONARY

public static final String ALTERNATIVE_DICTIONARY

A parameter that can be passed to Solr to indicate an alternative dictionary should be used.

public static final org.alfresco.service.cmr.search.SearchParameters.Operator AND

public static final org.alfresco.service.cmr.search.SearchParameters.Operator OR

SORT_IN_DOCUMENT_ORDER_ASCENDING

public static final org.alfresco.service.cmr.search.SearchParameters.SortDefinition SORT_IN_DOCUMENT_ORDER_ASCENDING

Sort in the order docs were added to the index - oldest docs first

SORT_IN_DOCUMENT_ORDER_DESCENDING

public static final org.alfresco.service.cmr.search.SearchParameters.SortDefinition SORT_IN_DOCUMENT_ORDER_DESCENDING

Sort in the reverse order docs were added to the index - new/updateed docs first

SORT_IN_SCORE_ORDER_ASCENDING

public static final org.alfresco.service.cmr.search.SearchParameters.SortDefinition SORT_IN_SCORE_ORDER_ASCENDING

Sort in ascending score

SORT_IN_SCORE_ORDER_DESCENDING

public static final org.alfresco.service.cmr.search.SearchParameters.SortDefinition SORT_IN_SCORE_ORDER_DESCENDING

Sort in descending score order

public SearchParameters()

public SearchParameters(org.alfresco.repo.search.impl.querymodel.QueryOptions options)

Construct from Query Options

options - QueryOptions

public SearchParameters copy()

public String getLanguage()

Get the search language

- string id of search language

public String getQuery()

public void setLanguage(String language)

Set the query language.

language - - the query language.

public void addExtraParameter(String name,
String value)

public Map<String> getExtraParameters()

public void setQuery(String query)

Set the query string.

query - - the query string.

public void addStore(StoreRef store)

Set the stores to be supported - currently there can be only one. Searching across multiple stores is on the todo list.

addQueryParameterDefinition

public void addQueryParameterDefinition(QueryParameterDefinition queryParameterDefinition)

Add parameter definitions for the query - used to parameterise the query string

queryParameterDefinition - QueryParameterDefinition

excludeDataInTheCurrentTransaction

public void excludeDataInTheCurrentTransaction(boolean excludeDataInTheCurrentTransaction)

If true, any data in the current transaction will be ignored in the search. You will not see anything you have added in the current transaction. By default you will see data in the current transaction. This effectively gives read committed isolation. There is a performance overhead for this, at least when using lucene. This flag may be set to avoid that performance hit if you know you do not want to find results that are yet to be committed (this includes creations, deletions and updates)

excludeDataInTheCurrentTransaction - boolean

public void addSort(String field,
boolean ascending)

Add a sort to the query (for those query languages that do not support it directly) The first sort added is treated as primary, the second as secondary etc. A helper method to create SortDefinitions.

field - - this is initially a direct attribute on a node not an attribute on the parent etc TODO: It could be a relative path at some time.

ascending - - true to sort ascending, false for descending.

public void addSort(org.alfresco.service.cmr.search.SearchParameters.SortDefinition sortDefinition)

Add a sort definition.

sortDefinition - - the sort definition to add. Use the static member variables for sorting in score and index order.

excludeDataInTheCurrentTransaction

public boolean excludeDataInTheCurrentTransaction()

Is data in the current transaction excluded from the search.

- true if data in the current transaction is ignored

getQueryParameterDefinitions

public ArrayList<QueryParameterDefinition> getQueryParameterDefinitions()

Get the query parameters that apply to this query.

public ArrayList<org.alfresco.service.cmr.search.SearchParameters.SortDefinition> getSortDefinitions()

Get the sort definitions that apply to this query.

- the sort definitions

public ArrayList<StoreRef> getStores()

Get the stores in which this query should find results.

- the list of stores

public void setDefaultOperator(org.alfresco.service.cmr.search.SearchParameters.Operator defaultOperator)

Set the default operator for query elements when they are not explicit in the query.

defaultOperator - Operator

public org.alfresco.service.cmr.search.SearchParameters.Operator getDefaultOperator()

Get the default operator for query elements when they are not explicit in the query.

the default operator

public LimitBy getLimitBy()

Get how the result set should be limited

how the result set will be or was limited

public void setLimitBy(LimitBy limitBy)

Set how the result set should be limited.

getPermissionEvaluation

public PermissionEvaluationMode getPermissionEvaluation()

Get when permissions are evaluated.

- how permissions are evaluated

setPermissionEvaluation

public void setPermissionEvaluation(PermissionEvaluationMode permissionEvaluation)

Set when permissions are evaluated.

permissionEvaluation - PermissionEvaluationMode

public int getLimit()

If limiting the result set in some way, get the limiting value used.

public void setLimit(int limit)

If limiting the result set in some way, set the limiting value used.

public org.alfresco.repo.search.MLAnalysisMode getMlAnalaysisMode()

The way in which multilingual fields are treated durig a search. By default, only the specified locale is used and it must be an exact match.

- how locale related text is tokenised

public void setMlAnalaysisMode(org.alfresco.repo.search.MLAnalysisMode mlAnalaysisMode)

Set the way in which multilingual fields are treated durig a search. This controls in which locales an multilingual fields will match.

mlAnalaysisMode - MLAnalysisMode

public void addLocale(Locale locale)

Add a locale to include for multi-lingual text searches. If non are set, the default is to use the user's locale.

public List<Locale> getLocales()

Get the locales used for multi-lingual text searches.

public void addTextAttribute(String attribute)

Add a field for TEXT expansion

attribute - - field/attribute in the index

public Set<String> getTextAttributes()

Get the text attributes used for text expansion.

the text attributes used for text expansion

public void addAllAttribute(String attribute)

Add a field for ALL expansion

attribute - - field/attribute in the index

public Set<String> getAllAttributes()

Get the text attributes used for ALL expansion.

the text attributes used for ALL expansion

public int getMaxItems()

Get the max number of rows for the result set 0 or less is unlimited

public void setMaxItems(int maxItems)

Set the max number of rows for the result set. A negative value implies unlimited 0 will return no results.

maxItems - the maxItems to set

public int getSkipCount()

Get the skip count - the number of rows to skip at the start of the query.

public void setSkipCount(int skipCount)

Set the skip count - the number of rows to skip at the start of the query.

skipCount - the skipCount to set

getDefaultFTSOperator

public org.alfresco.service.cmr.search.SearchParameters.Operator getDefaultFTSOperator()

Get the default connective used when OR and AND are not specified for the FTS contains() function.

the defaultFTSConnective

setDefaultFTSOperator

public void setDefaultFTSOperator(org.alfresco.service.cmr.search.SearchParameters.Operator defaultFTSOperator)

Set the default connective used when OR and AND are not specified for the FTS contains() function.

defaultFTSOperator - the defaultFTSOperator to set

getDefaultFTSFieldOperator

public org.alfresco.service.cmr.search.SearchParameters.Operator getDefaultFTSFieldOperator()

As getDefaultFTSConnective() but for field groups

the defaultFTSFieldConnective

setDefaultFTSFieldConnective

public void setDefaultFTSFieldConnective(org.alfresco.service.cmr.search.SearchParameters.Operator defaultFTSFieldOperator)

As setDefaultFTSConnective() but for field groups

defaultFTSFieldOperator - the defaultFTSFieldOperator to set

public String getNamespace()

Get the default namespace.

the default namspace uri or prefix.

public void setNamespace(String namespace)

Set the default namespace

namespace - - the uri or prefix for the default namespace.

public Map<String> getQueryTemplates()

Get the query templates

- the query templates

public String addQueryTemplate(String name,
String template)

Add/replace a query template Not all languages support query templates

any removed template or null

getMaxPermissionCheckTimeMillis

public long getMaxPermissionCheckTimeMillis()

setMaxPermissionCheckTimeMillis

public void setMaxPermissionCheckTimeMillis(long maxPermissionCheckTimeMillis)

getMaxPermissionChecks

public int getMaxPermissionChecks()

setMaxPermissionChecks

public void setMaxPermissionChecks(int maxPermissionChecks)

public Boolean getUseInMemorySort()

public void setUseInMemorySort(Boolean useInMemorySort)

useInMemorySort - the useInMemorySort to set

getMaxRawResultSetSizeForInMemorySort

public Integer getMaxRawResultSetSizeForInMemorySort()

the maxRawResultSetSizeForInMemorySort

setMaxRawResultSetSizeForInMemorySort

public void setMaxRawResultSetSizeForInMemorySort(Integer maxRawResultSetSizeForInMemorySort)

maxRawResultSetSizeForInMemorySort - the maxRawResultSetSizeForInMemorySort to set

public boolean isBulkFetchEnabled()

true if bulk fetch is enabled

public void setBulkFetchEnabled(boolean isBulkFetchEnabled)

isBulkFetchEnabled - boolean

public String getDefaultFieldName()

the default field name

public void setDefaultFieldName(String defaultFieldName)

defaultFieldName - - the default field name to use

public List<org.alfresco.service.cmr.search.SearchParameters.FieldFacet> getFieldFacets()

public void addFieldFacet(org.alfresco.service.cmr.search.SearchParameters.FieldFacet fieldFacet)

public List<String> getFacetQueries()

public void addFacetQuery(String facetQuery)

public Locale getSortLocale()

setExcludeTenantFilter

public void setExcludeTenantFilter(boolean excludeTenantFilter)

getExcludeTenantFilter

public boolean getExcludeTenantFilter()

public void setQueryConsistency(org.alfresco.service.cmr.search.QueryConsistency queryConsistency)

public org.alfresco.service.cmr.search.QueryConsistency getQueryConsistency()

the queryConsistency

public Long getSinceTxId()

If not null, then the search should only include results from transactions after sinceTxId.

public void setSinceTxId(Long sinceTxId)

If not null, then the search should only include results from transactions after sinceTxId.

public String getSearchTerm()

public void setSearchTerm(String searchTerm)

searchTerm - the searchTerm to set