public class QueryOptions extends Object
Modifier and Type | Class and Description |
---|---|
static class |
QueryOptions.Connective |
Constructor and Description |
---|
QueryOptions(String query,
StoreRef storeRef)
Create a CMISQueryOptions instance with the default options other than the query and store ref.
|
QueryOptions(String query,
StoreRef storeRef,
Locale locale)
Create a CMISQueryOptions instance with the default options other than the query, store ref and locale.
|
Modifier and Type | Method and Description |
---|---|
static QueryOptions |
create(SearchParameters searchParameters) |
SearchParameters |
getAsSearchParmeters() |
String |
getDefaultFieldName() |
QueryOptions.Connective |
getDefaultFTSConnective()
Get the default connective used when OR and AND are not specified for the FTS contains() function.
|
QueryOptions.Connective |
getDefaultFTSFieldConnective()
As getDefaultFTSConnective() but for field groups
|
boolean |
getExcludeTenantFilter() |
List<Locale> |
getLocales()
Get the list of locales to use for the query
|
int |
getMaxItems()
Get the max number of rows for the result set 0 or less is unlimited
|
int |
getMaxPermissionChecks() |
long |
getMaxPermissionCheckTimeMillis() |
Integer |
getMaxRawResultSetSizeForInMemorySort() |
MLAnalysisMode |
getMlAnalaysisMode()
Get the mode for multi-lingual text analaysis
|
String |
getQuery()
Get the query string
|
QueryConsistency |
getQueryConsistency() |
List<QueryParameterDefinition> |
getQueryParameterDefinitions()
Get the query parameters
|
Long |
getSinceTxId() |
int |
getSkipCount()
Get the skip count - the number of rows to skip at the start of the query.
|
List<StoreRef> |
getStores()
Get the list of stores in which to run the query.
|
Boolean |
getUseInMemorySort() |
boolean |
isBulkFetchEnabled() |
boolean |
isIncludeInTransactionData()
Does the search include any changes made in the current transaction?
|
void |
setBulkFetchEnabled(boolean isBulkFetchEnabled) |
void |
setDefaultFieldName(String defaultFieldName) |
void |
setDefaultFTSConnective(QueryOptions.Connective defaultFTSConnective)
Set the default connective used when OR and AND are not specified for the FTS contains() function.
|
void |
setDefaultFTSFieldConnective(QueryOptions.Connective defaultFTSFieldConnective)
As setDefaultFTSConnective() but for field groups
|
void |
setExcludeTenantFilter(boolean excludeTenantFilter) |
void |
setIncludeInTransactionData(boolean includeInTransactionData)
Set to true if the search include any changes made in the current transaction.
|
void |
setLocales(List<Locale> locales)
sSet the list of locales to use for the query
|
void |
setMaxItems(int maxItems)
Set the max number of rows for the result set 0 or less is unlimited
|
void |
setMaxPermissionChecks(int maxPermissionChecks) |
void |
setMaxPermissionCheckTimeMillis(long maxPermissionCheckTimeMillis) |
void |
setMaxRawResultSetSizeForInMemorySort(Integer maxRawResultSetSizeForInMemorySort) |
void |
setMlAnalaysisMode(MLAnalysisMode mlAnalaysisMode)
Set the mode for multi-lingual text analaysis
|
void |
setQuery(String query)
Set the query string
|
void |
setQueryConsistency(QueryConsistency queryConsistency) |
void |
setQueryParameterDefinitions(List<QueryParameterDefinition> queryParameterDefinitions)
Set the query parameters
|
void |
setSinceTxId(Long sinceTxId) |
void |
setSkipCount(int skipCount)
Set the skip count - the number of rows to skip at the start of the query.
|
void |
setStores(List<StoreRef> stores)
Set the stores against which to run the query.
|
void |
setUseInMemorySort(Boolean useInMemorySort) |
public QueryOptions(String query, StoreRef storeRef)
query
- -
the query to runstoreRef
- -
the store against which to run the querypublic static QueryOptions create(SearchParameters searchParameters)
public String getQuery()
public void setQuery(String query)
query
- the query to setpublic List<StoreRef> getStores()
public void setStores(List<StoreRef> stores)
stores
- the stores to setpublic int getMaxItems()
public void setMaxItems(int maxItems)
maxItems
- the maxItems to setpublic int getSkipCount()
public void setSkipCount(int skipCount)
skipCount
- the skipCount to setpublic QueryOptions.Connective getDefaultFTSConnective()
public void setDefaultFTSConnective(QueryOptions.Connective defaultFTSConnective)
defaultFTSConnective
- the defaultFTSConnective to setpublic QueryOptions.Connective getDefaultFTSFieldConnective()
public void setDefaultFTSFieldConnective(QueryOptions.Connective defaultFTSFieldConnective)
defaultFTSFieldConnective
- the defaultFTSFieldConnective to setpublic List<Locale> getLocales()
public void setLocales(List<Locale> locales)
locales
- the locales to setpublic MLAnalysisMode getMlAnalaysisMode()
public void setMlAnalaysisMode(MLAnalysisMode mlAnalaysisMode)
mlAnalaysisMode
- the mlAnalaysisMode to setpublic List<QueryParameterDefinition> getQueryParameterDefinitions()
public void setQueryParameterDefinitions(List<QueryParameterDefinition> queryParameterDefinitions)
queryParameterDefinitions
- the queryParameterDefinitions to setpublic boolean isIncludeInTransactionData()
public void setIncludeInTransactionData(boolean includeInTransactionData)
includeInTransactionData
- the includeInTransactionData to setpublic long getMaxPermissionCheckTimeMillis()
public void setMaxPermissionCheckTimeMillis(long maxPermissionCheckTimeMillis)
maxPermissionCheckTimeMillis
- -
the timeout in millis for permission checkspublic int getMaxPermissionChecks()
public void setMaxPermissionChecks(int maxPermissionChecks)
maxPermissionChecks
- -
the max number of permission checks to carry outpublic String getDefaultFieldName()
public void setDefaultFieldName(String defaultFieldName)
defaultFieldName
- - the default field name to usepublic Boolean getUseInMemorySort()
public void setUseInMemorySort(Boolean useInMemorySort)
useInMemorySort
- the useInMemorySort to setpublic Integer getMaxRawResultSetSizeForInMemorySort()
public void setMaxRawResultSetSizeForInMemorySort(Integer maxRawResultSetSizeForInMemorySort)
maxRawResultSetSizeForInMemorySort
- the maxRawResultSetSizeForInMemorySort to setpublic boolean isBulkFetchEnabled()
public void setBulkFetchEnabled(boolean isBulkFetchEnabled)
isBulkFetchEnabled
- booleanpublic boolean getExcludeTenantFilter()
public void setExcludeTenantFilter(boolean excludeTenantFilter)
excludeTenantFilter
- booleanpublic QueryConsistency getQueryConsistency()
public void setQueryConsistency(QueryConsistency queryConsistency)
queryConsistency
- the queryConsistency to setpublic Long getSinceTxId()
public void setSinceTxId(Long sinceTxId)
sinceTxId
- the sinceTxId to setpublic SearchParameters getAsSearchParmeters()
Copyright © 2005–2016 Alfresco Software. All rights reserved.