1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.scxml2.env.jexl;
18
19 import org.apache.commons.scxml2.Builtin;
20 import org.apache.commons.scxml2.SCXMLExpressionException;
21 import org.apache.commons.scxml2.XPathBuiltin;
22
23 /**
24 * Global JEXL namespace functor, providing the standard SCXML In() operator and the Commons SCXML extensions
25 * for Data() and Location() to support XPath datamodel access.
26 */
27 public final class JexlBuiltin {
28 /**
29 * The context currently in use for evaluation.
30 */
31 private final JexlContext context;
32
33 /**
34 * Creates a new instance, wraps the context.
35 * @param ctxt the context in use
36 */
37 public JexlBuiltin(final JexlContext ctxt) {
38 context = ctxt;
39 }
40
41 /**
42 * Provides the SCXML standard In() predicate for SCXML documents.
43 * @param state The State ID to compare with
44 * @return true if this state is currently active
45 */
46 public boolean In(final String state) {
47 return Builtin.isMember(context, state);
48 }
49
50 /**
51 * Provides the Commons SCXML Data() predicate extension for SCXML documents.
52 * @param expression the XPath expression
53 * @return the data matching the expression
54 */
55 public Object Data(final String expression) throws SCXMLExpressionException {
56 return XPathBuiltin.eval(context, expression);
57 }
58
59 /**
60 * Provides the Commons SCXML Location() predicate extension for SCXML documents.
61 * @param expression the XPath expression
62 * @return the location matching the expression
63 */
64 public Object Location(final String expression) throws SCXMLExpressionException {
65 return XPathBuiltin.evalLocation(context, expression);
66 }
67 }