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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_06) on Mon May 15 07:33:01 EDT 2006 -->
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<TITLE>
StAXLoaderRegistry (Tuscany Core incubating-M1 API)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.tuscany.core.loader.StAXLoaderRegistry interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="StAXLoaderRegistry (Tuscany Core incubating-M1 API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StAXLoaderRegistry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Tuscany Core</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/tuscany/core/loader/StAXElementLoader.html" title="interface in org.apache.tuscany.core.loader"><B>PREV CLASS</B></A>
<A HREF="../../../../../org/apache/tuscany/core/loader/StAXPropertyFactory.html" title="interface in org.apache.tuscany.core.loader"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/tuscany/core/loader/StAXLoaderRegistry.html" target="_top"><B>FRAMES</B></A>
<A HREF="StAXLoaderRegistry.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.tuscany.core.loader</FONT>
<BR>
Interface StAXLoaderRegistry</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/tuscany/core/loader/impl/StAXLoaderRegistryImpl.html" title="class in org.apache.tuscany.core.loader.impl">StAXLoaderRegistryImpl</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>StAXLoaderRegistry</B></DL>
</PRE>
<P>
Registry for XML loaders that can parse a StAX input stream and return model objects.
<p/>
Loaders will typically be contributed to the system by any extension that needs to
handle extension specific information contained in some XML configuration file.
The loader can be contributed as a system component with an autowire reference
to this registry which is used during initialization to actually register.
</p>
This registry can also be used to parse an input stream, dispatching to the
appropriate loader for each element accepted. Loaders can call back to the
registry to load sub-elements that they are not able to handle directly.
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Rev$ $Date$</DD>
</DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> org.apache.tuscany.model.assembly.AssemblyContext</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/core/loader/StAXLoaderRegistry.html#getContext()">getContext</A></B>()</CODE>
<BR>
<B>Deprecated.</B> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> org.apache.tuscany.model.assembly.AssemblyObject</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/core/loader/StAXLoaderRegistry.html#load(javax.xml.stream.XMLStreamReader, org.apache.tuscany.core.loader.LoaderContext)">load</A></B>(javax.xml.stream.XMLStreamReader reader,
<A HREF="../../../../../org/apache/tuscany/core/loader/LoaderContext.html" title="class in org.apache.tuscany.core.loader">LoaderContext</A> loaderContext)</CODE>
<BR>
Parse the supplied XML stream dispatching to the appropriate registered loader
for each element encountered in the stream.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
<TR ALIGN="right" VALIGN="">
<TD NOWRAP><FONT SIZE="-1">
<CODE><T extends org.apache.tuscany.model.assembly.AssemblyObject>
<BR>
void</CODE></FONT></TD>
</TR>
</TABLE>
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/core/loader/StAXLoaderRegistry.html#registerLoader(javax.xml.namespace.QName, org.apache.tuscany.core.loader.StAXElementLoader)">registerLoader</A></B>(javax.xml.namespace.QName element,
<A HREF="../../../../../org/apache/tuscany/core/loader/StAXElementLoader.html" title="interface in org.apache.tuscany.core.loader">StAXElementLoader</A><T> loader)</CODE>
<BR>
Register a loader.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/core/loader/StAXLoaderRegistry.html#setContext(org.apache.tuscany.model.assembly.AssemblyContext)">setContext</A></B>(org.apache.tuscany.model.assembly.AssemblyContext context)</CODE>
<BR>
<B>Deprecated.</B> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
<TR ALIGN="right" VALIGN="">
<TD NOWRAP><FONT SIZE="-1">
<CODE><T extends org.apache.tuscany.model.assembly.AssemblyObject>
<BR>
void</CODE></FONT></TD>
</TR>
</TABLE>
</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/core/loader/StAXLoaderRegistry.html#unregisterLoader(javax.xml.namespace.QName, org.apache.tuscany.core.loader.StAXElementLoader)">unregisterLoader</A></B>(javax.xml.namespace.QName element,
<A HREF="../../../../../org/apache/tuscany/core/loader/StAXElementLoader.html" title="interface in org.apache.tuscany.core.loader">StAXElementLoader</A><T> loader)</CODE>
<BR>
Unregister a loader.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="registerLoader(javax.xml.namespace.QName, org.apache.tuscany.core.loader.StAXElementLoader)"><!-- --></A><H3>
registerLoader</H3>
<PRE>
<T extends org.apache.tuscany.model.assembly.AssemblyObject> void <B>registerLoader</B>(javax.xml.namespace.QName element,
<A HREF="../../../../../org/apache/tuscany/core/loader/StAXElementLoader.html" title="interface in org.apache.tuscany.core.loader">StAXElementLoader</A><T> loader)</PRE>
<DL>
<DD>Register a loader. This operation will typically be called by a loader
during its initialization.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>element</CODE> - the element that should be delegated to the contibuted loader<DD><CODE>loader</CODE> - a loader that is being contributed to the system</DL>
</DD>
</DL>
<HR>
<A NAME="unregisterLoader(javax.xml.namespace.QName, org.apache.tuscany.core.loader.StAXElementLoader)"><!-- --></A><H3>
unregisterLoader</H3>
<PRE>
<T extends org.apache.tuscany.model.assembly.AssemblyObject> void <B>unregisterLoader</B>(javax.xml.namespace.QName element,
<A HREF="../../../../../org/apache/tuscany/core/loader/StAXElementLoader.html" title="interface in org.apache.tuscany.core.loader">StAXElementLoader</A><T> loader)</PRE>
<DL>
<DD>Unregister a loader. This will typically be called by a loader as it is being destroyed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>element</CODE> - the element that was being delegated to the contibuted loader<DD><CODE>loader</CODE> - a loader that should no longer be used</DL>
</DD>
</DL>
<HR>
<A NAME="load(javax.xml.stream.XMLStreamReader, org.apache.tuscany.core.loader.LoaderContext)"><!-- --></A><H3>
load</H3>
<PRE>
org.apache.tuscany.model.assembly.AssemblyObject <B>load</B>(javax.xml.stream.XMLStreamReader reader,
<A HREF="../../../../../org/apache/tuscany/core/loader/LoaderContext.html" title="class in org.apache.tuscany.core.loader">LoaderContext</A> loaderContext)
throws javax.xml.stream.XMLStreamException,
<A HREF="../../../../../org/apache/tuscany/core/config/ConfigurationLoadException.html" title="class in org.apache.tuscany.core.config">ConfigurationLoadException</A></PRE>
<DL>
<DD>Parse the supplied XML stream dispatching to the appropriate registered loader
for each element encountered in the stream.
<p/>
This method must be called with the XML cursor positioned on a START_ELEMENT event.
When this method returns, the stream will be positioned on the corresponding
END_ELEMENT event.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reader</CODE> - the XML stream to parse<DD><CODE>loaderContext</CODE> -
<DT><B>Returns:</B><DD>the model object obtained by parsing the current element on the stream
<DT><B>Throws:</B>
<DD><CODE>javax.xml.stream.XMLStreamException</CODE> - if there was a problem reading the stream
<DD><CODE><A HREF="../../../../../org/apache/tuscany/core/config/ConfigurationLoadException.html" title="class in org.apache.tuscany.core.config">ConfigurationLoadException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getContext()"><!-- --></A><H3>
getContext</H3>
<PRE>
<FONT SIZE="-1">@Deprecated
</FONT>org.apache.tuscany.model.assembly.AssemblyContext <B>getContext</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>
<P>
<DD>Hack to allow loaders to initialize model objects on the fly.
Remove when initialization has been moved from the model implementation to the loader.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the model context for this load operation</DL>
</DD>
</DL>
<HR>
<A NAME="setContext(org.apache.tuscany.model.assembly.AssemblyContext)"><!-- --></A><H3>
setContext</H3>
<PRE>
<FONT SIZE="-1">@Deprecated
</FONT>void <B>setContext</B>(org.apache.tuscany.model.assembly.AssemblyContext context)</PRE>
<DL>
<DD><B>Deprecated.</B>
<P>
<DD>Hack to allow loaders to initialize model objects on the fly.
Remove when initialization has been moved from the model implementation to the loader.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - the model context for this load operation</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StAXLoaderRegistry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
Tuscany Core</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/tuscany/core/loader/StAXElementLoader.html" title="interface in org.apache.tuscany.core.loader"><B>PREV CLASS</B></A>
<A HREF="../../../../../org/apache/tuscany/core/loader/StAXPropertyFactory.html" title="interface in org.apache.tuscany.core.loader"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/tuscany/core/loader/StAXLoaderRegistry.html" target="_top"><B>FRAMES</B></A>
<A HREF="StAXLoaderRegistry.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-
</BODY>
</HTML>
|
