org.opengis.cite.xerces.impl.xs.AbstractPsychoPathXPath2Impl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xercesImpl-xsd11-shaded Show documentation
An XML Schema processor with preliminary support for the W3C XML Schema 1.1 Recommendation (in two parts). This artifact was sourced from the xml-schema-1.1-dev branch (r1667115) and built using JDK 7. The org.apache.xerces and org.eclipse.wst packages are relocated to avoid conflicts with other components that depend on the latest public Xerces release (2.11.0).
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.xerces.impl.xs;

import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Map;

import javax.xml.XMLConstants;

import org.apache.xerces.impl.Constants;
import org.apache.xerces.impl.xs.assertion.XSAssertImpl;
import org.apache.xerces.impl.xs.traversers.XSDHandler;
import org.apache.xerces.impl.xs.util.XS11TypeHelper;
import org.apache.xerces.util.NamespaceSupport;
import org.apache.xerces.xs.XSModel;
import org.eclipse.wst.xml.xpath2.processor.DefaultDynamicContext;
import org.eclipse.wst.xml.xpath2.processor.DefaultEvaluator;
import org.eclipse.wst.xml.xpath2.processor.DynamicContext;
import org.eclipse.wst.xml.xpath2.processor.Evaluator;
import org.eclipse.wst.xml.xpath2.processor.JFlexCupParser;
import org.eclipse.wst.xml.xpath2.processor.ResultSequence;
import org.eclipse.wst.xml.xpath2.processor.ResultSequenceFactory;
import org.eclipse.wst.xml.xpath2.processor.StaticChecker;
import org.eclipse.wst.xml.xpath2.processor.StaticNameResolver;
import org.eclipse.wst.xml.xpath2.processor.XPathParser;
import org.eclipse.wst.xml.xpath2.processor.XPathParserException;
import org.eclipse.wst.xml.xpath2.processor.ast.XPath;
import org.eclipse.wst.xml.xpath2.processor.function.FnFunctionLibrary;
import org.eclipse.wst.xml.xpath2.processor.function.XSCtrLibrary;
import org.eclipse.wst.xml.xpath2.processor.internal.Focus;
import org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType;
import org.eclipse.wst.xml.xpath2.processor.internal.types.ElementType;
import org.eclipse.wst.xml.xpath2.processor.internal.types.XSBoolean;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

/**
 * A class providing common services for XPath expression evaluation, with 'PsychoPath XPath 2.0' engine.
 * 
 * @xerces.internal
 * 
 * @author Mukul Gandhi, IBM
 * @version $Id: AbstractPsychoPathXPath2Impl.java 1300055 2012-03-13 10:19:25Z mukulg $
 */
public class AbstractPsychoPathXPath2Impl {
    
    private DynamicContext fXpath2DynamicContext = null;
    private Document fDomDoc = null;
    
    
    /*
     * Initialize the PsychoPath engine XPath 2.0 dynamic context. This also initializes the XPath engine's static
     * context, since dynamic context is inherited from the static context.
     */
    public DynamicContext initXPath2DynamicContext(XSModel schema, Document document, Map psychoPathParams) {
        
        fXpath2DynamicContext = new DefaultDynamicContext(schema, document);        
        
        // populate the 'PsychoPath XPath 2' static context, with namespace bindings derived from the XML Schema document
        NamespaceSupport xpath2NamespaceContext = (NamespaceSupport) psychoPathParams.get(Constants.XPATH2_NAMESPACE_CONTEXT);
        Boolean isCtaEvaluator = (Boolean)psychoPathParams.get(Constants.IS_CTA_EVALUATOR);
        if (isCtaEvaluator != null && isCtaEvaluator.booleanValue()) {
           // check if the call to this method came from CTA evaluator. needs special treatment for handling namespace context.
           String[] namespaceBindingInfo = xpath2NamespaceContext.getNamespaceBindingInfo();
           List prefixes = getPrefixesXS11CTA(namespaceBindingInfo);
           for (int prfxIdx = 0; prfxIdx < prefixes.size(); prfxIdx++) {
               String prefix = (String)prefixes.get(prfxIdx);
               addNamespaceBindingToXPath2DynamicContext(prefix, getURIXS11CTA(prefix, namespaceBindingInfo)); 
           }
        }
        else {
            Enumeration currPrefixes = xpath2NamespaceContext.getAllPrefixes();
            while (currPrefixes.hasMoreElements()) {
                String prefix = (String)currPrefixes.nextElement();
                addNamespaceBindingToXPath2DynamicContext(prefix, xpath2NamespaceContext.getURI(prefix));
            }
            addNamespaceBindingToXPath2DynamicContext(XMLConstants.XML_NS_PREFIX, XMLConstants.XML_NS_URI);
        }
        fXpath2DynamicContext.add_function_library(new FnFunctionLibrary());
        fXpath2DynamicContext.add_function_library(new XSCtrLibrary());        
        fDomDoc = document;
        
        return fXpath2DynamicContext;
        
    } // initXPath2DynamicContext
    
    
    /*
     * Add namespace binding to XPath 2.0 dynamic context.
     */
    protected void addNamespaceBindingToXPath2DynamicContext(String prefix, String uri) {
        fXpath2DynamicContext.add_namespace(prefix, uri);
    } // addNamespaceBindingToXPath2DynamicContext
    
    
    /*
     * Evaluate XPath expression with PsychoPath XPath2 engine.
     */
    protected boolean evaluateXPathExpr(XPath xpathObject, Element contextNode) throws Exception {
        
        StaticChecker sc = new StaticNameResolver(fXpath2DynamicContext);
        sc.check(xpathObject);       
        Evaluator xpath2Evaluator = null;
        if (contextNode != null) {            
            xpath2Evaluator = new DefaultEvaluator(fXpath2DynamicContext, fDomDoc, fDomDoc.getDocumentElement()); // for assertions and CTA, root node of XDM tree is the initial context element           
            // change focus to the top most element
            ResultSequence contextNodeResultSet = ResultSequenceFactory.create_new();
            contextNodeResultSet.add(new ElementType(contextNode, fXpath2DynamicContext.node_position(contextNode)));           
            fXpath2DynamicContext.set_focus(new Focus(contextNodeResultSet));
        }
        else {           
           xpath2Evaluator = new DefaultEvaluator(fXpath2DynamicContext, null);
        }
        
        ResultSequence resultSeq = xpath2Evaluator.evaluate(xpathObject);

        boolean result = false;
        if (resultSeq == null) {
            result = false;
        } else if (resultSeq.size() == 1) {
            AnyType rsReturn = resultSeq.get(0);
            if (rsReturn instanceof XSBoolean) {
                XSBoolean returnResultBool = (XSBoolean) rsReturn;
                result = returnResultBool.value();
            } else {
                result = false;
            }
        } else {
            result = false;
        }
        
        return result;
        
    } // evaluateXPathExpr
    
    
    /*
     * Compile an XPath string and return the compiled XPath expression.
     */
    protected XPath compileXPathStr(String xpathStr, XSAssertImpl assertImpl, XSDHandler fSchemaHandler, Element schemaContextElem) {        
        
        XPathParser xpathParser = new JFlexCupParser();
        XPath xpathObject = null;

        try {
            xpathObject = xpathParser.parse("boolean(" + xpathStr + ")", true);
        } catch (XPathParserException ex) {
            // XPath parser exception
            if (SchemaSymbols.XS11_XPATHEXPR_COMPILE_WRN_MESG_1.equals(ex.getMessage())) {               
                fSchemaHandler.reportSchemaWarning("cvc-xpath.3.13.4.2b", new Object[] {assertImpl.getTest().getXPathStr(), XS11TypeHelper.getSchemaTypeName(assertImpl.getTypeDefinition())}, schemaContextElem);
            }
            else {               
                fSchemaHandler.reportSchemaError("cvc-xpath.3.13.4.2a", new Object[] {assertImpl.getTest().getXPathStr(), XS11TypeHelper.getSchemaTypeName(assertImpl.getTypeDefinition())}, schemaContextElem);
            }
        }  

        return xpathObject;
        
    } // compileXPathStr
    
    
    /*
     * Get in-scope namespace prefixes. special handling for CTA.
     */
    private List getPrefixesXS11CTA(String[] namespaceBindingInfo) {
        List prefixes = new ArrayList();
        for (int prefixIdx = 0; prefixIdx < namespaceBindingInfo.length && namespaceBindingInfo[prefixIdx] != null; prefixIdx += 2) {
            prefixes.add(namespaceBindingInfo[prefixIdx]);
        } 
        return prefixes;
     } // getPrefixesXS11CTA
    
     
     /*
      * Get an URI for a particular in-scope namespace prefix. special handling for CTA. 
      */
     private String getURIXS11CTA(String prefix, String[] namespaceBindingInfo) {
         String uri = null;
         for (int prefixIdx = 0; prefixIdx < namespaceBindingInfo.length && namespaceBindingInfo[prefixIdx] != null; prefixIdx += 2) {
            if (prefix.equals(namespaceBindingInfo[prefixIdx])) {
                uri = namespaceBindingInfo[prefixIdx + 1];
                break;
            }
         }
         return uri;
     } // getURIXS11CTA
    
} // class AbstractPsychoPathXPath2Impl