com.communote.server.core.vo.query.config

Class TimelineQueryParametersConfigurator<T extends TimelineQueryParameters>

java.lang.Object

com.communote.server.core.vo.query.config.QueryParametersConfigurator

com.communote.server.core.vo.query.config.TimelineQueryParametersConfigurator<T>

Type Parameters:

T -

Direct Known Subclasses:

NoteQueryParametersConfigurator

public class TimelineQueryParametersConfigurator<T extends TimelineQueryParameters>
extends QueryParametersConfigurator

This QueryParametersConfigurator can be used to configure a CoreItemQueryInstance .

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
TimelineQueryParametersConfigurator(QueryParametersParameterNameProvider nameProvider) Constructor for this QueryParametersConfigurator.
TimelineQueryParametersConfigurator(QueryParametersParameterNameProvider nameProvider, int defaultMaxCount) Constructor for this QueryParametersConfigurator.

Method Summary

Modifier and Type	Method and Description
void	configure(Map<String,? extends Object> parameters, T queryParameters) Method to start the configuration process.
protected void	configureBlogSpecificQueryInstance(Map<String,? extends Object> parameters, T queryParameters) This method configures the given QueryInstance with blog specific settings from the parameter map.
protected void	configureQueryParameters(Map<String,? extends Object> parameters, T queryParameters) This method configures a given query instance with the provided parameters map.
TimelineFilterViewType	determineViewType(Map<String,? extends Object> parameters) Helper to determine the TimelineFilterViewType based on the parameters and the defined name provider.
static TimelineFilterViewType	determineViewType(Map<String,? extends Object> parameters, QueryParametersParameterNameProvider parameterNameProvider) Helper to determine the TimelineFilterViewType based on the parameters.

Methods inherited from class com.communote.server.core.vo.query.config.QueryParametersConfigurator

getParameterNameProvider, getResultSpecification, getResultSpecification

Methods inherited from class java.lang.Object

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

Constructor Detail

TimelineQueryParametersConfigurator

public TimelineQueryParametersConfigurator(QueryParametersParameterNameProvider nameProvider)

Constructor for this QueryParametersConfigurator.

Parameters:

nameProvider - To fetch parameters for the query instance.

TimelineQueryParametersConfigurator

public TimelineQueryParametersConfigurator(QueryParametersParameterNameProvider nameProvider,
                                           int defaultMaxCount)

Constructor for this QueryParametersConfigurator.

Parameters:

nameProvider - To fetch parameters for the query instance.

defaultMaxCount - the default value to use if maxCount parameter is not set

Method Detail

determineViewType

public static TimelineFilterViewType determineViewType(Map<String,? extends Object> parameters,
                                                       QueryParametersParameterNameProvider parameterNameProvider)

Helper to determine the TimelineFilterViewType based on the parameters. In case no parameter is set or invalid, TimelineFilterViewType.CLASSIC is returned.

Parameters:

parameters - the parameters to use

parameterNameProvider - the parameter name provider to use

Returns:

the filter type

configure

public void configure(Map<String,? extends Object> parameters,
                      T queryParameters)

Method to start the configuration process.

Parameters:

parameters - Map which holds the parameters to be used to configure the query instance.

queryParameters - Class of type QueryInstance.

configureBlogSpecificQueryInstance

protected void configureBlogSpecificQueryInstance(Map<String,? extends Object> parameters,
                                                  T queryParameters)

This method configures the given QueryInstance with blog specific settings from the parameter map.

Parameters:

parameters - Map with parameters.

queryParameters - Class of type QueryInstance.

configureQueryParameters

protected void configureQueryParameters(Map<String,? extends Object> parameters,
                                        T queryParameters)

This method configures a given query instance with the provided parameters map.

Parameters:

parameters - Map with parameters.

queryParameters - Class of type QueryInstance.

determineViewType

public TimelineFilterViewType determineViewType(Map<String,? extends Object> parameters)

Helper to determine the TimelineFilterViewType based on the parameters and the defined name provider. In case no parameter is set or invalid, TimelineFilterViewType.CLASSIC is returned. Is using determineViewType(Map, QueryParametersParameterNameProvider)

Parameters:

parameters - the parameters to take it from

Returns:

the view type extracted from the parameters