1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
/* IXMLBuilder.java NanoXML/Java
*
* $Revision: 1.3 $
* $Date: 2002/01/04 21:03:28 $
* $Name: RELEASE_2_2_1 $
*
* This file is part of NanoXML 2 for Java.
* Copyright (C) 2000-2002 Marc De Scheemaecker, All Rights Reserved.
*
* This software is provided 'as-is', without any express or implied warranty.
* In no event will the authors be held liable for any damages arising from the
* use of this software.
*
* Permission is granted to anyone to use this software for any purpose,
* including commercial applications, and to alter it and redistribute it
* freely, subject to the following restrictions:
*
* 1. The origin of this software must not be misrepresented; you must not
* claim that you wrote the original software. If you use this software in
* a product, an acknowledgment in the product documentation would be
* appreciated but is not required.
*
* 2. Altered source versions must be plainly marked as such, and must not be
* misrepresented as being the original software.
*
* 3. This notice may not be removed or altered from any source distribution.
*/
package net.n3.nanoxml;
import java.io.Reader;
import java.io.IOException;
/**
* NanoXML uses IXMLBuilder to construct the XML data structure it retrieved
* from its data source. You can supply your own builder or you can use the
* default builder of NanoXML.
* <P>
* If a method of the builder throws an exception, the parsing is aborted and
* {@link net.n3.nanoxml.IXMLParser#parse} throws an
* {@link net.n3.nanoxml.XMLException} which encasulates the original
* exception.
*
* @see net.n3.nanoxml.IXMLParser
*
* @author Marc De Scheemaecker
* @version $Name: RELEASE_2_2_1 $, $Revision: 1.3 $
*/
public interface IXMLBuilder
{
/**
* This method is called before the parser starts processing its input.
*
* @param systemID the system ID of the XML data source.
* @param lineNr the line on which the parsing starts.
*
* @throws java.lang.Exception
* If an exception occurred while processing the event.
*/
public void startBuilding(String systemID,
int lineNr)
throws Exception;
/**
* This method is called when a processing instruction is encountered.
* A PI with a reserved target ("xml" with any case) is never reported.
*
* @param target the processing instruction target.
* @param reader the method can retrieve the parameter of the PI from this
* reader. You may close the reader before reading all its
* data and you cannot read too much data.
*
* @throws java.lang.Exception
* If an exception occurred while processing the event.
*/
public void newProcessingInstruction(String target,
Reader reader)
throws Exception;
/**
* This method is called when a new XML element is encountered.
*
* @see #endElement
*
* @param name the name of the element.
* @param nsPrefix the prefix used to identify the namespace. If no
* namespace has been specified, this parameter is null.
* @param nsURI the URI associated with the namespace. If no
* namespace has been specified, or no URI is
* associated with nsPrefix, this parameter is null.
* @param systemID the system ID of the XML data source.
* @param lineNr the line in the source where the element starts.
*
* @throws java.lang.Exception
* If an exception occurred while processing the event.
*/
public void startElement(String name,
String nsPrefix,
String nsURI,
String systemID,
int lineNr)
throws Exception;
/**
* This method is called when a new attribute of an XML element is
* encountered.
*
* @param key the key (name) of the attribute.
* @param nsPrefix the prefix used to identify the namespace. If no
* namespace has been specified, this parameter is null.
* @param nsURI the URI associated with the namespace. If no
* namespace has been specified, or no URI is
* associated with nsPrefix, this parameter is null.
* @param value the value of the attribute.
* @param type the type of the attribute. If no type is known,
* "CDATA" is returned.
*
* @throws java.lang.Exception
* If an exception occurred while processing the event.
*/
public void addAttribute(String key,
String nsPrefix,
String nsURI,
String value,
String type)
throws Exception;
/**
* This method is called when the attributes of an XML element have been
* processed.
*
* @see #startElement
* @see #addAttribute
*
* @param name the name of the element.
* @param nsPrefix the prefix used to identify the namespace. If no
* namespace has been specified, this parameter is null.
* @param nsURI the URI associated with the namespace. If no
* namespace has been specified, or no URI is
* associated with nsPrefix, this parameter is null.
*
* @throws java.lang.Exception
* If an exception occurred while processing the event.
*/
public void elementAttributesProcessed(String name,
String nsPrefix,
String nsURI)
throws Exception;
/**
* This method is called when the end of an XML elemnt is encountered.
*
* @see #startElement
*
* @param name the name of the element.
* @param nsPrefix the prefix used to identify the namespace. If no
* namespace has been specified, this parameter is null.
* @param nsURI the URI associated with the namespace. If no
* namespace has been specified, or no URI is
* associated with nsPrefix, this parameter is null.
*
* @throws java.lang.Exception
* If an exception occurred while processing the event.
*/
public void endElement(String name,
String nsPrefix,
String nsURI)
throws Exception;
/**
* This method is called when a PCDATA element is encountered. A Java
* reader is supplied from which you can read the data. The reader will
* only read the data of the element. You don't need to check for
* boundaries. If you don't read the full element, the rest of the data
* is skipped. You also don't have to care about entities: they are
* resolved by the parser.
*
* @param reader the method can retrieve the data from this reader. You
* may close the reader before reading all its data and you
* cannot read too much data.
* @param systemID the system ID of the XML data source.
* @param lineNr the line in the source where the element starts.
*
* @throws java.lang.Exception
* If an exception occurred while processing the event.
*/
public void addPCData(Reader reader,
String systemID,
int lineNr)
throws Exception;
/**
* Returns the result of the building process. This method is called just
* before the <I>parse</I> method of IXMLParser returns.
*
* @see net.n3.nanoxml.IXMLParser#parse
*
* @return the result of the building process.
*
* @throws java.lang.Exception
* If an exception occurred while processing the event.
*/
public Object getResult()
throws Exception;
}
|
