org.springframework.extensions.surf.extensibility.impl

Class DefaultSubComponentEvaluation

java.lang.Object

org.springframework.extensions.surf.extensibility.impl.DefaultSubComponentEvaluation

All Implemented Interfaces:

SubComponentEvaluation

public class DefaultSubComponentEvaluation
extends Object
implements SubComponentEvaluation

This is the default implementation of the SubComponentEvaluation interface. It is used by the SubComponent.

Author:

David Draper

Constructor Summary

Constructors

Constructor and Description
DefaultSubComponentEvaluation(String id, boolean renderIfEvaluated)

Method Summary

Methods

Modifier and Type	Method and Description
void	addEvaluator(String evaluatorId, Map<String,String> evaluationParams, boolean negate) Adds a SubComponentEvaluator along with the parameters that should be used to evaluate it to the evaluator map.
void	addProperty(String name, String value)
boolean	evaluate(RequestContext context, org.springframework.context.ApplicationContext applicationContext) Iterates over all the entries in the evaluators map evaluating each one.
String	getId() An evaluation should define an ID to help with debugging.
Map<String,String>	getProperties()
String	getUri()
boolean	renderIfEvaluated() Indicates whether or not the successful evaluation means that the SubComponent should be rendered or not.
void	setUri(String uri) Sets the URI that should be used to render a SubComponent if the evaluation passes.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSubComponentEvaluation

public DefaultSubComponentEvaluation(String id,
                             boolean renderIfEvaluated)

Method Detail

getId

public String getId()

Description copied from interface: SubComponentEvaluation

An evaluation should define an ID to help with debugging. This will return it.

Specified by:

getId in interface SubComponentEvaluation

Returns:

String

setUri

public void setUri(String uri)

Sets the URI that should be used to render a SubComponent if the evaluation passes.

Parameters:

uri - The URI to set.

getUri

public String getUri()

Specified by:

getUri in interface SubComponentEvaluation

Returns:

This is the URI that should be used to render a SubComponent if the evaluation passes.

addProperty

public void addProperty(String name,
               String value)

getProperties

public Map<String,String> getProperties()

Specified by:

getProperties in interface SubComponentEvaluation

addEvaluator

public void addEvaluator(String evaluatorId,
                Map<String,String> evaluationParams,
                boolean negate)

Adds a SubComponentEvaluator along with the parameters that should be used to evaluate it to the evaluator map.

Parameters:

evaluatorId - The id of a SubComponentEvaluator that should be used as part of the overall evaluation.

evaluationParams - A Map of name/value parameters that should be passed to the SubComponentEvaluator when evaluation is performed.

negate - Indicates that the result of the evaluator should be negated (e.g. an evaluator returning false should be converted to true

evaluate

public boolean evaluate(RequestContext context,
               org.springframework.context.ApplicationContext applicationContext)

Iterates over all the entries in the evaluators map evaluating each one.

Specified by:

evaluate in interface SubComponentEvaluation

Parameters:

context - The current RequestContext

applicationContext - The ApplicationContext to use to look up the SubComponentEvaluator instances from.

Returns:

true if all evaluators pass and false otherwise.

renderIfEvaluated

public boolean renderIfEvaluated()

Description copied from interface: SubComponentEvaluation

Indicates whether or not the successful evaluation means that the SubComponent should be rendered or not. This should return false if the the <evaluation> XML configuration includes has the attribute renderIfEvaluated set to the value "false".

Specified by:

renderIfEvaluated in interface SubComponentEvaluation

Returns:

true if this SubComponentEvaluation is configured for the purpose of providing a rendering URL and false if it is configured for the purpose of preventing a SubComponent from being rendered.