1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.kernel.xml;
24  
25  import java.io.IOException;
26  import java.io.Writer;
27  
28  import java.util.List;
29  
30  /**
31   * <a href="Node.java.html"><b><i>View Source</i></b></a>
32   *
33   * @author Brian Wing Shun Chan
34   *
35   */
36  public interface Node {
37  
38      public String asXML();
39  
40      public Node asXPathResult(Element parent);
41  
42      public Node detach();
43  
44      public Document getDocument();
45  
46      public String getName();
47  
48      public Element getParent();
49  
50      public String getPath();
51  
52      public String getPath(Element context);
53  
54      public String getStringValue();
55  
56      public String getText();
57  
58      public String getUniquePath();
59  
60      public String getUniquePath(Element context);
61  
62      public boolean hasContent();
63  
64      public boolean isReadOnly();
65  
66      public boolean matches(String xpathExpression);
67  
68      public Number numberValueOf(String xpathExpression);
69  
70      public List<Node> selectNodes(String xpathExpression);
71  
72      public List<Node> selectNodes(
73          String xpathExpression, String comparisonXPathExpression);
74  
75      public List<Node> selectNodes(
76          String xpathExpression, String comparisonXPathExpression,
77          boolean removeDuplicates);
78  
79      public Object selectObject(String xpathExpression);
80  
81      public Node selectSingleNode(String xpathExpression);
82  
83      public void setName(String name);
84  
85      public void setText(String text);
86  
87      public boolean supportsParent();
88  
89      public String valueOf(String xpathExpression);
90  
91      public void write(Writer writer) throws IOException;
92  
93  }