• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the  "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 /*
19  * $Id: XPathFactory.java 468655 2006-10-28 07:12:06Z minchau $
20  */
21 package org.apache.xpath;
22 
23 import javax.xml.transform.SourceLocator;
24 
25 import org.apache.xml.utils.PrefixResolver;
26 
27 /**
28  * Factory class for creating an XPath.  Implementors of XPath derivatives
29  * will need to make a derived class of this.
30  * @xsl.usage advanced
31  */
32 public interface XPathFactory
33 {
34 
35   /**
36    * Create an XPath.
37    *
38    * @param exprString The XPath expression string.
39    * @param locator The location of the expression string, mainly for diagnostic
40    *                purposes.
41    * @param prefixResolver This will be called in order to resolve prefixes
42    *        to namespace URIs.
43    * @param type One of {@link org.apache.xpath.XPath#SELECT} or
44    *             {@link org.apache.xpath.XPath#MATCH}.
45    *
46    * @return an XPath ready for execution.
47    */
create(String exprString, SourceLocator locator, PrefixResolver prefixResolver, int type)48   XPath create(String exprString, SourceLocator locator,
49                PrefixResolver prefixResolver, int type);
50 }
51