Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Annotate
Revision Log

AbstractPluginLoader.html @ 7588

Revision 7588, 28.6 KB checked in by adir, 11 years ago (diff)
Ticket #000 - Adicionando a integracao de buscas com Solr na base a ser isnerida na comunidade

Line
1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2	<!--NewPage-->
3	<HTML>
4	<HEAD>
5	<!-- Generated by javadoc (build 1.6.0_24) on Mon Jun 25 15:26:26 EDT 2012 -->
6	<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7	<TITLE>
8	AbstractPluginLoader (Solr 4.0.0-ALPHA API)
9	</TITLE>
10
11	<META NAME="date" CONTENT="2012-06-25">
12
13	<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
14
15	<SCRIPT type="text/javascript">
16	function windowTitle()
17	{
18	if (location.href.indexOf('is-external=true') == -1) {
19	parent.document.title="AbstractPluginLoader (Solr 4.0.0-ALPHA API)";
20	}
21	}
22	</SCRIPT>
23	<NOSCRIPT>
24	</NOSCRIPT>
25
26	</HEAD>
27
28	<BODY BGCOLOR="white" onload="windowTitle();">
29	<HR>
30
31
32	<!-- ========= START OF TOP NAVBAR ======= -->
33	<A NAME="navbar_top"><!-- --></A>
34	<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36	<TR>
37	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38	<A NAME="navbar_top_firstrow"><!-- --></A>
39	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40	<TR ALIGN="center" VALIGN="top">
41	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
42	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
43	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
44	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractPluginLoader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
45	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
46	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
47	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
48	</TR>
49	</TABLE>
50	</TD>
51	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52	</EM>
53	</TD>
54	</TR>
55
56	<TR>
57	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58	PREV CLASS
59	<A HREF="../../../../../org/apache/solr/util/plugin/MapInitializedPlugin.html" title="interface in org.apache.solr.util.plugin"><B>NEXT CLASS</B></A></FONT></TD>
60	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61	<A HREF="../../../../../index.html?org/apache/solr/util/plugin/AbstractPluginLoader.html" target="_top"><B>FRAMES</B></A>
62	<A HREF="AbstractPluginLoader.html" target="_top"><B>NO FRAMES</B></A>
63	<SCRIPT type="text/javascript">
64	<!--
65	if(window==top) {
66	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67	}
68	//-->
69	</SCRIPT>
70	<NOSCRIPT>
71	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
72	</NOSCRIPT>
73
74
75	</FONT></TD>
76	</TR>
77	<TR>
78	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
80	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
82	</TR>
83	</TABLE>
84	<A NAME="skip-navbar_top"></A>
85	<!-- ========= END OF TOP NAVBAR ========= -->
86
87	<HR>
88	<!-- ======== START OF CLASS DATA ======== -->
89	<H2>
90	<FONT SIZE="-1">
91	org.apache.solr.util.plugin</FONT>
92	<BR>
93	Class AbstractPluginLoader<T></H2>
94	<PRE>
95	<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96	<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.util.plugin.AbstractPluginLoader<T></B>
97	</PRE>
98	<DL>
99	<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/solr/schema/FieldTypePluginLoader.html" title="class in org.apache.solr.schema">FieldTypePluginLoader</A>, <A HREF="../../../../../org/apache/solr/util/plugin/MapPluginLoader.html" title="class in org.apache.solr.util.plugin">MapPluginLoader</A>, <A HREF="../../../../../org/apache/solr/util/plugin/NamedListPluginLoader.html" title="class in org.apache.solr.util.plugin">NamedListPluginLoader</A></DD>
100	</DL>
101	<HR>
102	<DL>
103	<DT><PRE>public abstract class <B>AbstractPluginLoader<T></B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
104	</PRE>
105
106	<P>
107	An abstract super class that manages standard solr-style plugin configuration.
108	<P>
109
110	<P>
111	<DL>
112	<DT><B>Since:</B></DT>
113	<DD>solr 1.3</DD>
114	</DL>
115	<HR>
116
117	<P>
118	<!-- =========== FIELD SUMMARY =========== -->
119
120	<A NAME="field_summary"><!-- --></A>
121	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
122	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
123	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
124	<B>Field Summary</B></FONT></TH>
125	</TR>
126	<TR BGCOLOR="white" CLASS="TableRowColor">
127	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
128	<CODE>static org.slf4j.Logger</CODE></FONT></TD>
129	<TD><CODE><B><A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html#log">log</A></B></CODE>
130
131	<BR>
132	</TD>
133	</TR>
134	</TABLE>
135
136	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
137
138	<A NAME="constructor_summary"><!-- --></A>
139	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
141	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
142	<B>Constructor Summary</B></FONT></TH>
143	</TR>
144	<TR BGCOLOR="white" CLASS="TableRowColor">
145	<TD><CODE><B><A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html#AbstractPluginLoader(java.lang.String, java.lang.Class)">AbstractPluginLoader</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> type,
146	<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A>> pluginClassType)</CODE>
147
148	<BR>
149	</TD>
150	</TR>
151	<TR BGCOLOR="white" CLASS="TableRowColor">
152	<TD><CODE><B><A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html#AbstractPluginLoader(java.lang.String, java.lang.Class, boolean, boolean)">AbstractPluginLoader</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> type,
153	<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A>> pluginClassType,
154	boolean preRegister,
155	boolean requireName)</CODE>
156
157	<BR>
158	</TD>
159	</TR>
160	</TABLE>
161
162	<!-- ========== METHOD SUMMARY =========== -->
163
164	<A NAME="method_summary"><!-- --></A>
165	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
166	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
167	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
168	<B>Method Summary</B></FONT></TH>
169	</TR>
170	<TR BGCOLOR="white" CLASS="TableRowColor">
171	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172	<CODE>protected  <A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A></CODE></FONT></TD>
173	<TD><CODE><B><A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html#create(org.apache.lucene.analysis.util.ResourceLoader, java.lang.String, java.lang.String, org.w3c.dom.Node)">create</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//analyzers-common/org/apache/lucene/analysis/util/ResourceLoader.html?is-external=true" title="class or interface in org.apache.lucene.analysis.util">ResourceLoader</A> loader,
174	<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
175	<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> className,
176	<A HREF="http://download.oracle.com/javase/6/docs/api/org/w3c/dom/Node.html?is-external=true" title="class or interface in org.w3c.dom">Node</A> node)</CODE>
177
178	<BR>
179	Create a plugin from an XML configuration.</TD>
180	</TR>
181	<TR BGCOLOR="white" CLASS="TableRowColor">
182	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183	<CODE>protected  <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD>
184	<TD><CODE><B><A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html#getDefaultPackages()">getDefaultPackages</A></B>()</CODE>
185
186	<BR>
187	Where to look for classes</TD>
188	</TR>
189	<TR BGCOLOR="white" CLASS="TableRowColor">
190	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191	<CODE>protected abstract  void</CODE></FONT></TD>
192	<TD><CODE><B><A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html#init(T, org.w3c.dom.Node)">init</A></B>(<A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A> plugin,
193	<A HREF="http://download.oracle.com/javase/6/docs/api/org/w3c/dom/Node.html?is-external=true" title="class or interface in org.w3c.dom">Node</A> node)</CODE>
194
195	<BR>
196	Initialize the plugin.</TD>
197	</TR>
198	<TR BGCOLOR="white" CLASS="TableRowColor">
199	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200	<CODE> <A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A></CODE></FONT></TD>
201	<TD><CODE><B><A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html#load(org.apache.lucene.analysis.util.ResourceLoader, org.w3c.dom.NodeList)">load</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//analyzers-common/org/apache/lucene/analysis/util/ResourceLoader.html?is-external=true" title="class or interface in org.apache.lucene.analysis.util">ResourceLoader</A> loader,
202	<A HREF="http://download.oracle.com/javase/6/docs/api/org/w3c/dom/NodeList.html?is-external=true" title="class or interface in org.w3c.dom">NodeList</A> nodes)</CODE>
203
204	<BR>
205	Given a NodeList from XML in the form:
206
207	<plugins>
208	<plugin name="name1" class="solr.ClassName" >
209	...</TD>
210	</TR>
211	<TR BGCOLOR="white" CLASS="TableRowColor">
212	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
213	<CODE> <A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A></CODE></FONT></TD>
214	<TD><CODE><B><A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html#loadSingle(org.apache.lucene.analysis.util.ResourceLoader, org.w3c.dom.Node)">loadSingle</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//analyzers-common/org/apache/lucene/analysis/util/ResourceLoader.html?is-external=true" title="class or interface in org.apache.lucene.analysis.util">ResourceLoader</A> loader,
215	<A HREF="http://download.oracle.com/javase/6/docs/api/org/w3c/dom/Node.html?is-external=true" title="class or interface in org.w3c.dom">Node</A> node)</CODE>
216
217	<BR>
218	Given a NodeList from XML in the form:
219
220	<plugin name="name1" class="solr.ClassName" > ...</TD>
221	</TR>
222	<TR BGCOLOR="white" CLASS="TableRowColor">
223	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224	<CODE>protected abstract  <A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A></CODE></FONT></TD>
225	<TD><CODE><B><A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html#register(java.lang.String, T)">register</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
226	<A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A> plugin)</CODE>
227
228	<BR>
229	Register a plugin with a given name.</TD>
230	</TR>
231	</TABLE>
232	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
233	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
234	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
235	<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
236	</TR>
237	<TR BGCOLOR="white" CLASS="TableRowColor">
238	<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
239	</TR>
240	</TABLE>
241
242	<P>
243
244	<!-- ============ FIELD DETAIL =========== -->
245
246	<A NAME="field_detail"><!-- --></A>
247	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
248	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
249	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
250	<B>Field Detail</B></FONT></TH>
251	</TR>
252	</TABLE>
253
254	<A NAME="log"><!-- --></A><H3>
255	log</H3>
256	<PRE>
257	public static org.slf4j.Logger <B>log</B></PRE>
258	<DL>
259	<DL>
260	</DL>
261	</DL>
262
263	<!-- ========= CONSTRUCTOR DETAIL ======== -->
264
265	<A NAME="constructor_detail"><!-- --></A>
266	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
267	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
268	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
269	<B>Constructor Detail</B></FONT></TH>
270	</TR>
271	</TABLE>
272
273	<A NAME="AbstractPluginLoader(java.lang.String, java.lang.Class, boolean, boolean)"><!-- --></A><H3>
274	AbstractPluginLoader</H3>
275	<PRE>
276	public <B>AbstractPluginLoader</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> type,
277	<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A>> pluginClassType,
278	boolean preRegister,
279	boolean requireName)</PRE>
280	<DL>
281	<DL>
282	<DT><B>Parameters:</B><DD><CODE>type</CODE> - is the 'type' name included in error messages.<DD><CODE>preRegister</CODE> - if true, this will first register all Plugins, then it will initialize them.</DL>
283	</DL>
284	<HR>
285
286	<A NAME="AbstractPluginLoader(java.lang.String, java.lang.Class)"><!-- --></A><H3>
287	AbstractPluginLoader</H3>
288	<PRE>
289	public <B>AbstractPluginLoader</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> type,
290	<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A>> pluginClassType)</PRE>
291	<DL>
292	</DL>
293
294	<!-- ============ METHOD DETAIL ========== -->
295
296	<A NAME="method_detail"><!-- --></A>
297	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
298	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
299	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
300	<B>Method Detail</B></FONT></TH>
301	</TR>
302	</TABLE>
303
304	<A NAME="getDefaultPackages()"><!-- --></A><H3>
305	getDefaultPackages</H3>
306	<PRE>
307	protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] <B>getDefaultPackages</B>()</PRE>
308	<DL>
309	<DD>Where to look for classes
310	<P>
311	<DD><DL>
312	</DL>
313	</DD>
314	</DL>
315	<HR>
316
317	<A NAME="create(org.apache.lucene.analysis.util.ResourceLoader, java.lang.String, java.lang.String, org.w3c.dom.Node)"><!-- --></A><H3>
318	create</H3>
319	<PRE>
320	protected <A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A> <B>create</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//analyzers-common/org/apache/lucene/analysis/util/ResourceLoader.html?is-external=true" title="class or interface in org.apache.lucene.analysis.util">ResourceLoader</A> loader,
321	<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
322	<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> className,
323	<A HREF="http://download.oracle.com/javase/6/docs/api/org/w3c/dom/Node.html?is-external=true" title="class or interface in org.w3c.dom">Node</A> node)
324	throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
325	<DL>
326	<DD>Create a plugin from an XML configuration. Plugins are defined using:
327	<plugin name="name1" class="solr.ClassName">
328	...
329	</plugin>
330	<P>
331	<DD><DL>
332	<DT><B>Parameters:</B><DD><CODE>name</CODE> - - The registered name. In the above example: "name1"<DD><CODE>className</CODE> - - class name for requested plugin. In the above example: "solr.ClassName"<DD><CODE>node</CODE> - - the XML node defining this plugin
333	<DT><B>Throws:</B>
334	<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL>
335	</DD>
336	</DL>
337	<HR>
338
339	<A NAME="register(java.lang.String,java.lang.Object)"><!-- --></A><A NAME="register(java.lang.String, T)"><!-- --></A><H3>
340	register</H3>
341	<PRE>
342	protected abstract <A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A> <B>register</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
343	<A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A> plugin)
344	throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
345	<DL>
346	<DD>Register a plugin with a given name.
347	<P>
348	<DD><DL>
349
350	<DT><B>Returns:</B><DD>The plugin previously registered to this name, or null
351	<DT><B>Throws:</B>
352	<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL>
353	</DD>
354	</DL>
355	<HR>
356
357	<A NAME="init(java.lang.Object,org.w3c.dom.Node)"><!-- --></A><A NAME="init(T, org.w3c.dom.Node)"><!-- --></A><H3>
358	init</H3>
359	<PRE>
360	protected abstract void <B>init</B>(<A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A> plugin,
361	<A HREF="http://download.oracle.com/javase/6/docs/api/org/w3c/dom/Node.html?is-external=true" title="class or interface in org.w3c.dom">Node</A> node)
362	throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
363	<DL>
364	<DD>Initialize the plugin.
365	<P>
366	<DD><DL>
367	<DT><B>Parameters:</B><DD><CODE>plugin</CODE> - - the plugin to initialize<DD><CODE>node</CODE> - - the XML node defining this plugin
368	<DT><B>Throws:</B>
369	<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL>
370	</DD>
371	</DL>
372	<HR>
373
374	<A NAME="load(org.apache.lucene.analysis.util.ResourceLoader, org.w3c.dom.NodeList)"><!-- --></A><H3>
375	load</H3>
376	<PRE>
377	public <A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A> <B>load</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//analyzers-common/org/apache/lucene/analysis/util/ResourceLoader.html?is-external=true" title="class or interface in org.apache.lucene.analysis.util">ResourceLoader</A> loader,
378	<A HREF="http://download.oracle.com/javase/6/docs/api/org/w3c/dom/NodeList.html?is-external=true" title="class or interface in org.w3c.dom">NodeList</A> nodes)</PRE>
379	<DL>
380	<DD>Given a NodeList from XML in the form:
381
382	<plugins>
383	<plugin name="name1" class="solr.ClassName" >
384	...
385	</plugin>
386	<plugin name="name2" class="solr.ClassName" >
387	...
388	</plugin>
389	</plugins>
390
391	This will initialize and register each plugin from the list. A class will
392	be generated for each class name and registered to the given name.
393
394	If 'preRegister' is true, each plugin will be registered before it is initialized
395	This may be useful for implementations that need to inspect other registered
396	plugins at startup.
397
398	One (and only one) plugin may declare itself to be the 'default' plugin using:
399	<plugin name="name2" class="solr.ClassName" default="true">
400	If a default element is defined, it will be returned from this function.
401	<P>
402	<DD><DL>
403	</DL>
404	</DD>
405	</DL>
406	<HR>
407
408	<A NAME="loadSingle(org.apache.lucene.analysis.util.ResourceLoader, org.w3c.dom.Node)"><!-- --></A><H3>
409	loadSingle</H3>
410	<PRE>
411	public <A HREF="../../../../../org/apache/solr/util/plugin/AbstractPluginLoader.html" title="type parameter in AbstractPluginLoader">T</A> <B>loadSingle</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//analyzers-common/org/apache/lucene/analysis/util/ResourceLoader.html?is-external=true" title="class or interface in org.apache.lucene.analysis.util">ResourceLoader</A> loader,
412	<A HREF="http://download.oracle.com/javase/6/docs/api/org/w3c/dom/Node.html?is-external=true" title="class or interface in org.w3c.dom">Node</A> node)</PRE>
413	<DL>
414	<DD>Given a NodeList from XML in the form:
415
416	<plugin name="name1" class="solr.ClassName" > ... </plugin>
417
418	This will initialize and register a single plugin. A class will be
419	generated for the plugin and registered to the given name.
420
421	If 'preRegister' is true, the plugin will be registered before it is
422	initialized This may be useful for implementations that need to inspect
423	other registered plugins at startup.
424
425	The created class for the plugin will be returned from this function.
426	<P>
427	<DD><DL>
428	</DL>
429	</DD>
430	</DL>
431	<!-- ========= END OF CLASS DATA ========= -->
432	<HR>
433
434
435	<!-- ======= START OF BOTTOM NAVBAR ====== -->
436	<A NAME="navbar_bottom"><!-- --></A>
437	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
438	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
439	<TR>
440	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
441	<A NAME="navbar_bottom_firstrow"><!-- --></A>
442	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
443	<TR ALIGN="center" VALIGN="top">
444	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
445	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
446	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
447	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractPluginLoader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
448	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
449	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
450	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
451	</TR>
452	</TABLE>
453	</TD>
454	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
455	</EM>
456	</TD>
457	</TR>
458
459	<TR>
460	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
461	PREV CLASS
462	<A HREF="../../../../../org/apache/solr/util/plugin/MapInitializedPlugin.html" title="interface in org.apache.solr.util.plugin"><B>NEXT CLASS</B></A></FONT></TD>
463	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
464	<A HREF="../../../../../index.html?org/apache/solr/util/plugin/AbstractPluginLoader.html" target="_top"><B>FRAMES</B></A>
465	<A HREF="AbstractPluginLoader.html" target="_top"><B>NO FRAMES</B></A>
466	<SCRIPT type="text/javascript">
467	<!--
468	if(window==top) {
469	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
470	}
471	//-->
472	</SCRIPT>
473	<NOSCRIPT>
474	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
475	</NOSCRIPT>
476
477
478	</FONT></TD>
479	</TR>
480	<TR>
481	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
482	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
483	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
484	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
485	</TR>
486	</TABLE>
487	<A NAME="skip-navbar_bottom"></A>
488	<!-- ======== END OF BOTTOM NAVBAR ======= -->
489
490	<HR>
491
492	<address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address>
493	<script src='../../../../../prettify.js' type='text/javascript'></script>
494	<script type='text/javascript'>
495	(function(){
496	var oldonload = window.onload;
497	if (typeof oldonload != 'function') {
498	window.onload = prettyPrint;
499	} else {
500	window.onload = function() {
501	oldonload();
502	prettyPrint();
503	}
504	}
505	})();
506	</script>
507
508	</BODY>
509	</HTML>

Note: See TracBrowser for help on using the repository browser.

Context Navigation

source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/util/plugin/AbstractPluginLoader.html @ 7588

Download in other formats: