Skip to Content

Wiki source code of WOOgnl Framework

Last modified by chuckhill on 2012/08/27 13:18
Hide last authors
Ray Kiddy 10.1 1 == Overview ==
Johann Werner 6.1 2
Pascal Robert 21.1 3 OGNL stands for "Object Graph Navigation Language", and it defines an entire family of key-value coding-like abilities. As Jonathan Rentzsch put it in his CAWUG presentation on Project WOnder, "Think: Key-Value Coding on Steroids". You can get more information on the specifics on OGNL at [[the official OGNL website>>url:http://commons.apache.org/ognl/||shape="rect"]].
Johann Werner 6.1 4
Pascal Robert 21.1 5 WOOgnl provides a framework that integrates the OGNL syntax into WO's standard binding resolution. By simply including the WOOgnl framework on your build path and preceding your binding value with a "~~", it will be interpreted by WOOgnl.
Johann Werner 6.1 6
7 Here are some examples that demonstrate just a tiny bit of the really cool things you can do:
8
Pascal Robert 21.1 9 * value="~~\"Hello Mr.\" + session.user.firstName";
10 * value="~~name.length().(#this>100?2*#this:20+#this)";
11 * value="~~#A=new NSMutableArray(),#A.addObject(name),#A";
Johann Werner 6.1 12
13 Here are some examples provided by Max Muller, WOOgnl's original author:
14
Pascal Robert 22.2 15 {{code}}// Calling methods with arguments
Ray Kiddy 10.1 16 Repetition1: WORepetition {
17 item = arrayItem;
18 list = "~sort(anArray, \"name\")";
Pascal Robert 22.2 19 } {{/code}}
Johann Werner 6.1 20
Pascal Robert 22.2 21 {{code}}// Calling static methods
Ray Kiddy 10.1 22 Repetition2: WORepetition {
23 item = arrayItem;
24 list = "~@er.extensions.ERXArrayUtilities@sortedArraySortedWithKey(anArray, \"name\")";
Pascal Robert 22.2 25 }{{/code}}
Johann Werner 6.1 26
Pascal Robert 22.2 27 {{code}}// Accessing static ivars
Ray Kiddy 10.1 28 String1: WOString {
29 value = "~@ognl.webobjects.WOOgnl@OgnlSpecialCharacters";
Pascal Robert 22.2 30 }{{/code}}
Johann Werner 6.1 31
Pascal Robert 22.2 32 {{code}}// Accessing static ivars within inner class
Pascal Robert 18.1 33 String1: WOString {
34 value = "~@ognl.webobjects.WOOgnl$MyInnerClass@OgnlSpecialCharacters";
Pascal Robert 22.2 35 }{{/code}}
Pascal Robert 18.1 36
Pascal Robert 22.2 37 {{code}}// Use of conditionals, note that every previous value of the . is
Ray Kiddy 10.1 38 // pushed into the ivar #this
39 String2: WOString {
40 value = "~name.length().(#this > 100? 2*#this : 20+#this)";
Pascal Robert 22.2 41 }{{/code}}
Johann Werner 6.1 42
Pascal Robert 22.2 43 {{code}}// String concat
Ray Kiddy 10.1 44 String3: WOString {
45 value = "~\"Hello Max \" + name";
Pascal Robert 22.2 46 } {{/code}}
Johann Werner 6.1 47
Pascal Robert 22.2 48 {{code}}// Use of set operator in. can also use in against NSArray and
Ray Kiddy 10.1 49 NSSet objects
50 String4: WOString {
51 value = "~name in {\"Main\", \"Something\"} ? \"Yes\" : \"No\"";
Pascal Robert 22.2 52 }{{/code}}
Johann Werner 6.1 53
Ray Kiddy 10.1 54 {{code}}
Johann Werner 6.1 55
yllan 16.1 56 // Variable declaration. Note that commas allow multiple actions
Ray Kiddy 10.1 57 // per expression.
58 String5: WOString {
59 value = "~#A=new com.webobjects.foundation.NSMutableArray(),#A.addObject(name), #A.addObjectsFromArray(session.languages), #A";
60 }
Johann Werner 6.1 61
yllan 16.1 62 {{/code}}
yllan 12.1 63
yllan 16.1 64 === Helper system ===
65
chuckhill 23.1 66 For more detail, check [[doc:documentation.Home.WOLips Tutorials.WOOGNL Helper Functions.WebHome]]. With these two lines in your properties file and Project WONDER,
yllan 16.1 67
68 {{code}}
69
Pascal Robert 18.1 70 ognl.helperFunctions=true
yllan 16.1 71 ognl.inlineBindings=true
72
yllan 12.1 73 {{/code}}
yllan 16.1 74
75 You can declare your own helper class like this:
76
77 {{code}}
78
79 public class StringHelper {
80 public String capitalize(String str) {
Pascal Robert 18.1 81 // ...
yllan 16.1 82 }
83 }
84
85 {{/code}}
86
87 And use that in your binding by "piping your data"
88
89 {{code}}
90
91 <wo:str value="$person.name|capitalize" />
92
93 {{/code}}