1 /*
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Intalio, Inc. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Intalio, Inc. Exolab is a registered
23 * trademark of Intalio, Inc.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 1999 (C) Intalio, Inc. All Rights Reserved.
42 *
43 * $Id$
44 */
45 package org.exolab.castor.xml.location;
46
47 import java.util.Vector;
48
49
50 /**
51 * A very simple XPath location class for use with the ValidationException. This
52 * class only supports the parent "/" operator and element names.
53 *
54 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
55 * @version $Revision$ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
56 */
57 public class XPathLocation implements Location, java.io.Serializable {
58
59 /** <code>serialVersionUID</code> TODO Write field description. */
60 private static final long serialVersionUID = 1L;
61
62 /** Our XPath, built up one String at a time. */
63 private final Vector _path = new Vector();
64
65 /** If we have reached the logical end of XPath (i.e., an attribute), set to false. */
66 private boolean _allowChildrenOrAtts = true;
67
68 /**
69 * Creates a default XPathLocation.
70 */
71 public XPathLocation() {
72 super();
73 }
74
75 /**
76 * Adds an attribute to the XPath location.
77 * @param name the name of the attribute
78 */
79 public void addAttribute(final String name) {
80 if (_allowChildrenOrAtts) {
81 _allowChildrenOrAtts = false;
82 _path.addElement("@" + name);
83 }
84 }
85
86 /**
87 * Adds the given element name as a child of the current path.
88 * @param name the name to add as a child
89 */
90 public void addChild(final String name) {
91 if (_allowChildrenOrAtts) {
92 _path.addElement(name);
93 }
94 }
95
96 /**
97 * Adds the name as a parent of the current path.
98 * @param name the name to add as a parent
99 */
100 public void addParent(final String name) {
101 _path.insertElementAt(name, 0);
102 }
103
104 /**
105 * Returns the String representation of this XPathLocation.
106 * @return the String representation of this XPathLocation.
107 */
108 public String toString() {
109 StringBuffer buf = new StringBuffer("XPATH: ");
110
111 for (int i = 0; i < _path.size(); i++) {
112 buf.append('/');
113 buf.append((String)_path.elementAt(i));
114 }
115 return buf.toString();
116 }
117
118 }