View Javadoc

1   /*
2    * $Header: /home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/expr/XPathFactory.java,v 1.8 2003/09/05 04:08:48 proyal Exp $
3    * $Revision: 1.8 $
4    * $Date: 2003/09/05 04:08:48 $
5    *
6    * ====================================================================
7    *
8    * Copyright (C) 2000-2002 bob mcwhirter & James Strachan.
9    * All rights reserved.
10   *
11   * Redistribution and use in source and binary forms, with or without
12   * modification, are permitted provided that the following conditions
13   * are met:
14   *
15   * 1. Redistributions of source code must retain the above copyright
16   *    notice, this list of conditions, and the following disclaimer.
17   *
18   * 2. Redistributions in binary form must reproduce the above copyright
19   *    notice, this list of conditions, and the disclaimer that follows
20   *    these conditions in the documentation and/or other materials
21   *    provided with the distribution.
22   *
23   * 3. The name "Jaxen" must not be used to endorse or promote products
24   *    derived from this software without prior written permission.  For
25   *    written permission, please contact license@jaxen.org.
26   *
27   * 4. Products derived from this software may not be called "Jaxen", nor
28   *    may "Jaxen" appear in their name, without prior written permission
29   *    from the Jaxen Project Management (pm@jaxen.org).
30   *
31   * In addition, we request (but do not require) that you include in the
32   * end-user documentation provided with the redistribution and/or in the
33   * software itself an acknowledgement equivalent to the following:
34   *     "This product includes software developed by the
35   *      Jaxen Project (http://www.jaxen.org/)."
36   * Alternatively, the acknowledgment may be graphical using the logos
37   * available at http://www.jaxen.org/
38   *
39   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
40   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
41   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
42   * DISCLAIMED.  IN NO EVENT SHALL THE Jaxen AUTHORS OR THE PROJECT
43   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
45   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
46   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
47   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
48   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
49   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50   * SUCH DAMAGE.
51   *
52   * ====================================================================
53   * This software consists of voluntary contributions made by many
54   * individuals on behalf of the Jaxen Project and was originally
55   * created by bob mcwhirter <bob@werken.com> and
56   * James Strachan <jstrachan@apache.org>.  For more information on the
57   * Jaxen Project, please see <http://www.jaxen.org/>.
58   *
59   * $Id: XPathFactory.java,v 1.8 2003/09/05 04:08:48 proyal Exp $
60   */
61  package org.jaxen.expr;
62  
63  import org.jaxen.JaxenException;
64  import org.jaxen.saxpath.Operator;
65  
66  public interface XPathFactory extends Operator
67  {
68      XPathExpr createXPath( Expr rootExpr ) throws JaxenException;
69  
70      PathExpr createPathExpr( FilterExpr filterExpr,
71                               LocationPath locationPath ) throws JaxenException;
72  
73      LocationPath createRelativeLocationPath() throws JaxenException;
74  
75      LocationPath createAbsoluteLocationPath() throws JaxenException;
76  
77      BinaryExpr createOrExpr( Expr lhs,
78                               Expr rhs ) throws JaxenException;
79  
80      BinaryExpr createAndExpr( Expr lhs,
81                                Expr rhs ) throws JaxenException;
82  
83      BinaryExpr createEqualityExpr( Expr lhs,
84                                     Expr rhs,
85                                     int equalityOperator ) throws JaxenException;
86  
87      BinaryExpr createRelationalExpr( Expr lhs,
88                                       Expr rhs,
89                                       int relationalOperator ) throws JaxenException;
90  
91      BinaryExpr createAdditiveExpr( Expr lhs,
92                                     Expr rhs,
93                                     int additiveOperator ) throws JaxenException;
94  
95      BinaryExpr createMultiplicativeExpr( Expr lhs,
96                                           Expr rhs,
97                                           int multiplicativeOperator ) throws JaxenException;
98  
99      Expr createUnaryExpr( Expr expr,
100                           int unaryOperator ) throws JaxenException;
101 
102     UnionExpr createUnionExpr( Expr lhs,
103                                Expr rhs ) throws JaxenException;
104 
105     FilterExpr createFilterExpr( Expr expr ) throws JaxenException;
106 
107     FunctionCallExpr createFunctionCallExpr( String prefix,
108                                              String functionName ) throws JaxenException;
109 
110     NumberExpr createNumberExpr( int number ) throws JaxenException;
111 
112     NumberExpr createNumberExpr( double number ) throws JaxenException;
113 
114     LiteralExpr createLiteralExpr( String literal ) throws JaxenException;
115 
116     VariableReferenceExpr createVariableReferenceExpr( String prefix,
117                                                        String variableName ) throws JaxenException;
118 
119     Step createNameStep( int axis,
120                          String prefix,
121                          String localName ) throws JaxenException;
122 
123     Step createAllNodeStep( int axis ) throws JaxenException;
124 
125     Step createCommentNodeStep( int axis ) throws JaxenException;
126 
127     Step createTextNodeStep( int axis ) throws JaxenException;
128 
129     Step createProcessingInstructionNodeStep( int axis,
130                                               String name ) throws JaxenException;
131 
132     Predicate createPredicate( Expr predicateExpr ) throws JaxenException;
133 
134     PredicateSet createPredicateSet() throws JaxenException;
135 }