vodserver.parambuilder

Class ContentDynamicRegExParamBuilder

java.lang.Object

vodserver.util.BaseBeanNameAware

vodserver.parambuilder.AbstractParamBuilder

vodserver.parambuilder.AbstractContentRegExParamBuilder

vodserver.parambuilder.ContentDynamicRegExParamBuilder

All Implemented Interfaces:

Comparable<ParamBuilder>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.core.Ordered, ParamBuilder

public class ContentDynamicRegExParamBuilder
extends AbstractContentRegExParamBuilder

This ParamBuilder will extract parameters from some content by using regular expressions. It can be configured with a static list of patterns, however the patterns themselves can contain expressions as described by ExpressionUtil. These expressions will be evaluated before using the regular expression to match against the content.

For example, suppose an earlier ParamBuilder defines a parameter named validChars with value 'abcdef', then you can define a regular expression as '(?<myParam>[!!validChars!!]+)'. Before the pattern is used, the expression will be evaluated, so the pattern becomes '(?<myParam>[abcdef]+)'.

For more information about regular expression format and how content is retrieved, please see the superclass AbstractContentRegExParamBuilder.

Author:

Ruud Senden

Field Summary

Fields inherited from class vodserver.parambuilder.AbstractContentRegExParamBuilder

contentParam

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ContentDynamicRegExParamBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
Collection<String>	getPatterns() Get the collection of patterns as they were configured, including the expressions.
protected Collection<Pattern>	getPatterns(Map<String,String> params, javax.servlet.http.HttpServletRequest request) Implementation for the AbstractContentRegExParamBuilder.getPatterns(Map, HttpServletRequest) method; this will evaluate any expressions inside the configured collection of patterns, then returns the collection of evaluated patterns.
boolean	isEnableRecursiveExpressions() Returns whether recursive expression evaluation is enabled.
void	setEnableRecursiveExpressions(boolean enableRecursiveExpressions) Enable or disable recursive expression evaluation.
void	setPatterns(Collection<String> patterns) Set the collection of patterns; these patterns may contain expressions as described by ExpressionUtil.
String	toString() Provide a useful string representation of this ParamBuilder, showing the content parameter name and the configured patterns (including expressions).

Methods inherited from class vodserver.parambuilder.AbstractContentRegExParamBuilder

addRegExValues, buildParams, getContentParam, getGroupNames, setContentParam

Methods inherited from class vodserver.parambuilder.AbstractParamBuilder

afterPropertiesSet, compareTo, extraAfterPropertiesSet, getOrder, setOrder

Methods inherited from class vodserver.util.BaseBeanNameAware

getBeanName, setBeanName

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentDynamicRegExParamBuilder

public ContentDynamicRegExParamBuilder()

Method Detail

getPatterns

protected Collection<Pattern> getPatterns(Map<String,String> params,
                              javax.servlet.http.HttpServletRequest request)

Implementation for the AbstractContentRegExParamBuilder.getPatterns(Map, HttpServletRequest) method; this will evaluate any expressions inside the configured collection of patterns, then returns the collection of evaluated patterns.

Specified by:

getPatterns in class AbstractContentRegExParamBuilder

Returns:

getPatterns

public Collection<String> getPatterns()

Get the collection of patterns as they were configured, including the expressions.

Returns:

setPatterns

public void setPatterns(Collection<String> patterns)

Set the collection of patterns; these patterns may contain expressions as described by ExpressionUtil.

Parameters:

patterns -

isEnableRecursiveExpressions

public boolean isEnableRecursiveExpressions()

Returns whether recursive expression evaluation is enabled.

Returns:

setEnableRecursiveExpressions

public void setEnableRecursiveExpressions(boolean enableRecursiveExpressions)

Enable or disable recursive expression evaluation. Default is enabled.

Parameters:

enableRecursiveExpressions -

toString

public String toString()

Provide a useful string representation of this ParamBuilder, showing the content parameter name and the configured patterns (including expressions).

Overrides:

toString in class Object