This is an automated email from the ASF dual-hosted git repository.
lukaszlenart pushed a commit to branch WW-5307-ognl
in repository https://gitbox.apache.org/repos/asf/struts-site.git
commit d36ac94b6eec28cf650abfa99d3bb3ba0c28e315
Author: Lukasz Lenart <lukaszlen...@apache.org>
AuthorDate: Fri May 19 12:49:23 2023 +0200
WW-5307 Cleans up OGNL related pages
---
source/tag-developers/ognl-basics.md | 101 ++++++++++++-----------------------
source/tag-developers/ognl.md | 70 +++++++-----------------
2 files changed, 52 insertions(+), 119 deletions(-)
diff --git a/source/tag-developers/ognl-basics.md
b/source/tag-developers/ognl-basics.md
index 688ab54ab..400087c4a 100644
--- a/source/tag-developers/ognl-basics.md
+++ b/source/tag-developers/ognl-basics.md
@@ -14,11 +14,11 @@ parent:
## Struts-specific language features
-The biggest addition that Struts provides on top of OGNL is the support for
the ValueStack. While OGNL operates under
+The biggest addition that Struts provides on top of OGNL is the support for
the ValueStack. While OGNL operates under
the assumption there is only one "root", Struts's ValueStack concept requires
there be many "roots".
-For example, suppose we are using standard OGNL (not using Struts) and there
are two objects in the OgnlContext map:
-"foo" -> foo and "bar" -> bar and that the foo object is also configured to be
the single **root** object.
+For example, suppose we are using standard OGNL (not using Struts) and there
are two objects in the OgnlContext map:
+"foo" -> foo and "bar" -> bar and that the foo object is also configured to be
the single **root** object.
The following code illustrates how OGNL deals with these three situations:
```
@@ -27,17 +27,17 @@ The following code illustrates how OGNL deals with these
three situations:
blah // returns foo.getBlah() because foo is the root
```
-What this means is that OGNL allows many objects in the context, but unless
the object you are trying to access is the root,
-it must be prepended with a namespaces such as @bar. Now let's talk about how
Struts is a little different...
+What this means is that OGNL allows many objects in the context, but unless
the object you are trying to access is the
+root, it must be prepended with a namespaces such as @bar. Now let's talk
about how Struts is a little different...
-> In Struts, the entire ValueStack is the root object in the context. Rather
than having your expressions get the object
-> you want from the stack and then get properties from that (ie: peek().blah),
Struts has a special OGNL PropertyAccessor
-> that will automatically look at the all entries in the stack (from the top
down) until it finds an object with the property
-> you are looking for.
+> In Struts, the entire ValueStack is the root object in the context. Rather
than having your expressions get the object
+> you want from the stack and then get properties from that (ie: peek().blah),
Struts has a special OGNL
+> PropertyAccessor that will automatically look at the all entries in the
stack (from the top down) until it finds
+> an object with the property you are looking for.
-For example, suppose the stack contains two objects: Animal and Person. Both
objects have a "name" property, Animal has
-a "species" property, and Person has a "salary" property. Animal is on the top
of the stack, and Person is below it.
-The follow code fragments help you get an idea of what is going on here:
+For example, suppose the stack contains two objects: `Animal` and `Person`.
Both objects have a `name` property,
+`Animal` has a `species` property, and `Person` has a `salary` property.
`Animal` is on the top of the stack,
+and `Person` is below it. The follow code fragments help you get an idea of
what is going on here:
```
species // call to animal.getSpecies()
@@ -45,29 +45,30 @@ salary // call to person.getSalary()
name // call to animal.getName() because animal is on the top
```
-In the last example, there was a tie and so the animal's name was returned.
Usually this is the desired effect, but
-sometimes you want the property of a lower-level object. To do this, XWork has
added support for indexes on the ValueStack.
-All you have to do is:
+In the last example, there was a tie and so the animal's name was returned.
Usually this is the desired effect, but
+sometimes you want the property of a lower-level object. To do this, XWork has
added support for indexes on the
+ValueStack. All you have to do is:
```
[0].name // call to animal.getName()
[1].name // call to person.getName()
```
-With expression like `[0] ... [3]` etc. Struts will cut the stack and still
return back a CompoundRoot object. To get
+With expression like `[0] ... [3]` etc. Struts will cut the stack and still
return back a CompoundRoot object. To get
the top of that particular stack cut, use `[0].top`
-|ognl expression|description|
-|---------------|-----------|
-|`[0].top`|would get the top of the stack cut starting from element 0 in the
stack (similar to top in this case)|
-|`[1].top`|would get the top of the stack cut starting from element 1 in the
stack|
+| ognl expression | description
|
+|-----------------|-------------------------------------------------------------------------------------------------------|
+| `[0].top` | would get the top of the stack cut starting from element 0
in the stack (similar to top in this case) |
+| `[1].top` | would get the top of the stack cut starting from element 1
in the stack |
### Accessing static properties
OGNL supports accessing static properties as well as static methods.
By default, Struts 2 is configured to disallow this - to enable OGNL's static
member support you must set the
-`struts.ognl.allowStaticMethodAccess` constant to `true` via any of the
[Constant Configuration](../core-developers/constant-configuration) methods.
+`struts.ognl.allowStaticMethodAccess` constant to `true` via any
+of the [Constant Configuration](../core-developers/constant-configuration)
methods.
OGNL's static access looks like this:
@@ -76,52 +77,16 @@ OGNL's static access looks like this:
@some.package.ClassName@someMethod()
```
-However, Struts allows you to avoid having to specify the full package name
and call static properties and methods of your
-action classes using the "vs" prefix:
-
-```
-<at:var at:name="vs" />FOO_PROPERTY
-<at:var at:name="vs" />someMethod()
-
-<at:var at:name="vs1" />FOO_PROPERTY
-<at:var at:name="vs1" />someMethod()
-
-<at:var at:name="vs2" />BAR_PROPERTY
-<at:var at:name="vs2" />someOtherMethod()
-```
-
-"vs" stands for "value stack". The important thing to note here is that if the
class name you specify is just "vs",
-the class for the object on the top of the stack is used. If you specify a
number after the "vs" string, an object's
-class deeper in the stack is used instead.
-
-### Differences from the WebWork 1.x EL
-
-Besides the examples and descriptions given above, there are a few major
changes in the EL since WebWork 1.x. The biggest
-one is that properties are no longer accessed with a forward slash (/) but
with a dot (.). Also, rather than using ".."
-to traverse down the stack, we now use "[n]" where n is some positive number.
Lastly, in WebWork 1.x one could access
-special named objects (the request scope attributes to be exact) by using
"@foo", but now special variables are accessed
-using "#foo". However, it is important to note that "#foo" does NOT access the
request attributes. Because XWork is not
-built only for the web, there is no concept of "request attributes", and thus
"#foo" is merely a request to another
-object in the OgnlContext other than the root.
-
-|Old Expression|New Expression|
-|--------------|--------------|
-|foo/blah|foo.blah|
-|foo/someMethod()|foo.someMethod()|
-|../bar/blah|[1].bar.blah|
-|@baz|not directly supported, but #baz is similar|
-|.|'top' or [0]|
-
### Struts 2 Named Objects
-Struts 2 places request parameters and request, session, and application
attributes on the OGNL stack. They may be accessed
-as shown below.
-
-|name|value|
-|----|-----|
-|#action['foo'] or #action.foo|current action getter (getFoo())|
-|#parameters['foo'] or #parameters.foo|request parameter ['foo']
(request.getParameter())|
-|#request['foo'] or #request.foo|request attribute ['foo']
(request.getAttribute())|
-|#session['foo'] or #session.foo|session attribute 'foo'|
-|#application['foo'] or #application.foo|ServletContext attributes 'foo'|
-|#attr['foo'] or #attr.foo|Access to PageContext if available, otherwise
searches request/session/application respectively|
+Struts 2 places request parameters and request, session, and application
attributes on the OGNL stack. They may be
+accessed as shown below.
+
+| name | value
|
+|-----------------------------------------|-------------------------------------------------------------------------------------------------|
+| #action['foo'] or #action.foo | current action getter (getFoo())
|
+| #parameters['foo'] or #parameters.foo | request parameter ['foo']
(request.getParameter()) |
+| #request['foo'] or #request.foo | request attribute ['foo']
(request.getAttribute()) |
+| #session['foo'] or #session.foo | session attribute 'foo'
|
+| #application['foo'] or #application.foo | ServletContext attributes 'foo'
|
+| #attr['foo'] or #attr.foo | Access to PageContext if
available, otherwise searches request/session/application respectively |
diff --git a/source/tag-developers/ognl.md b/source/tag-developers/ognl.md
index 9fd1fbc36..3d0303d36 100644
--- a/source/tag-developers/ognl.md
+++ b/source/tag-developers/ognl.md
@@ -12,7 +12,7 @@ parent:
* Will be replaced with the ToC, excluding a header
{:toc}
-OGNL is the Object Graph Navigation Language (see
[http://commons.apache.org/proper/commons-ognl/] for the full
+OGNL is the Object Graph Navigation Language (see [OGNL
page](https://ognl.orphan.software/) for the full
documentation of OGNL). Here, we will cover a few examples of OGNL features
that co-exist with the framework. To review
basic concepts, refer to [OGNL Basics](ognl-basics).
@@ -21,10 +21,12 @@ a Map (usually referred as a context map or context). OGNL
has a notion of there
the context. In expression, the properties of the root object can be
referenced without any special "marker" notion.
References to other objects are marked with a pound sign (`#`).
-The framework sets the OGNL context to be our ActionContext, and the value
stack to be the OGNL root object.
-(The value stack is a set of several objects, but to OGNL it appears to be a
single object.) Along with the value stack,
-the framework places other objects in the ActionContext, including Maps
representing the application, session,
-and request contexts. These objects coexist in the ActionContext, alongside
the value stack (our OGNL root).
+## Context
+
+The framework sets the OGNL context to be our `ActionContext`, and the
`ValueStack` to be the OGNL root object.
+(The `ValueStack` is a set of several objects, but to OGNL it appears to be a
single object). Along with the value stack,
+the framework places other objects in the `ActionContext`, including maps
representing the application, session,
+and request contexts. These objects coexist in the `ActionContext`, alongside
the value stack (our OGNL root).
```
context map---|
@@ -44,11 +46,11 @@ context map---|
|
```
-The Action instance is always pushed onto the value stack. Because the Action
is on the stack, and the stack is
-the OGNL root, references to Action properties can omit the `#` marker. But,
to access other objects in the ActionContext,
-we must use the `#` notation so OGNL knows not to look in the root object, but
for some other object in the ActionContext.
+## Referencing an Action property
-**Referencing an Action property**
+The Action instance is always pushed onto the value stack. Because the Action
is on the stack, and the stack is
+the OGNL root, references to Action properties can omit the `#` marker. But,
to access other objects in the ActionContext,
+we must use the `#` notation so OGNL knows not to look in the root object, but
for some other object in the ActionContext.
```jsp
<s:property value="postalCode"/>
@@ -62,13 +64,6 @@ Other (non-root) objects in the ActionContext can be
rendered use the `#` notati
<s:property value="#request['myRequestPropKey']"/>
```
-The ActionContext is also exposed to Action classes via a static method but
you **should not** use this approach.
-Safer is to use one of the `*Aware` interfaces.
-
-```java
-ActionContext.getContext().getSession().put("mySessionPropKey",
mySessionObject);
-```
-
You can also put expression for attributes that don't support dynamic content,
like below:
```jsp
@@ -79,17 +74,17 @@ You can also put expression for attributes that don't
support dynamic content, l
## Collections (Maps, Lists, Sets)
Dealing with Collections (Maps, Lists, and Sets) in the framework comes often,
so below please there are a few examples
-using the select tag. The [OGNL
documentation](http://commons.apache.org/proper/commons-ognl/language-guide.html#Collection_Construction)
+using tags. The [OGNL
documentation](https://github.com/orphan-oss/ognl/blob/master/docs/LanguageGuide.md#collection-construction)
also includes some examples.
-Syntax for list: `{e1,e2,e3}`. This idiom creates a List containing the String
"name1", "name2" and "name3". It also
-selects "name2" as the default value.
+Syntax for a list: `{e1, e2, e3}`. This idiom creates a List containing the
String "name1", "name2" and "name3". It also
+selects "name2" as the default value:
```jsp
<s:select label="label" name="name" list="{'name1','name2','name3'}"
value="%{'name2'}" />
```
-Syntax for map: `#{key1:value1,key2:value2}`. This idiom creates a map that
maps the string "foo" to the string
+Syntax for a map: `#{key1:value1, key2:value2}`. This idiom creates a map that
maps the string "foo" to the string
"foovalue" and "bar" to the string "barvalue":
```jsp
@@ -114,7 +109,7 @@ To determine if an element exists in a Collection, use the
operations `in` and `
</s:else>
```
-To select a subset of a collection (called projection), use a wildcard within
the collection.
+To select a subset of a collection, use a wildcard within the collection.
- `?` - All elements matching the selection logic
- `^` - Only the first element matching the selection logic
@@ -123,34 +118,7 @@ To select a subset of a collection (called projection),
use a wildcard within th
To obtain a subset of just male relatives from the object person:
```
-person.relatives.{? #this.gender == 'male'}
-```
-
-## Lambda Expressions
-
-OGNL supports basic lamba expression syntax enabling you to write simple
functions.
-(Dedicated to all you math majors who didn't think you would ever see this one
again.)
-
-Fibonacci:
-```
-if n == 0
- return 0;
- elseif n == 1
- return 1;
- else
- return fib(n-2) + fib(n-1);
-
-
- fib(0) = 0
- fib(1) = 1
- fib(11) = 89
- ```
-
-**How the expression works**
-
-> The lambda expression is everything inside the square brackets. The `#this`
variable holds the argument to the expression,
-> which in the following example is the number 11 (the code after the
square-bracketed lamba expression, `#fib(11)`).
-
-```jsp
-<s:property value="#fib =:[#this==0 ? 0 : #this==1 ? 1 :
#fib(#this-2)+#fib(#this-1)], #fib(11)" />
+<s:iterator value="person.relatives.{? #this.gender == 'male'}">
+ ...
+</s:iterator>
```
