source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.html @ 7588

Revision 7588, 29.0 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:25 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8FieldMutatingUpdateProcessorFactory (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">
16function windowTitle()
17{
18    if (location.href.indexOf('is-external=true') == -1) {
19        parent.document.title="FieldMutatingUpdateProcessorFactory (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>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
43  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FieldMutatingUpdateProcessorFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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&nbsp;<A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.SelectorParams.html" title="class in org.apache.solr.update.processor"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="FieldMutatingUpdateProcessorFactory.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<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:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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">
91org.apache.solr.update.processor</FONT>
92<BR>
93Class FieldMutatingUpdateProcessorFactory</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 "><A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessorFactory.html" title="class in org.apache.solr.update.processor">org.apache.solr.update.processor.UpdateRequestProcessorFactory</A>
97      <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.update.processor.FieldMutatingUpdateProcessorFactory</B>
98</PRE>
99<DL>
100<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A>, <A HREF="../../../../../org/apache/solr/util/plugin/SolrCoreAware.html" title="interface in org.apache.solr.util.plugin">SolrCoreAware</A></DD>
101</DL>
102<DL>
103<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/solr/update/processor/ConcatFieldUpdateProcessorFactory.html" title="class in org.apache.solr.update.processor">ConcatFieldUpdateProcessorFactory</A>, <A HREF="../../../../../org/apache/solr/update/processor/FieldLengthUpdateProcessorFactory.html" title="class in org.apache.solr.update.processor">FieldLengthUpdateProcessorFactory</A>, <A HREF="../../../../../org/apache/solr/update/processor/FieldValueSubsetUpdateProcessorFactory.html" title="class in org.apache.solr.update.processor">FieldValueSubsetUpdateProcessorFactory</A>, <A HREF="../../../../../org/apache/solr/update/processor/HTMLStripFieldUpdateProcessorFactory.html" title="class in org.apache.solr.update.processor">HTMLStripFieldUpdateProcessorFactory</A>, <A HREF="../../../../../org/apache/solr/update/processor/IgnoreFieldUpdateProcessorFactory.html" title="class in org.apache.solr.update.processor">IgnoreFieldUpdateProcessorFactory</A>, <A HREF="../../../../../org/apache/solr/update/processor/RegexReplaceProcessorFactory.html" title="class in org.apache.solr.update.processor">RegexReplaceProcessorFactory</A>, <A HREF="../../../../../org/apache/solr/update/processor/RemoveBlankFieldUpdateProcessorFactory.html" title="class in org.apache.solr.update.processor">RemoveBlankFieldUpdateProcessorFactory</A>, <A HREF="../../../../../org/apache/solr/update/processor/TrimFieldUpdateProcessorFactory.html" title="class in org.apache.solr.update.processor">TrimFieldUpdateProcessorFactory</A>, <A HREF="../../../../../org/apache/solr/update/processor/TruncateFieldUpdateProcessorFactory.html" title="class in org.apache.solr.update.processor">TruncateFieldUpdateProcessorFactory</A></DD>
104</DL>
105<HR>
106<DL>
107<DT><PRE>public abstract class <B>FieldMutatingUpdateProcessorFactory</B><DT>extends <A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessorFactory.html" title="class in org.apache.solr.update.processor">UpdateRequestProcessorFactory</A><DT>implements <A HREF="../../../../../org/apache/solr/util/plugin/SolrCoreAware.html" title="interface in org.apache.solr.util.plugin">SolrCoreAware</A></DL>
108</PRE>
109
110<P>
111Base class for implementing Factories for FieldMutatingUpdateProcessors and
112 FieldValueMutatingUpdateProcessors.
113
114 <p>
115 This class provides all of the plumbing for configuring the
116 FieldNameSelector using the following init params to specify selection
117 criteria...
118 </p>
119 <ul>
120   <li><code>fieldName</code> - selecting specific fields by field name lookup</li>
121   <li><code>fieldRegex</code> - selecting specific fields by field name regex match (regexes are checked in the order specified)</li>
122   <li><code>typeName</code> - selecting specific fields by fieldType name lookup</li>
123   <li><code>typeClass</code> - selecting specific fields by fieldType class lookup, including inheritence and interfaces</li>
124 </ul>
125
126 <p>
127 Each criteria can specified as either an &lt;arr&gt; of &lt;str&gt;, or
128 multiple &lt;str&gt; with the same name.  When multiple criteria of a
129 single type exist, fields must match <b>at least one</b> to be selected. 
130 If more then one type of criteria exist, fields must match
131 <b>at least one of each</b> to be selected.
132 </p>
133 <p>
134 One or more <code>excludes</code> &lt;lst&gt; params may also be specified,
135 containing any of the above criteria, identifying fields to be excluded
136 from seelction even if they match the selection criteria.  As with the main
137 selection critiera a field must match all of criteria in a single exclusion
138 in order to be excluded, but multiple exclusions may be specified to get an
139 <code>OR</code> behavior
140 </p>
141
142 <p>
143 In the ExampleFieldMutatingUpdateProcessorFactory configured below,
144 fields will be mutated if the name starts with "foo" <i>or</i> "bar";
145 <b>unless</b> the field name contains the substring "SKIP" <i>or</i>
146 the fieldType is (or subclasses) DateField.  Meaning a field named
147 "foo_SKIP" is gaurunteed not to be selected, but a field named "bar_smith"
148 that uses StrField will be selected.
149 </p>
150 <pre class="prettyprint">
151 &lt;processor class="solr.ExampleFieldMutatingUpdateProcessorFactory"&gt;
152   &lt;str name="fieldRegex"&gt;foo.*&lt;/str&gt;
153   &lt;str name="fieldRegex"&gt;bar.*&lt;/str&gt;
154   &lt;!-- each set of exclusions is checked independently --&gt;
155   &lt;lst name="exclude"&gt;
156     &lt;str name="fieldRegex"&gt;.*SKIP.*&lt;/str&gt;
157   &lt;/lst&gt;
158   &lt;lst name="exclude"&gt;
159     &lt;str name="typeClass"&gt;solr.DateField&lt;/str&gt;
160   &lt;/lst&gt;
161 &lt;/processor&gt;
162 </pre>
163 
164 <p>
165 Subclasses define the default selection behavior to be applied if no
166 criteria is configured by the user.  User configured "exclude" criteria
167 will be applied to the subclass defined default selector.
168 </p>
169<P>
170
171<P>
172<DL>
173<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.html" title="class in org.apache.solr.update.processor"><CODE>FieldMutatingUpdateProcessor</CODE></A>,
174<A HREF="../../../../../org/apache/solr/update/processor/FieldValueMutatingUpdateProcessor.html" title="class in org.apache.solr.update.processor"><CODE>FieldValueMutatingUpdateProcessor</CODE></A>,
175<A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor"><CODE>FieldMutatingUpdateProcessor.FieldNameSelector</CODE></A></DL>
176<HR>
177
178<P>
179<!-- ======== NESTED CLASS SUMMARY ======== -->
180
181<A NAME="nested_class_summary"><!-- --></A>
182<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
183<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
184<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
185<B>Nested Class Summary</B></FONT></TH>
186</TR>
187<TR BGCOLOR="white" CLASS="TableRowColor">
188<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189<CODE>static&nbsp;class</CODE></FONT></TD>
190<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.SelectorParams.html" title="class in org.apache.solr.update.processor">FieldMutatingUpdateProcessorFactory.SelectorParams</A></B></CODE>
191
192<BR>
193&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
194</TR>
195</TABLE>
196&nbsp;
197<!-- ======== CONSTRUCTOR SUMMARY ======== -->
198
199<A NAME="constructor_summary"><!-- --></A>
200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
202<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
203<B>Constructor Summary</B></FONT></TH>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.html#FieldMutatingUpdateProcessorFactory()">FieldMutatingUpdateProcessorFactory</A></B>()</CODE>
207
208<BR>
209&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
210</TR>
211</TABLE>
212&nbsp;
213<!-- ========== METHOD SUMMARY =========== -->
214
215<A NAME="method_summary"><!-- --></A>
216<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
217<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
218<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
219<B>Method Summary</B></FONT></TH>
220</TR>
221<TR BGCOLOR="white" CLASS="TableRowColor">
222<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
223<CODE>protected &nbsp;<A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A></CODE></FONT></TD>
224<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.html#getDefaultSelector(org.apache.solr.core.SolrCore)">getDefaultSelector</A></B>(<A HREF="../../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</CODE>
225
226<BR>
227&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Defines the default selection behavior when the user has not
228 configured any specific criteria for selecting fields.</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<CODE>protected &nbsp;<A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A></CODE></FONT></TD>
233<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.html#getSelector()">getSelector</A></B>()</CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
237</TR>
238<TR BGCOLOR="white" CLASS="TableRowColor">
239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240<CODE>&nbsp;void</CODE></FONT></TD>
241<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.html#inform(org.apache.solr.core.SolrCore)">inform</A></B>(<A HREF="../../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</CODE>
242
243<BR>
244&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248<CODE>&nbsp;void</CODE></FONT></TD>
249<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.html#init(org.apache.solr.common.util.NamedList)">init</A></B>(<A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;args)</CODE>
250
251<BR>
252&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Handles common initialization related to source fields for
253 constructoring the FieldNameSelector to be used.</TD>
254</TR>
255<TR BGCOLOR="white" CLASS="TableRowColor">
256<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
257<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<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>&gt;</CODE></FONT></TD>
258<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.html#oneOrMany(org.apache.solr.common.util.NamedList, java.lang.String)">oneOrMany</A></B>(<A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;args,
259          <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>&nbsp;key)</CODE>
260
261<BR>
262&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes all instance of the key from NamedList, returning the Set of
263 Strings that key refered to.</TD>
264</TR>
265<TR BGCOLOR="white" CLASS="TableRowColor">
266<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
267<CODE>static&nbsp;<A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.SelectorParams.html" title="class in org.apache.solr.update.processor">FieldMutatingUpdateProcessorFactory.SelectorParams</A></CODE></FONT></TD>
268<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.html#parseSelectorParams(org.apache.solr.common.util.NamedList)">parseSelectorParams</A></B>(<A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;args)</CODE>
269
270<BR>
271&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
272</TR>
273</TABLE>
274&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.update.processor.UpdateRequestProcessorFactory"><!-- --></A>
275<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
276<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
277<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.update.processor.<A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessorFactory.html" title="class in org.apache.solr.update.processor">UpdateRequestProcessorFactory</A></B></TH>
278</TR>
279<TR BGCOLOR="white" CLASS="TableRowColor">
280<TD><CODE><A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessorFactory.html#getInstance(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse, org.apache.solr.update.processor.UpdateRequestProcessor)">getInstance</A></CODE></TD>
281</TR>
282</TABLE>
283&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
284<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
285<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
286<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>
287</TR>
288<TR BGCOLOR="white" CLASS="TableRowColor">
289<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>
290</TR>
291</TABLE>
292&nbsp;
293<P>
294
295<!-- ========= CONSTRUCTOR DETAIL ======== -->
296
297<A NAME="constructor_detail"><!-- --></A>
298<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
299<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
300<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
301<B>Constructor Detail</B></FONT></TH>
302</TR>
303</TABLE>
304
305<A NAME="FieldMutatingUpdateProcessorFactory()"><!-- --></A><H3>
306FieldMutatingUpdateProcessorFactory</H3>
307<PRE>
308public <B>FieldMutatingUpdateProcessorFactory</B>()</PRE>
309<DL>
310</DL>
311
312<!-- ============ METHOD DETAIL ========== -->
313
314<A NAME="method_detail"><!-- --></A>
315<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
316<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
317<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
318<B>Method Detail</B></FONT></TH>
319</TR>
320</TABLE>
321
322<A NAME="getSelector()"><!-- --></A><H3>
323getSelector</H3>
324<PRE>
325protected final <A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A> <B>getSelector</B>()</PRE>
326<DL>
327<DD><DL>
328</DL>
329</DD>
330<DD><DL>
331</DL>
332</DD>
333</DL>
334<HR>
335
336<A NAME="parseSelectorParams(org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
337parseSelectorParams</H3>
338<PRE>
339public static <A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.SelectorParams.html" title="class in org.apache.solr.update.processor">FieldMutatingUpdateProcessorFactory.SelectorParams</A> <B>parseSelectorParams</B>(<A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;args)</PRE>
340<DL>
341<DD><DL>
342</DL>
343</DD>
344<DD><DL>
345</DL>
346</DD>
347</DL>
348<HR>
349
350<A NAME="init(org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
351init</H3>
352<PRE>
353public void <B>init</B>(<A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;args)</PRE>
354<DL>
355<DD>Handles common initialization related to source fields for
356 constructoring the FieldNameSelector to be used.
357
358 Will error if any unexpected init args are found, so subclasses should
359 remove any subclass-specific init args before calling this method.
360<P>
361<DD><DL>
362<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessorFactory.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessorFactory.html" title="class in org.apache.solr.update.processor">UpdateRequestProcessorFactory</A></CODE></DL>
363</DD>
364<DD><DL>
365</DL>
366</DD>
367</DL>
368<HR>
369
370<A NAME="inform(org.apache.solr.core.SolrCore)"><!-- --></A><H3>
371inform</H3>
372<PRE>
373public void <B>inform</B>(<A HREF="../../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</PRE>
374<DL>
375<DD><DL>
376<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/util/plugin/SolrCoreAware.html#inform(org.apache.solr.core.SolrCore)">inform</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/util/plugin/SolrCoreAware.html" title="interface in org.apache.solr.util.plugin">SolrCoreAware</A></CODE></DL>
377</DD>
378<DD><DL>
379</DL>
380</DD>
381</DL>
382<HR>
383
384<A NAME="getDefaultSelector(org.apache.solr.core.SolrCore)"><!-- --></A><H3>
385getDefaultSelector</H3>
386<PRE>
387protected <A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A> <B>getDefaultSelector</B>(<A HREF="../../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</PRE>
388<DL>
389<DD>Defines the default selection behavior when the user has not
390 configured any specific criteria for selecting fields. The Default
391 implementation matches all fields, and should be overridden by subclasses
392 as needed.
393<P>
394<DD><DL>
395</DL>
396</DD>
397<DD><DL>
398<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.html#SELECT_ALL_FIELDS"><CODE>FieldMutatingUpdateProcessor.SELECT_ALL_FIELDS</CODE></A></DL>
399</DD>
400</DL>
401<HR>
402
403<A NAME="oneOrMany(org.apache.solr.common.util.NamedList, java.lang.String)"><!-- --></A><H3>
404oneOrMany</H3>
405<PRE>
406public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<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>&gt; <B>oneOrMany</B>(<A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;args,
407                                           <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>&nbsp;key)</PRE>
408<DL>
409<DD>Removes all instance of the key from NamedList, returning the Set of
410 Strings that key refered to.  Throws an error if the key didn't refer
411 to one or more strings (or arrays of strings)
412<P>
413<DD><DL>
414</DL>
415</DD>
416<DD><DL>
417
418<DT><B>Throws:</B>
419<DD><CODE><A HREF="../../../../../org/apache/solr/common/SolrException.html" title="class in org.apache.solr.common">SolrException</A></CODE> - invalid arr/str structure.</DL>
420</DD>
421</DL>
422<!-- ========= END OF CLASS DATA ========= -->
423<HR>
424
425
426<!-- ======= START OF BOTTOM NAVBAR ====== -->
427<A NAME="navbar_bottom"><!-- --></A>
428<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
429<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
430<TR>
431<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
432<A NAME="navbar_bottom_firstrow"><!-- --></A>
433<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
434  <TR ALIGN="center" VALIGN="top">
435  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
436  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
437  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
438  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FieldMutatingUpdateProcessorFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
439  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
440  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
441  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
442  </TR>
443</TABLE>
444</TD>
445<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
446</EM>
447</TD>
448</TR>
449
450<TR>
451<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
452&nbsp;<A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor"><B>PREV CLASS</B></A>&nbsp;
453&nbsp;<A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.SelectorParams.html" title="class in org.apache.solr.update.processor"><B>NEXT CLASS</B></A></FONT></TD>
454<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
455  <A HREF="../../../../../index.html?org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;
456&nbsp;<A HREF="FieldMutatingUpdateProcessorFactory.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
457&nbsp;<SCRIPT type="text/javascript">
458  <!--
459  if(window==top) {
460    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
461  }
462  //-->
463</SCRIPT>
464<NOSCRIPT>
465  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
466</NOSCRIPT>
467
468
469</FONT></TD>
470</TR>
471<TR>
472<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
473  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
474<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
475DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
476</TR>
477</TABLE>
478<A NAME="skip-navbar_bottom"></A>
479<!-- ======== END OF BOTTOM NAVBAR ======= -->
480
481<HR>
482
483          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
484          <script src='../../../../../prettify.js' type='text/javascript'></script>
485          <script type='text/javascript'>
486            (function(){
487              var oldonload = window.onload;
488              if (typeof oldonload != 'function') {
489                window.onload = prettyPrint;
490              } else {
491                window.onload = function() {
492                  oldonload();
493                  prettyPrint();
494                }
495              }
496            })();
497          </script>
498       
499</BODY>
500</HTML>
Note: See TracBrowser for help on using the repository browser.