~vcs-imports/xena/trunk

« back to all changes in this revision

Viewing changes to src/org/jaxen/expr/PathExpr.java

  • Committer: matthewoliver
  • Date: 2009-12-10 03:18:07 UTC
  • Revision ID: vcs-imports@canonical.com-20091210031807-l086qguzdlljtkl9
Merged Xena Testing into Xena Stable for the Xena 5 release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 * $Header: /cvsroot/xena/xena/src/org/jaxen/expr/PathExpr.java,v 1.2 2009/12/10 03:18:14 matthewoliver Exp $
 
3
 * $Revision: 1.2 $
 
4
 * $Date: 2009/12/10 03:18:14 $
 
5
 *
 
6
 * ====================================================================
 
7
 *
 
8
 * Copyright 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 are
 
13
 * met:
 
14
 * 
 
15
 *   * Redistributions of source code must retain the above copyright
 
16
 *     notice, this list of conditions and the following disclaimer.
 
17
 * 
 
18
 *   * Redistributions in binary form must reproduce the above copyright
 
19
 *     notice, this list of conditions and the following disclaimer in the
 
20
 *     documentation and/or other materials provided with the distribution.
 
21
 * 
 
22
 *   * Neither the name of the Jaxen Project nor the names of its
 
23
 *     contributors may be used to endorse or promote products derived 
 
24
 *     from this software without specific prior written permission.
 
25
 * 
 
26
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 
27
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 
28
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 
29
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 
30
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 
31
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 
32
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 
33
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 
34
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 
35
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 
36
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
37
 *
 
38
 * ====================================================================
 
39
 * This software consists of voluntary contributions made by many 
 
40
 * individuals on behalf of the Jaxen Project and was originally 
 
41
 * created by bob mcwhirter <bob@werken.com> and 
 
42
 * James Strachan <jstrachan@apache.org>.  For more information on the 
 
43
 * Jaxen Project, please see <http://www.jaxen.org/>.
 
44
 * 
 
45
 * $Id: PathExpr.java,v 1.2 2009/12/10 03:18:14 matthewoliver Exp $
 
46
 */
 
47
 
 
48
 
 
49
 
 
50
package org.jaxen.expr;
 
51
 
 
52
/**
 
53
 * Represents an XPath path expression.
 
54
 * This is production 19 in the 
 
55
 * <a href="http://www.w3.org/TR/xpath#NT-PathExpr">XPath 1.0 specification</a>:
 
56
 * 
 
57
 * <pre>[19] PathExpr ::= LocationPath    
 
58
 *                | FilterExpr    
 
59
 *                | FilterExpr '/' RelativeLocationPath   
 
60
 *                | FilterExpr '//' RelativeLocationPath  </pre>
 
61
 * 
 
62
 */
 
63
public interface PathExpr extends Expr
 
64
{
 
65
    
 
66
    /**
 
67
     * Returns the filter expression that starts the path expression.
 
68
     * 
 
69
     * @return the filter expression that starts the path expression
 
70
     */
 
71
    Expr getFilterExpr();
 
72
    
 
73
    
 
74
    /**
 
75
     * Changes the expression's filter expression.
 
76
     * 
 
77
     * @param filterExpr the new filter expression
 
78
     */
 
79
    void setFilterExpr(Expr filterExpr);
 
80
 
 
81
    /**
 
82
     * Returns the location path part of this path expression.
 
83
     * 
 
84
     * @return the location path part of this expression
 
85
     */
 
86
    LocationPath getLocationPath();
 
87
    
 
88
}