com.exalead.access.feedapi

Class QueryContext

java.lang.Object

com.exalead.access.feedapi.utils.AccessLogLevelConfiguration

com.exalead.access.feedapi.eval.mel.extension.AbstractMELType

com.exalead.access.feedapi.eval.mel.extension.VariableResolver

com.exalead.access.feedapi.QueryContext

All Implemented Interfaces:

com.exalead.access.feedapi.eval.mel.extension.HasMELFlags, com.exalead.access.feedapi.eval.mel.extension.IVariableResolver, com.exalead.access.feedapi.eval.mel.extension.MELType, com.exalead.access.feedapi.eval.mel.extension.MELTypeVisitor<com.exalead.access.feedapi.eval.mel.extension.MELType,com.exalead.access.feedapi.eval.mel.extension.MELType.ArithmeticOperation>, com.exalead.access.feedapi.eval.mel.extension.types.MELCollatable<com.exalead.access.feedapi.eval.mel.extension.MELType>, java.lang.Cloneable

public class QueryContext
extends com.exalead.access.feedapi.eval.mel.extension.VariableResolver
implements java.lang.Cloneable

Query Context Class. The Query Context contains everything that is related to a given Query's execution (parameters, overrides, etc...)

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.access.feedapi.eval.mel.extension.VariableResolver

com.exalead.access.feedapi.eval.mel.extension.VariableResolver.FieldsHolder

Nested classes/interfaces inherited from class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType

com.exalead.access.feedapi.eval.mel.extension.AbstractMELType.Field

Nested classes/interfaces inherited from interface com.exalead.access.feedapi.eval.mel.extension.MELType

com.exalead.access.feedapi.eval.mel.extension.MELType.ArithmeticOperation, com.exalead.access.feedapi.eval.mel.extension.MELType.AttributePointer<P>

Field Summary

Fields inherited from class com.exalead.access.feedapi.eval.mel.extension.VariableResolver

scopes

Fields inherited from class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType

flags

Constructor Summary

Constructors

Constructor and Description
QueryContext() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addContextNode(Feed feed) Deprecated. as of 2013x release, replaced by registerPageParameters(Feed).
void	addContextNode(java.lang.String identifier, ResultFeed resultFeed, Entry entry) Deprecated. as of 2013x release, replaced by pushFeedEntry(String, ResultFeed, Entry).
QueryContext	clone() Returns a copy of this QueryContext.
QueryContext	createSubContext() Creates a copy a this context, copying parameters scope & resetting local variables if we are in an asynchronous case.
QueryContext	createSubContext(boolean synchronizedContext) Creates a copy a this context, copying parameters scope & resetting local variables if we are in an asynchronous case.
void	deleteLastNode(java.lang.String identifier) Deprecated. as of 2013x release, replaced by popFeedEntry(String).
void	disableFeed(Feed feed) Disable the provided feed for the current running query.
void	dump()
void	dump(org.apache.log4j.Logger logger) Dumps a complete overview of the current QueryContext in the provided logger at a trace level.
void	embedFeed(Feed feed, boolean embedFeed) Embed the given feed or not for the current running query.
void	enableFeed(Feed feed) Enable the given feed for the current running query.
java.lang.String	eval(java.lang.String mELExpression) Evaluates a MEL expression using the MELExpressionEvaluator.
java.lang.String	eval(java.lang.String mELExpression, boolean urlEncode, boolean xmlEscape, boolean highlight) Deprecated. as of 2013x release, replaced by eval(String, MELFlags)
java.lang.String	eval(java.lang.String mELExpression, com.exalead.access.feedapi.eval.mel.extension.types.MELFlags defaultFlags) Evaluates a MEL expression using the MELExpressionEvaluator.
Feed	getCurrentFeed() Returns the feed currently processed.
Entry	getEntry() Returns the current entry.
<T> T	getGlobalVariable(java.lang.String identifier) Gets a global variable (kept across sub-contexts).
<T> T	getLocalVariable(java.lang.String identifier) Gets a local variable.
java.util.Map<java.lang.String,java.lang.Object>	getLocalVariables() Gets the local variables.
java.util.List<java.lang.String>	getParametersNames(java.lang.String feedId, boolean prefixParameters) Get all the parameter names found in the query string for the given feed identifier that are now contained in the feed definition.
java.util.List<java.lang.String>	getParametersNamesFromPattern(java.lang.String feedId, boolean prefixParameters) Deprecated. as of 2013x release, replaced by getParametersNames(String, boolean).
Feed	getParentFeed() Find the direct parent Feed of the current entry.
java.util.Map<java.lang.String,java.lang.String[]>	getQueryParams() Gets the HTTP query parameters.
java.util.Map<java.lang.String,java.lang.String[]>	getRawHttpParams() Deprecated. as of 2013x release, replaced by getQueryParams().
Feed	getRootFeed() Returns the root feed of the current query.
java.lang.String[]	getSecurityTokens() Get the Security Tokens provided with the user request.
java.lang.String	getUsername() Returns the username provided with the user request.
java.lang.String	getUserQueryID() Returns the user query identifier provided with the user request.
java.lang.String	getUserSessionID() Returns the user session identifier provided with the user request.
boolean	isDebugEnabled() Returns whether the request is executed in a debug context.
boolean	isFeedEmbed(Feed feed) Check whether the given feed is embed or not.
boolean	isFeedEnabled(Feed feed) Check whether the given feed is enabled or not.
java.util.List<java.lang.String>	lookupValues(java.lang.String variable, java.lang.String flags) Looks up for a parameter / variable name in the context nodes and returns all values found or an empty list.
void	overrideParameter(Feed feed, java.lang.String name, java.util.List<java.lang.String> values) Override a parameter's values for the given Feed, for the current running query.
void	overrideParameter(Feed feed, java.lang.String name, java.lang.String value) Override a parameter's value for the given Feed, for the current running query.
void	popFeedEntry(java.lang.String identifier) Pop the feed & entry stacks.
void	pushFeedEntry(java.lang.String identifier, ResultFeed resultFeed, Entry entry) Push the previous feed & entry scopes values onto the feed & entry stacks.
void	pushFeedResult(java.lang.String identifier, ResultFeed resultFeed) Push the previous feed onto the feed stack.
void	registerPageParameters(Feed feed) Register parameters of the given feed to the page.params scope.
java.util.List<java.lang.String>	resolve(java.lang.String variable, java.lang.String flags) Support the generic VariableResolver interface resolve call.
void	restoreContext(Feed feed) Restore the context to its original state after a switchContext(Feed) call.
<T> void	setGlobalVariable(java.lang.String identifier, T variable) Sets a global variable (kept across sub-contexts).
<T> void	setLocalVariable(java.lang.String identifier, T variable) Sets a local variable.
void	setLocalVariables(java.util.Map<java.lang.String,java.lang.Object> variables) Sets the local variables.
void	setQueryParams(java.util.Map<java.lang.String,java.lang.String[]> queryParams) Sets the HTTP query parameters.
void	setRootFeed(Feed rootFeed) Sets the root feed for the current query.
<T> void	setVariable(java.lang.String identifier, T variable) Deprecated. Since 2013x release, replaced by setGlobalVariable(String, Object). The method VariableResolver.getVariable(String) will not return the expected value, you now have to use getGlobalVariable(String). We're sorry for this move, but it was a necessary one.
void	switchContext(Feed feed) Fakes the query context to behave as if we were in the context of the provided Feed.

Methods inherited from class com.exalead.access.feedapi.eval.mel.extension.VariableResolver

clearScopes, getDefaultFlags, getFields, getScopes, getVariable, getVariables, putScope, removeScope, resolve, setDefaultFlags, setVariable, setVariables

Methods inherited from class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType

accept, collateTo, getFlags, rawStringValue, resolveField, resolveOperation, setFlags, stringValue, stringValue, visit, visitBoolean, visitCategory, visitCategory, visitFacet, visitFacet, visitFeed, visitList, visitMeta, visitNumber, visitString, visitUnknown

Methods inherited from class com.exalead.access.feedapi.utils.AccessLogLevelConfiguration

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryContext

public QueryContext()

Constructor.

Method Detail

setQueryParams

public void setQueryParams(java.util.Map<java.lang.String,java.lang.String[]> queryParams)

Sets the HTTP query parameters.

Parameters:

queryParams - the HTTP query parameters.

getQueryParams

public java.util.Map<java.lang.String,java.lang.String[]> getQueryParams()

Gets the HTTP query parameters.

Returns:

the HTTP query parameters.

getRawHttpParams

@Deprecated
public java.util.Map<java.lang.String,java.lang.String[]> getRawHttpParams()

Deprecated. as of 2013x release, replaced by getQueryParams().

Gets the HTTP query parameters.

Returns:

the HTTP query parameters.

pushFeedResult

public void pushFeedResult(java.lang.String identifier,
                           ResultFeed resultFeed)

Push the previous feed onto the feed stack. Sets feeds, feed, facets, facet, category, scopes according the given ResultFeed. The ResultFeed will be identified in the feeds scope by the given identifier.

Parameters:

identifier - the ResultFeed identifier.

resultFeed - the ResultFeed to be pushed on the feed stack.

pushFeedEntry

public void pushFeedEntry(java.lang.String identifier,
                          ResultFeed resultFeed,
                          Entry entry)

Push the previous feed & entry scopes values onto the feed & entry stacks. Sets feeds, feed, entry, entries, facets, facet, category, metas & meta scopes according the given ResultFeed & Entry. The ResultFeed will be identified in the feeds scope by the given identifier.

Parameters:

identifier - the ResultFeed identifier.

resultFeed - the ResultFeed to be pushed on the feed stack.

entry - the Entry to be pushed on the entry stack.

popFeedEntry

public void popFeedEntry(java.lang.String identifier)

Pop the feed & entry stacks. Sets feeds, feed, entry, entries, facets, facet, category, metas & meta scopes using the peek value of the feed & entry stacks. It also removes the ResultFeed identified by the given identifier from the feeds scope if it's not present in the feed stack.

Parameters:

identifier - the identifier of the ResultFeed to be removed from the feeds scope.

addContextNode

@Deprecated
public void addContextNode(java.lang.String identifier,
                                       ResultFeed resultFeed,
                                       Entry entry)

Deprecated. as of 2013x release, replaced by pushFeedEntry(String, ResultFeed, Entry).

Push the previous feed & entry scopes values onto the feed & entry stacks. Sets feeds, feed, entry, entries, facets, facet, category, metas & meta scopes according the given ResultFeed & Entry. The ResultFeed will be identified in the feeds scope by the given identifier.

Parameters:

identifier - the ResultFeed identifier.

resultFeed - the ResultFeed to be pushed on the feed stack.

entry - the Entry to be pushed on the entry stack.

deleteLastNode

@Deprecated
public void deleteLastNode(java.lang.String identifier)

Deprecated. as of 2013x release, replaced by popFeedEntry(String).

Pop the feed & entry stacks. Sets feeds, feed, entry, entries, facets, facet, category, metas & meta scopes using the peek value of the feed & entry stacks. It also removes the ResultFeed identified by the given identifier from the feeds scope if it's not present in the feed stack.

Parameters:

identifier - the identifier of the ResultFeed to be removed from the feeds scope.

registerPageParameters

public void registerPageParameters(Feed feed)
                            throws AccessException

Register parameters of the given feed to the page.params scope.

Parameters:

feed - the given Feed.

Throws:

AccessException

addContextNode

@Deprecated
public void addContextNode(Feed feed)
                                throws AccessException

Deprecated. as of 2013x release, replaced by registerPageParameters(Feed).

Register parameters of the given feed to the page.params scope.

Parameters:

feed - the given Feed.

Throws:

AccessException

lookupValues

public java.util.List<java.lang.String> lookupValues(java.lang.String variable,
                                                     java.lang.String flags)

Looks up for a parameter / variable name in the context nodes and returns all values found or an empty list.

Parameters:

variable - a variable name.

flags - variable flags.

Returns:

the values found for the given variable.

resolve

public java.util.List<java.lang.String> resolve(java.lang.String variable,
                                                java.lang.String flags)

Support the generic VariableResolver interface resolve call. Takes a variable name and its flags, and returns all values found, or null if there weren't any values.

Parameters:

variable - a variable name

flags - variable flags

Returns:

all values found, or null if there weren't any values

eval

public java.lang.String eval(java.lang.String mELExpression)

Evaluates a MEL expression using the MELExpressionEvaluator.

Parameters:

mELExpression - a MEL expression (e.g: ${search.q})

Returns:

the value returned by the MELExpressionEvaluator

eval

@Deprecated
public java.lang.String eval(java.lang.String mELExpression,
                                         boolean urlEncode,
                                         boolean xmlEscape,
                                         boolean highlight)

Deprecated. as of 2013x release, replaced by eval(String, MELFlags)

Evaluates a MEL expression using the MELExpressionEvaluator.

Parameters:

mELExpression - a MEL expression (e.g: ${search.q})

urlEncode - true if by default MEL variables should be URL encoded

xmlEscape - true if by default MEL variables should be XML escaped

highlight - true if by default MEL variables should be highlighted

Returns:

the value returned by the MELExpressionEvaluator

eval

public java.lang.String eval(java.lang.String mELExpression,
                             com.exalead.access.feedapi.eval.mel.extension.types.MELFlags defaultFlags)

Evaluates a MEL expression using the MELExpressionEvaluator.

Parameters:

mELExpression - a MEL expression (e.g: ${search.q})

defaultFlags - the default flags to be used while resolving MEL variables

Returns:

the value returned by the MELExpressionEvaluator

getParametersNames

public java.util.List<java.lang.String> getParametersNames(java.lang.String feedId,
                                                           boolean prefixParameters)

Get all the parameter names found in the query string for the given feed identifier that are now contained in the feed definition.

Parameters:

feedId - the given feed identifier.

prefixParameters - true to prefix parameters name with the feedId, false otherwise.

Returns:

a list of the parameter names found.

getParametersNamesFromPattern

@Deprecated
public java.util.List<java.lang.String> getParametersNamesFromPattern(java.lang.String feedId,
                                                                                  boolean prefixParameters)

Deprecated. as of 2013x release, replaced by getParametersNames(String, boolean).

Get all the parameter names found in the query string for the given feed identifier that are now contained in the feed definition.

Parameters:

feedId - the given feed identifier.

prefixParameters - true to prefix parameters name with the feedId, false otherwise.

Returns:

a list of the parameter names found.

getSecurityTokens

public java.lang.String[] getSecurityTokens()

Get the Security Tokens provided with the user request.

Returns:

an array of strings containing the security tokens.

getUsername

public java.lang.String getUsername()

Returns the username provided with the user request.

Returns:

a String representing the username provided with the user request.

getUserSessionID

public java.lang.String getUserSessionID()

Returns the user session identifier provided with the user request.

Returns:

a String representing the user session identifier provided with the user request.

getUserQueryID

public java.lang.String getUserQueryID()

Returns the user query identifier provided with the user request.

Returns:

a String representing the user query identifier provided with the user request.

isDebugEnabled

public boolean isDebugEnabled()

Returns whether the request is executed in a debug context.

Returns:

true if request is executed in a debug context, else false.

setRootFeed

public void setRootFeed(Feed rootFeed)
                 throws AccessException

Sets the root feed for the current query.

Parameters:

rootFeed - the root feed to be set.

Throws:

AccessException - if the root feed is not a PageFeed instance.

getRootFeed

public Feed getRootFeed()

Returns the root feed of the current query.

Returns:

the root feed of the current query.

getCurrentFeed

public Feed getCurrentFeed()

Returns the feed currently processed.

Returns:

the feed currently processed.

overrideParameter

public void overrideParameter(Feed feed,
                              java.lang.String name,
                              java.lang.String value)

Override a parameter's value for the given Feed, for the current running query.

Parameters:

feed - the Feed containing the parameter to be overridden.

name - the name of the parameter to be overridden.

value - the parameter's value.

overrideParameter

public void overrideParameter(Feed feed,
                              java.lang.String name,
                              java.util.List<java.lang.String> values)

Override a parameter's values for the given Feed, for the current running query.

Parameters:

feed - the Feed containing the parameter to be overridden.

name - the name of the parameter to be overridden.

value - the parameter's values.

disableFeed

public void disableFeed(Feed feed)

Disable the provided feed for the current running query.

Parameters:

feed - the provided feed.

enableFeed

public void enableFeed(Feed feed)

Enable the given feed for the current running query.

Parameters:

feed - the given feed.

isFeedEnabled

public boolean isFeedEnabled(Feed feed)

Check whether the given feed is enabled or not.

Parameters:

feed - the given feed.

Returns:

true if the feed is enabled, false otherwise.

embedFeed

public void embedFeed(Feed feed,
                      boolean embedFeed)

Embed the given feed or not for the current running query.

Parameters:

feed - the given feed.

embedFeed - true if the feed shall be embed, false otherwise.

isFeedEmbed

public boolean isFeedEmbed(Feed feed)

Check whether the given feed is embed or not.

Parameters:

feed - the given feed.

Returns:

true if the feed is embed, false otherwise.

switchContext

public void switchContext(Feed feed)
                   throws AccessException

Fakes the query context to behave as if we were in the context of the provided Feed.

Parameters:

feed - the provided feed.

Throws:

AccessException

restoreContext

public void restoreContext(Feed feed)

Restore the context to its original state after a switchContext(Feed) call.

createSubContext

public QueryContext createSubContext()

Creates a copy a this context, copying parameters scope & resetting local variables if we are in an asynchronous case. A copy will be done if the current feed doesn't have synchronized sub-feeds.

Returns:

a copy of this context.

createSubContext

public QueryContext createSubContext(boolean synchronizedContext)

Creates a copy a this context, copying parameters scope & resetting local variables if we are in an asynchronous case.

Parameters:

synchronizedContext - true if we need a synchronized context, false otherwise.

Returns:

a copy of this context.

setVariable

public <T> void setVariable(java.lang.String identifier,
                            T variable)

Deprecated. Since 2013x release, replaced by setGlobalVariable(String, Object). The method VariableResolver.getVariable(String) will not return the expected value, you now have to use getGlobalVariable(String). We're sorry for this move, but it was a necessary one.

Sets a global variable (kept across sub-contexts). This global variable can be used in a MEL expression (e.g: VAR.a.b, if my variable identifier is a.b).

Type Parameters:

T -

Parameters:

identifier - the variable identifier (e.g: a.b).

variable - the variable to be stored globally.

setGlobalVariable

public <T> void setGlobalVariable(java.lang.String identifier,
                                  T variable)

Sets a global variable (kept across sub-contexts). This global variable can be used in a MEL expression (e.g: VAR.a.b, if my variable identifier is a.b).

Parameters:

identifier - the variable identifier (e.g: a.b).

variable - the variable to be stored globally.

getGlobalVariable

public <T> T getGlobalVariable(java.lang.String identifier)

Gets a global variable (kept across sub-contexts).

Parameters:

identifier - the variable identifier (e.g: a.b).

Returns:

the identified global variable or null.

setLocalVariable

public <T> void setLocalVariable(java.lang.String identifier,
                                 T variable)

Sets a local variable. This local variable can be used in a MEL expression (e.g: VAR.a.b, if my variable identifier is a.b).

Parameters:

identifier - the variable identifier (e.g: a.b).

variable - the variable to be stored locally.

getLocalVariable

public <T> T getLocalVariable(java.lang.String identifier)

Gets a local variable.

Parameters:

identifier - the variable identifier (e.g: a.b).

Returns:

the identified local variable or null.

getLocalVariables

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

Gets the local variables.

Returns:

the local variables.

setLocalVariables

public void setLocalVariables(java.util.Map<java.lang.String,java.lang.Object> variables)

Sets the local variables.

Parameters:

variables - the local variables to be set.

getParentFeed

public Feed getParentFeed()

Find the direct parent Feed of the current entry.

Returns:

the direct parent Feed of the current entry.

getEntry

public Entry getEntry()

Returns the current entry.

Returns:

the current Entry.

clone

public QueryContext clone()

Returns a copy of this QueryContext.

Overrides:

clone in class java.lang.Object

Returns:

a clone of this instance.

dump

public void dump()

dump

public void dump(org.apache.log4j.Logger logger)

Dumps a complete overview of the current QueryContext in the provided logger at a trace level.

Parameters:

logger - a Logger that will be used to dump the current QueryContext.