-
Notifications
You must be signed in to change notification settings - Fork 0
/
ognl-fnognl.html
executable file
·260 lines (249 loc) · 19.9 KB
/
ognl-fnognl.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by Apache Maven Doxia Site Renderer 1.3 at May 19, 2012 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>op4j: bending the Java spoon - Functions: FnOgnl</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="Date-Revision-yyyymmdd" content="20120519" />
<meta http-equiv="Content-Language" content="en" />
</head>
<body class="composite">
<div id="banner">
<a href="./" id="bannerLeft">
<img src="images/op4j_logo.png" alt="op4j: bending the Java spoon" />
</a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
<span id="publishDate">Last Published: 19 May 2012</span>
| <span id="projectVersion">Version: 1.2</span>
</div>
<div class="xright"> <a href="index.html" title="Main">Main</a>
|
<a href="download.html" title="Download">Download</a>
|
<a href="https://www.bendingthejavaspoon.com" class="externalLink" title="Example Recipes Blog">Example Recipes Blog</a>
|
<a href="https://github.com/op4j/op4j.github.com/issues" class="externalLink" title="Issue Tracking">Issue Tracking</a>
|
<a href="apidocs/index.html" title="Javadoc">Javadoc</a>
|
<a href="https://github.com/op4j" class="externalLink" title="Github Project Page">Github Project Page</a>
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>The op4j Project</h5>
<ul>
<li class="none">
<a href="index.html" title="· Main">· Main</a>
</li>
<li class="none">
<a href="download.html" title="· Download">· Download</a>
</li>
<li class="none">
<a href="maveninfo.html" title="· Maven Info">· Maven Info</a>
</li>
<li class="none">
<a href="dependencies.html" title="· Dependencies">· Dependencies</a>
</li>
<li class="none">
<a href="https://github.com/op4j" class="externalLink" title="· Github Repository">· Github Repository</a>
</li>
<li class="none">
<a href="https://www.bendingthejavaspoon.com" class="externalLink" title="· Example Recipes">· Example Recipes</a>
</li>
<li class="none">
<a href="https://github.com/op4j/op4j.github.com/issues" class="externalLink" title="· Issue Tracking">· Issue Tracking</a>
</li>
<li class="expanded">
<a href="#" title="· Documentation">· Documentation</a>
<ul>
<li class="none">
<a href="basics.html" title="· The Basics">· The Basics</a>
</li>
<li class="expanded">
<a href="#" title="· Working with...">· Working with...</a>
<ul>
<li class="none">
<a href="arrays.html" title="· Arrays">· Arrays</a>
</li>
<li class="none">
<a href="lists.html" title="· Lists">· Lists</a>
</li>
<li class="none">
<a href="maps.html" title="· Maps">· Maps</a>
</li>
<li class="none">
<a href="sets.html" title="· Sets">· Sets</a>
</li>
<li class="none">
<a href="generic.html" title="· Any object (generic)">· Any object (generic)</a>
</li>
</ul>
</li>
<li class="expanded">
<a href="#" title="· Functions">· Functions</a>
<ul>
<li class="none">
<a href="functions.html" title="· About Functions">· About Functions</a>
</li>
<li class="none">
<a href="call.html" title="· Call">· Call</a>
</li>
<li class="none">
<a href="get.html" title="· Get">· Get</a>
</li>
<li class="none">
<a href="fnfunc.html" title="· FnFunc">· FnFunc</a>
</li>
<li class="none">
<a href="fnboolean.html" title="· FnBoolean">· FnBoolean</a>
</li>
<li class="none">
<a href="fncalendar.html" title="· FnCalendar">· FnCalendar</a>
</li>
<li class="none">
<a href="fndate.html" title="· FnDate">· FnDate</a>
</li>
<li class="none">
<a href="fnobject.html" title="· FnObject">· FnObject</a>
</li>
<li class="none">
<a href="fnstring.html" title="· FnString">· FnString</a>
</li>
<li class="expanded">
<a href="#" title="· Numbers">· Numbers</a>
<ul>
<li class="none">
<a href="fnnumber.html" title="· FnNumber">· FnNumber</a>
</li>
<li class="none">
<a href="fnbigdecimal.html" title="· FnBigDecimal">· FnBigDecimal</a>
</li>
<li class="none">
<a href="fnbiginteger.html" title="· FnBigInteger">· FnBigInteger</a>
</li>
<li class="none">
<a href="fninteger.html" title="· FnInteger">· FnInteger</a>
</li>
<li class="none">
<a href="fnlong.html" title="· FnLong">· FnLong</a>
</li>
<li class="none">
<a href="fnfloat.html" title="· FnFloat">· FnFloat</a>
</li>
<li class="none">
<a href="fndouble.html" title="· FnDouble">· FnDouble</a>
</li>
<li class="none">
<a href="fndouble.html" title="· FnShort">· FnShort</a>
</li>
</ul>
</li>
<li class="expanded">
<a href="#" title="· Structures">· Structures</a>
<ul>
<li class="none">
<a href="fnarray.html" title="· FnArray">· FnArray</a>
</li>
<li class="none">
<a href="fnlist.html" title="· FnList">· FnList</a>
</li>
<li class="none">
<a href="fnmap.html" title="· FnMap">· FnMap</a>
</li>
<li class="none">
<a href="fnset.html" title="· FnSet">· FnSet</a>
</li>
<li class="none">
<a href="fntuple.html" title="· FnTuple">· FnTuple</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="none">
<a href="apidocs/op4j/index.html" title="· Javadoc">· Javadoc</a>
</li>
<li class="none">
<a href="faq.html" title="· FAQ">· FAQ</a>
</li>
</ul>
</li>
<li class="none">
<a href="license.html" title="· License">· License</a>
</li>
<li class="none">
<a href="team.html" title="· Team">· Team</a>
</li>
</ul>
<ul>
<li class="expanded">
<a href="ognl-about.html" title="· op4j-ognl">· op4j-ognl</a>
<ul>
<li class="expanded">
<a href="#" title="· Functions">· Functions</a>
<ul>
<li class="none">
<strong>· FnOgnl</strong>
</li>
</ul>
</li>
<li class="none">
<a href="apidocs/op4j-ognl/index.html" title="· Javadoc">· Javadoc</a>
</li>
</ul>
</li>
<li class="collapsed">
<a href="jodatime-about.html" title="· op4j-jodatime">· op4j-jodatime</a>
</li>
</ul>
<a href="https://maven.apache.org" title="Built with Maven 2" class="poweredBy">
<img class="poweredBy" alt="Built with Maven 2" src="https://maven.apache.org/images/logos/maven-feather.png" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Functions: FnOgnl<a name="Functions:_FnOgnl"></a></h2><p><tt>org.op4j.ognl.functions.FnOgnl</tt> is a special functions hub class which allows the execution of OGNL (Object-Graph Navigation Language) expressions on target objects.</p><p>Here is an example: Imagine your application has a <tt>User</tt> class which contains a <tt>getName()</tt> method, returning a String. Let's get the names of all the users in a list:</p><div class="source"><pre>List<User> users = ...;
List<String> userNames = Op.on(users).map(FnOgnl.evalForString("name")).get();
</pre></div><p>The <i>evalForX(...)</i> methods in the <tt>FnOgnl</tt> class give you access to the following functions:</p><table border="0" class="bodyTable"><tr class="a"><td align="left"><b>Method</b></td><td align="left"><b>Returned function type</b></td></tr><tr class="b"><td align="left"><tt>evalForBigDecimal(...)</tt></td><td align="left"><tt>Function<Object,BigDecimal></tt></td></tr><tr class="a"><td align="left"><tt>evalForBigInteger(...)</tt></td><td align="left"><tt>Function<Object,BigInteger></tt></td></tr><tr class="b"><td align="left"><tt>evalForBoolean(...)</tt></td><td align="left"><tt>Function<Object,Boolean></tt></td></tr><tr class="a"><td align="left"><tt>evalForByte(...)</tt></td><td align="left"><tt>Function<Object,Byte></tt></td></tr><tr class="b"><td align="left"><tt>evalForCalendar(...)</tt></td><td align="left"><tt>Function<Object,Calendar></tt></td></tr><tr class="a"><td align="left"><tt>evalForCharacter(...)</tt></td><td align="left"><tt>Function<Object,Character></tt></td></tr><tr class="b"><td align="left"><tt>evalForDate(...)</tt></td><td align="left"><tt>Function<Object,Date></tt></td></tr><tr class="a"><td align="left"><tt>evalForDouble(...)</tt></td><td align="left"><tt>Function<Object,Double></tt></td></tr><tr class="b"><td align="left"><tt>evalForFloat(...)</tt></td><td align="left"><tt>Function<Object,Float></tt></td></tr><tr class="a"><td align="left"><tt>evalForInteger(...)</tt></td><td align="left"><tt>Function<Object,Integer></tt></td></tr><tr class="b"><td align="left"><tt>evalForLong(...)</tt></td><td align="left"><tt>Function<Object,Long></tt></td></tr><tr class="a"><td align="left"><tt>evalForObject(...)</tt></td><td align="left"><tt>Function<Object,Object></tt></td></tr><tr class="b"><td align="left"><tt>evalForShort(...)</tt></td><td align="left"><tt>Function<Object,Short></tt></td></tr><tr class="a"><td align="left"><tt>evalForString(...)</tt></td><td align="left"><tt>Function<Object,String></tt></td></tr><tr class="b"><td align="left"><tt>evalFor(Type<T>,...)</tt></td><td align="left"><tt>Function<Object,T></tt></td></tr><tr class="a"><td align="left"><tt>evalForArrayOf(Type<T>,...)</tt></td><td align="left"><tt>Function<Object,T[]></tt></td></tr><tr class="b"><td align="left"><tt>evalForArrayOfString(...)</tt></td><td align="left"><tt>Function<Object,String[]></tt></td></tr><tr class="a"><td align="left"><tt>evalForListOf(Type<T>,...)</tt></td><td align="left"><tt>Function<Object,List<T>></tt></td></tr><tr class="b"><td align="left"><tt>evalForListOfString(...)</tt></td><td align="left"><tt>Function<Object,List<String>></tt></td></tr><tr class="a"><td align="left"><tt>evalForSetOf(Type<T>,...)</tt></td><td align="left"><tt>Function<Object,Set<T>></tt></td></tr><tr class="b"><td align="left"><tt>evalForSetOfString(...)</tt></td><td align="left"><tt>Function<Object,Set<String>></tt></td></tr></table><p>There also exist more convenient abbreviated methods, which are:</p><table border="0" class="bodyTable"><tr class="a"><td align="left"><b>Method</b></td><td align="left"><b>Returned function type</b></td></tr><tr class="b"><td align="left"><tt>bigDecimal(...)</tt></td><td align="left"><tt>Function<Object,BigDecimal></tt></td></tr><tr class="a"><td align="left"><tt>bigInteger(...)</tt></td><td align="left"><tt>Function<Object,BigInteger></tt></td></tr><tr class="b"><td align="left"><tt>bool(...)</tt></td><td align="left"><tt>Function<Object,Boolean></tt></td></tr><tr class="a"><td align="left"><tt>calendar(...)</tt></td><td align="left"><tt>Function<Object,Calendar></tt></td></tr><tr class="b"><td align="left"><tt>c(...)</tt></td><td align="left"><tt>Function<Object,Character></tt></td></tr><tr class="a"><td align="left"><tt>date(...)</tt></td><td align="left"><tt>Function<Object,Date></tt></td></tr><tr class="b"><td align="left"><tt>d(...)</tt></td><td align="left"><tt>Function<Object,Double></tt></td></tr><tr class="a"><td align="left"><tt>f(...)</tt></td><td align="left"><tt>Function<Object,Float></tt></td></tr><tr class="b"><td align="left"><tt>i(...)</tt></td><td align="left"><tt>Function<Object,Integer></tt></td></tr><tr class="a"><td align="left"><tt>l(...)</tt></td><td align="left"><tt>Function<Object,Long></tt></td></tr><tr class="b"><td align="left"><tt>obj(...)</tt></td><td align="left"><tt>Function<Object,Object></tt></td></tr><tr class="a"><td align="left"><tt>shr(...)</tt></td><td align="left"><tt>Function<Object,Short></tt></td></tr><tr class="b"><td align="left"><tt>s(...)</tt></td><td align="left"><tt>Function<Object,String></tt></td></tr><tr class="a"><td align="left"><tt>obj(Type<T>,...)</tt></td><td align="left"><tt>Function<Object,T></tt></td></tr><tr class="b"><td align="left"><tt>arrayOf(Type<T>)</tt></td><td align="left"><tt>Function<Object,T[]></tt></td></tr><tr class="a"><td align="left"><tt>arrayOfString()</tt></td><td align="left"><tt>Function<Object,String[]></tt></td></tr><tr class="b"><td align="left"><tt>listOf(Type<T>)</tt></td><td align="left"><tt>Function<Object,List<T>></tt></td></tr><tr class="a"><td align="left"><tt>listOfString()</tt></td><td align="left"><tt>Function<Object,List<String>></tt></td></tr><tr class="b"><td align="left"><tt>setOf(Type<T>)</tt></td><td align="left"><tt>Function<Object,Set<T>></tt></td></tr><tr class="a"><td align="left"><tt>setOfString()</tt></td><td align="left"><tt>Function<Object,Set<String>></tt></td></tr></table><p>Every <i>evalFor(...)</i> or abbreviated method can be passed parameters, and these can be accessed from the OGNL expression as an array called <tt>#param</tt>: </p><div class="source"><pre>List<User> users = ...;
Group group = ...;
...
List<User> usersInGroup =
Op.on(users).removeAllFalse(FnOgnl.evalForBoolean("isInGroup(#param[0])", group).get();
</pre></div><p>Also the iteration index can be accessed when iterating a structure (array, list, map or set), by means of an expression variable called <tt>#index</tt>:</p><div class="source"><pre>List<User> users = ...;
...
List<String> indexedNames =
Op.on(users).forEach().exec(FnOgnl.s("#index + '$' + #target.name")).get();
</pre></div><p><tt>#target</tt> is the target object itself. This expression variable is useful when the OGNL expression does not use the target object as an expression root (as was the case with, for example, the <tt>"name"</tt> expression in the first example above).</p></div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">
Copyright © 2012
<a href="https://www.op4j.org">The OP4J team</a>.
All Rights Reserved.
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>