Package org.alfresco.service.cmr.search

Class StatsParameters

java.lang.Object

org.alfresco.service.cmr.search.StatsParameters

All Implemented Interfaces:

BasicSearchParameters

public class StatsParameters
extends java.lang.Object
implements BasicSearchParameters

Defines Stats search criteria

Since:

5.0

Author:

Gethin James

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FACET_PREFIX
static java.lang.String	PARAM_FACET
static java.lang.String	PARAM_FIELD

Constructor Summary

Constructors

Constructor	Description
StatsParameters(java.lang.String language, java.lang.String query)
StatsParameters(java.lang.String language, java.lang.String query, boolean isDateSearch)
StatsParameters(java.lang.String language, java.lang.String query, java.lang.String filterQuery, boolean isDateSearch)

Method Summary

Modifier and Type	Method	Description
void	addSort(SearchParameters.SortDefinition sortDefinition)	Add a sort definition.
void	addStatsParameter(java.lang.String name, java.lang.String value)	Add a parameter
void	addStore(StoreRef store)	Add a Store ref
java.lang.String	getFilterQuery()
java.lang.String	getLanguage()
java.util.List<java.util.Locale>	getLocales()
java.lang.String	getQuery()
java.util.List<SearchParameters.SortDefinition>	getSortDefinitions()
java.util.Map<java.lang.String,java.lang.String>	getStatsParameters()
java.util.List<StoreRef>	getStores()
boolean	isDateSearch()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PARAM_FIELD

public static final java.lang.String PARAM_FIELD

See Also:

Constant Field Values

PARAM_FACET

public static final java.lang.String PARAM_FACET

See Also:

Constant Field Values

FACET_PREFIX

public static final java.lang.String FACET_PREFIX

See Also:

Constant Field Values

Constructor Detail

StatsParameters

public StatsParameters(java.lang.String language,
                       java.lang.String query)

StatsParameters

public StatsParameters(java.lang.String language,
                       java.lang.String query,
                       boolean isDateSearch)

StatsParameters

public StatsParameters(java.lang.String language,
                       java.lang.String query,
                       java.lang.String filterQuery,
                       boolean isDateSearch)

Method Detail

getLanguage

public java.lang.String getLanguage()

Specified by:

getLanguage in interface BasicSearchParameters

getQuery

public java.lang.String getQuery()

Specified by:

getQuery in interface BasicSearchParameters

getFilterQuery

public java.lang.String getFilterQuery()

getStores

public java.util.List<StoreRef> getStores()

Specified by:

getStores in interface BasicSearchParameters

getLocales

public java.util.List<java.util.Locale> getLocales()

Specified by:

getLocales in interface BasicSearchParameters

getSortDefinitions

public java.util.List<SearchParameters.SortDefinition> getSortDefinitions()

Specified by:

getSortDefinitions in interface BasicSearchParameters

getStatsParameters

public java.util.Map<java.lang.String,java.lang.String> getStatsParameters()

isDateSearch

public boolean isDateSearch()

addSort

public void addSort(SearchParameters.SortDefinition sortDefinition)

Add a sort definition.

Parameters:

sortDefinition - - the sort definition to add.

addStatsParameter

public void addStatsParameter(java.lang.String name,
                              java.lang.String value)

Add a parameter

Parameters:

name - String

value - String

addStore

public void addStore(StoreRef store)

Add a Store ref

Parameters:

store - StoreRef

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object