KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > dom > DOMLocatorImpl


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001, 2002 The Apache Software Foundation.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Xerces" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 1999, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package com.sun.org.apache.xerces.internal.dom;
59
60 import org.w3c.dom.DOMLocator JavaDoc;
61 import org.w3c.dom.Node JavaDoc;
62
63
64 /**
65  * <code>DOMLocatorImpl</code> is an implementaion that describes a location (e.g.
66  * where an error occured).
67  * <p>See also the <a HREF='http://www.w3.org/TR/2001/WD-DOM-Level-3-Core-20010913'>Document Object Model (DOM) Level 3 Core Specification</a>.
68  *
69  * @author Gopal Sharma, SUN Microsystems Inc.
70  * @version $Id: DOMLocatorImpl.java,v 1.8 2003/11/13 22:47:15 elena Exp $
71  */
72  
73 public class DOMLocatorImpl implements DOMLocator JavaDoc {
74
75     //
76 // Data
77 //
78
79    /**
80     * The column number where the error occured,
81     * or -1 if there is no column number available.
82     */
83    public int fColumnNumber = -1;
84
85    /**
86     * The line number where the error occured,
87     * or -1 if there is no line number available.
88     */
89    public int fLineNumber = -1;
90
91    /** related data node*/
92    public Node JavaDoc fRelatedNode = null;
93
94    /**
95     * The URI where the error occured,
96     * or null if there is no URI available.
97     */
98    public String JavaDoc fUri = null;
99
100    /**
101     * The byte offset into the input source this locator is pointing to or -1
102     * if there is no byte offset available
103     */
104    public int fByteOffset = -1;
105    
106    /**
107     * The UTF-16, as defined in [Unicode] and Amendment 1 of [ISO/IEC 10646],
108     * offset into the input source this locator is pointing to or -1 if there
109     * is no UTF-16 offset available.
110     */
111    public int fUtf16Offset = -1;
112            
113    //
114 // Constructors
115 //
116
117    public DOMLocatorImpl(){
118    }
119
120    public DOMLocatorImpl (int lineNumber, int columnNumber, String JavaDoc uri ){
121     fLineNumber = lineNumber ;
122     fColumnNumber = columnNumber ;
123     fUri = uri;
124    } // DOMLocatorImpl (int lineNumber, int columnNumber, String uri )
125
126    public DOMLocatorImpl (int lineNumber, int columnNumber, int byteoffset, Node JavaDoc relatedData, String JavaDoc uri ){
127     fLineNumber = lineNumber ;
128     fColumnNumber = columnNumber ;
129     fByteOffset = byteoffset ;
130     fRelatedNode = relatedData ;
131     fUri = uri;
132    } // DOMLocatorImpl (int lineNumber, int columnNumber, int offset, Node errorNode, String uri )
133
134    public DOMLocatorImpl (int lineNumber, int columnNumber, int byteoffset, Node JavaDoc relatedData, String JavaDoc uri, int utf16Offsert ){
135     fLineNumber = lineNumber ;
136     fColumnNumber = columnNumber ;
137     fByteOffset = byteoffset ;
138     fRelatedNode = relatedData ;
139     fUri = uri;
140     fUtf16Offset = utf16Offsert;
141    } // DOMLocatorImpl (int lineNumber, int columnNumber, int offset, Node errorNode, String uri )
142
143
144   /**
145    * The line number where the error occured, or -1 if there is no line
146    * number available.
147    */
148    public int getLineNumber(){
149     return fLineNumber;
150    }
151
152   /**
153    * The column number where the error occured, or -1 if there is no column
154    * number available.
155    */
156   public int getColumnNumber(){
157     return fColumnNumber;
158   }
159
160
161   /**
162    * The URI where the error occured, or null if there is no URI available.
163    */
164   public String JavaDoc getUri(){
165     return fUri;
166   }
167
168
169   public Node JavaDoc getRelatedNode(){
170     return fRelatedNode;
171   }
172   
173
174   /**
175    * The byte offset into the input source this locator is pointing to or -1
176    * if there is no byte offset available
177    */
178   public int getByteOffset(){
179     return fByteOffset;
180   }
181
182   /**
183    * The UTF-16, as defined in [Unicode] and Amendment 1 of [ISO/IEC 10646],
184    * offset into the input source this locator is pointing to or -1 if there
185    * is no UTF-16 offset available.
186    */
187   public int getUtf16Offset(){
188     return fUtf16Offset;
189   }
190
191 }// class DOMLocatorImpl
192
Popular Tags