Java Doc for VariableResolver.java in  » IDE-Netbeans » visualweb.api.designer » com » sun » rave » web » ui » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

VariableResolver is used to parse expressions of the format.

<type> refers to a registerd VariableResolver.DataSource , custom VariableResolver.DataSource s can be registered via: VariableResolver.setDataSource(String key,VariableResolver.DataSource dataSource) . However, there are many built-in VariableResolver.DataSource types that are pre-registered.

Below are the pre-registered types:

• VariableResolver.ATTRIBUTE -- AttributeDataSource
• VariableResolver.BOOLEAN -- BooleanDataSource
• VariableResolver.BROWSER -- BrowserDataSource
• VariableResolver.CONSTANT -- ConstantDataSource
• VariableResolver.ESCAPE -- EscapeDataSource
• VariableResolver.HAS_FACET -- HasFacetDataSource
• VariableResolver.HAS_PROPERTY -- HasPropertyDataSource
• VariableResolver.INT -- IntDataSource
• VariableResolver.METHOD_BINDING -- MethodBindingDataSource
• VariableResolver.PROPERTY -- PropertyDataSource
• VariableResolver.REQUEST_PARAMETER -- RequestParameterDataSource
• VariableResolver.RESOURCE -- ResourceBundleDataSource
• VariableResolver.SESSION -- SessionDataSource
• VariableResolver.STYLE -- StyleDataSource
• VariableResolver.THEME_JS -- ThemeJavaScriptDataSource
• VariableResolver.THIS -- ThisDataSource

Defines "attribute" in $attribute{...}.

Defines "boolean" in $boolean{...}.

Defines "browser" in $browser{...}.

Defines "constant" in $constant{...}.

Defines "escape" in $escape{...}.

Defines "hasFacet" in $hasFacet{...}.

Defines "hasProperty" in $hasProperty{...}.

Defines "int" in $int{...}.

Defines "methodBinding" in $methodBinding{...}.

Defines "property" in $property{...}.

Defines "requestParameter" in $requestParameter{...}.

Defines "resource" in $resource{...}.

Defines "session" in $session{...}.

Defines "style" in $style{...}.

Defines "theme" in $theme{...}.

Defines "themeScript" in $themeScript{...}.

Defines "this" in $this{...}.

This method looks up the requested VariableResolver.DataSource by the given key.

This method will substitute variables into the given String, or return the variable if the substitution is the whole String.

Defines "attribute" in $attribute{...}. This allows you to retrieve an HttpRequest attribute.

Defines "boolean" in $boolean{...}. This converts the given String to a Boolean.

Defines "browser" in $browser{...}. This checks properties of the browser that sent the request.

Defines "constant" in $constant{...}. This allows constants in java classes to be accessed.

Defines "escape" in $escape{...}. This allows some reserved characters to be escaped in "if" attributes. Such as '=' or '|'.

Defines "hasFacet" in $hasFacet{...}. This allows you to see if a facet from the UIComponent exists.

Defines "hasProperty" in $hasProperty{...}. This allows you to see if a property from the UIComponent exists.

Defines "int" in $int{...}. This converts the given String to an Integer.

Defines "methodBinding" in $methodBinding{...}. This allows MethodBindings in to be created.

Defines "property" in $property{...}. This allows you to retrieve a property from the UIComponent.

Defines "requestParameter" in $requestParameter{...}. This allows you to retrieve a HttpRequest parameter (QUERY_STRING parameter).

Defines "resource" in $resource{...}. This allows resource to be accessed.

Defines "session" in $session{...}. This allows you to retrieve an HttpSession attribute.

Defines "style" in $style{...}. This allows you to retrieve a style classes from the current com.sun.rave.web.ui.theme.Theme .

Defines "theme" in $theme{...}. This allows you to retrieve a Theme message from the current com.sun.rave.web.ui.theme.Theme .

Defines "themeScript" in $themeScript{...}. This allows you to retrieve a JavaScript classes from the current com.sun.rave.web.ui.theme.Theme .

Defines "this" in $this{...}. This allows you to retrieve a number of different objects related to the relative placement of this expression.

This method looks up the requested VariableResolver.DataSource by the given key.
Parameters:
  key - The key identifying the desiredVariableResolver.DataSource The requested VariableResolver.DataSource

This method will substitute variables into the given String, or return the variable if the substitution is the whole String. This method looks for the LAST occurance of startToken in the given String. It then searches from that location (if found) to the first occurance of typeDelim. The value inbetween is used as the type of substitution to perform (i.e. request attribute, session, etc.). It next looks for the next occurance of endToken. The value inbetween is used as the key passed to the VariableResolver.DataSource specified by the type. The String value from the VariableResolver.DataSource replaces the portion of the String from the startToken to the endToken. If this is the entire String, the Object is returned instead of the String value. This process is repeated until no more substitutions are * needed.

This algorithm will accomodate nested variables (e.g. "${A{$x}}"). It also allows the replacement value itself to contain variables. Care should be taken to ensure that the replacement String included does not directly or indirectly refer to itself -- this will cause an infinite loop.

There is one special case where the string to be evaluated begins with the startToken and ends with the endToken. In this case, string substitution is NOT performed. Instead the value of the request attribute is returned.

This method sets the given VariableResolver.DataSource to be used for $[type]{...} when key matches type.