001: /*
002: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
003: *
004: * This file is part of Resin(R) Open Source
005: *
006: * Each copy or derived work must preserve the copyright notice and this
007: * notice unmodified.
008: *
009: * Resin Open Source is free software; you can redistribute it and/or modify
010: * it under the terms of the GNU General Public License as published by
011: * the Free Software Foundation; either version 2 of the License, or
012: * (at your option) any later version.
013: *
014: * Resin Open Source is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
017: * of NON-INFRINGEMENT. See the GNU General Public License for more
018: * details.
019: *
020: * You should have received a copy of the GNU General Public License
021: * along with Resin Open Source; if not, write to the
022: * Free SoftwareFoundation, Inc.
023: * 59 Temple Place, Suite 330
024: * Boston, MA 02111-1307 USA
025: *
026: * @author Scott Ferguson
027: */
028:
029: package com.caucho.xml;
030:
031: import com.caucho.vfs.WriteStream;
032:
033: import org.w3c.dom.Node;
034:
035: import java.io.IOException;
036:
037: /**
038: * CauchoNode extends the DOM, providing namespace support and input file
039: * support.
040: *
041: * <p>Application can print the filename and line number where the
042: * error occurred.
043: */
044: public interface CauchoNode extends Node {
045: // DOM2 compatibility for old DOM
046: public String getNamespaceURI();
047:
048: public String getPrefix();
049:
050: public String getLocalName();
051:
052: /**
053: * Returns the node's canonical name.
054: *
055: * <p>e.g. for foo:bar:baz, the prefix name might be '{/caucho/1.0}baz'
056: */
057: public String getCanonicalName();
058:
059: /**
060: * Returns the text value of the node
061: */
062: public String getTextValue();
063:
064: /**
065: * Returns the source filename of this node.
066: */
067: public String getFilename();
068:
069: /**
070: * Returns the source uri of this node.
071: */
072: public String getBaseURI();
073:
074: /**
075: * Returns the source line of this node.
076: */
077: public int getLine();
078:
079: /**
080: * Returns the source column of this node.
081: p */
082: public int getColumn();
083:
084: /**
085: * Sets the location
086: */
087: public void setLocation(String systemId, String filename, int line,
088: int column);
089:
090: /**
091: * Prints the node to a stream
092: */
093: public void print(WriteStream os) throws IOException;
094:
095: /**
096: * Pretty-prints the node to a stream
097: */
098: public void printPretty(WriteStream os) throws IOException;
099:
100: /**
101: * Prints the node as html to a stream
102: */
103: public void printHtml(WriteStream os) throws IOException;
104:
105: /**
106: * For testing...
107: */
108: public boolean checkValid() throws Exception;
109: }
|