org.springframework.extensions.surf.extensibility

Interface SubComponentEvaluation

All Known Implementing Classes:

DefaultSubComponentEvaluation

public interface SubComponentEvaluation

A ComponentElementEvaluation is used to evaluate whether or not a SubComponent should be rendered or not and if it should be rendered the URI of the WebScript that should be used to perform the rendering.

Author:

David Draper

Method Summary

Methods

Modifier and Type	Method and Description
boolean	evaluate(RequestContext context, org.springframework.context.ApplicationContext applicationContext) Processes all the configured evaluator instances and returns the overall result.
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.

Method Detail

getId

String getId()

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

Returns:

String

getUri

String getUri()

Returns:

The configured URI to use to render the SubComponent if all configured SubComponentEvaluator instances pass successfully.

evaluate

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

Processes all the configured evaluator instances and returns the overall result. This is effectively an AND gate such that it will only return true if every SubComponentEvaluator returns true.

Parameters:

context - The current RequestContext

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

Returns:

boolean

renderIfEvaluated

boolean renderIfEvaluated()

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".

Returns:

boolean

getProperties

Map<String,String> getProperties()