KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jdom > contrib > input > LineNumberSAXBuilder


1 /*--
2
3  $Id: LineNumberSAXBuilder.java,v 1.3 2004/02/06 09:57:48 jhunter Exp $
4
5  Copyright (C) 2004 Jason Hunter & Brett McLaughlin.
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 disclaimer that follows
17     these conditions in the documentation and/or other materials
18     provided with the distribution.
19
20  3. The name "JDOM" must not be used to endorse or promote products
21     derived from this software without prior written permission. For
22     written permission, please contact <request_AT_jdom_DOT_org>.
23
24  4. Products derived from this software may not be called "JDOM", nor
25     may "JDOM" appear in their name, without prior written permission
26     from the JDOM Project Management <request_AT_jdom_DOT_org>.
27
28  In addition, we request (but do not require) that you include in the
29  end-user documentation provided with the redistribution and/or in the
30  software itself an acknowledgement equivalent to the following:
31      "This product includes software developed by the
32       JDOM Project (http://www.jdom.org/)."
33  Alternatively, the acknowledgment may be graphical using the logos
34  available at http://www.jdom.org/images/logos.
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 JDOM AUTHORS OR THE PROJECT
40  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  This software consists of voluntary contributions made by many
50  individuals on behalf of the JDOM Project and was originally
51  created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
52  Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
53  on the JDOM Project, please see <http://www.jdom.org/>.
54
55  */
56
57  package org.jdom.contrib.input;
58
59 import org.jdom.Element;
60 import org.jdom.Namespace;
61 import org.jdom.DefaultJDOMFactory;
62 import org.jdom.JDOMFactory;
63 import org.jdom.input.SAXBuilder;
64 import org.jdom.input.SAXHandler;
65 import org.xml.sax.Attributes JavaDoc;
66 import org.xml.sax.Locator JavaDoc;
67 import org.xml.sax.SAXException JavaDoc;
68
69 /**
70  * This builder works in parallell with {@link LineNumberElement}
71  * to provide each element with information on its beginning and
72  * ending line number in the corresponding source.
73  * This only works for SAX parsers that supply that information, and
74  * since this is optional, there are no guarantees.
75  * <p>
76  * Note that this builder always creates its own for each
77  * build, thereby cancelling any previous call to setFactory.
78  * <p>
79  * All elements created are instances of {@link LineNumberElement}.
80  * No other construct currently receive line number information.
81  *
82  * @author Per Norrman
83  *
84  */
85 public class LineNumberSAXBuilder extends SAXBuilder
86 {
87     protected SAXHandler createContentHandler()
88     {
89         return new MySAXHandler(new MyFactory());
90     }
91
92     private class MyFactory extends DefaultJDOMFactory
93     {
94
95         public Element element(String JavaDoc name)
96         {
97             return new LineNumberElement(name);
98         }
99
100         public Element element(String JavaDoc name, String JavaDoc prefix, String JavaDoc uri)
101         {
102             return new LineNumberElement(name, prefix, uri);
103         }
104
105         public Element element(String JavaDoc name, Namespace namespace)
106         {
107             return new LineNumberElement(name, namespace);
108         }
109         
110         public Element element(String JavaDoc name, String JavaDoc uri)
111         {
112             return new LineNumberElement(name, uri);
113         }
114
115     }
116
117     private class MySAXHandler extends SAXHandler
118     {
119
120         public MySAXHandler(JDOMFactory f)
121         {
122             super(f);
123         }
124
125         /** override */
126         public void startElement(
127             String JavaDoc arg0,
128             String JavaDoc arg1,
129             String JavaDoc arg2,
130             Attributes JavaDoc arg3)
131             throws SAXException JavaDoc
132         {
133             super.startElement(arg0, arg1, arg2, arg3);
134             Locator JavaDoc l = getDocumentLocator();
135             if (l != null)
136             {
137                 ((LineNumberElement) getCurrentElement()).setStartLine(
138                     l.getLineNumber());
139             }
140         }
141
142         /** override */
143         public void endElement(String JavaDoc arg0, String JavaDoc arg1, String JavaDoc arg2)
144             throws SAXException JavaDoc
145         {
146             Locator JavaDoc l = getDocumentLocator();
147             if (l != null)
148             {
149                 ((LineNumberElement) getCurrentElement()).setEndLine(
150                     l.getLineNumber());
151             }
152
153             super.endElement(arg0, arg1, arg2);
154         }
155
156     }
157
158 }
159
Popular Tags