001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.scxml2.env.xpath;
018
019import java.util.Map;
020
021import org.apache.commons.jxpath.ExpressionContext;
022import org.apache.commons.jxpath.Variables;
023import org.apache.commons.scxml2.SCXMLSystemContext;
024import org.apache.commons.scxml2.Status;
025
026/**
027 * Commons JXPath custom extension function providing the SCXML In() predicate
028 */
029public class XPathFunctions {
030
031    /**
032     * Provides the SCXML standard In() predicate for SCXML documents.
033     * @param expressionContext The context currently in use for evaluation
034     * @param state The State ID to compare with
035     * @return true if this state is currently active
036     */
037    @SuppressWarnings("unchecked")
038    public static boolean In(ExpressionContext expressionContext, String state) {
039        Variables variables = expressionContext.getJXPathContext().getVariables();
040        Map<String,Object> platformVariables = (Map<String, Object>)variables.getVariable(SCXMLSystemContext.X_KEY);
041        return ((Status)platformVariables.get(SCXMLSystemContext.STATUS_KEY)).isInState(state);
042    }
043}