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

Revision 7588, 33.2 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>
8FieldMutatingUpdateProcessor (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="FieldMutatingUpdateProcessor (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/FieldMutatingUpdateProcessor.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/FieldLengthUpdateProcessorFactory.html" title="class in org.apache.solr.update.processor"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface 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/FieldMutatingUpdateProcessor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="FieldMutatingUpdateProcessor.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;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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 FieldMutatingUpdateProcessor</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/UpdateRequestProcessor.html" title="class in org.apache.solr.update.processor">org.apache.solr.update.processor.UpdateRequestProcessor</A>
97      <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.update.processor.FieldMutatingUpdateProcessor</B>
98</PRE>
99<DL>
100<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/solr/update/processor/FieldValueMutatingUpdateProcessor.html" title="class in org.apache.solr.update.processor">FieldValueMutatingUpdateProcessor</A></DD>
101</DL>
102<HR>
103<DL>
104<DT><PRE>public abstract class <B>FieldMutatingUpdateProcessor</B><DT>extends <A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessor.html" title="class in org.apache.solr.update.processor">UpdateRequestProcessor</A></DL>
105</PRE>
106
107<P>
108Reusable base class for UpdateProcessors that will consider
109 AddUpdateCommands and mutate the values associated with configured
110 fields.
111 <p>
112 Subclasses should override the mutate method to specify how individual
113 SolrInputFields identified by the selector associated with this instance
114 will be mutated.
115 </p>
116<P>
117
118<P>
119<DL>
120<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessorFactory.html" title="class in org.apache.solr.update.processor"><CODE>FieldMutatingUpdateProcessorFactory</CODE></A>,
121<A HREF="../../../../../org/apache/solr/update/processor/FieldValueMutatingUpdateProcessor.html" title="class in org.apache.solr.update.processor"><CODE>FieldValueMutatingUpdateProcessor</CODE></A>,
122<A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor"><CODE>FieldMutatingUpdateProcessor.FieldNameSelector</CODE></A></DL>
123<HR>
124
125<P>
126<!-- ======== NESTED CLASS SUMMARY ======== -->
127
128<A NAME="nested_class_summary"><!-- --></A>
129<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
130<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
131<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
132<B>Nested Class Summary</B></FONT></TH>
133</TR>
134<TR BGCOLOR="white" CLASS="TableRowColor">
135<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
136<CODE>static&nbsp;interface</CODE></FONT></TD>
137<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A></B></CODE>
138
139<BR>
140&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Interface for idenfifying which fileds should be mutated</TD>
141</TR>
142</TABLE>
143&nbsp;<!-- =========== FIELD SUMMARY =========== -->
144
145<A NAME="field_summary"><!-- --></A>
146<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
147<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
148<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
149<B>Field Summary</B></FONT></TH>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<CODE>static&nbsp;org.slf4j.Logger</CODE></FONT></TD>
154<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.html#log">log</A></B></CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>static&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>
162<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.html#SELECT_ALL_FIELDS">SELECT_ALL_FIELDS</A></B></CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Singleton indicating all fields should be mutated</TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169<CODE>static&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>
170<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.html#SELECT_NO_FIELDS">SELECT_NO_FIELDS</A></B></CODE>
171
172<BR>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Singleton indicating no fields should be mutated</TD>
174</TR>
175</TABLE>
176&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.update.processor.UpdateRequestProcessor"><!-- --></A>
177<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
178<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
179<TH ALIGN="left"><B>Fields inherited from class org.apache.solr.update.processor.<A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessor.html" title="class in org.apache.solr.update.processor">UpdateRequestProcessor</A></B></TH>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD><CODE><A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessor.html#next">next</A></CODE></TD>
183</TR>
184</TABLE>
185&nbsp;
186<!-- ======== CONSTRUCTOR SUMMARY ======== -->
187
188<A NAME="constructor_summary"><!-- --></A>
189<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
190<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
191<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
192<B>Constructor Summary</B></FONT></TH>
193</TR>
194<TR BGCOLOR="white" CLASS="TableRowColor">
195<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.html#FieldMutatingUpdateProcessor(org.apache.solr.update.processor.FieldMutatingUpdateProcessor.FieldNameSelector, org.apache.solr.update.processor.UpdateRequestProcessor)">FieldMutatingUpdateProcessor</A></B>(<A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A>&nbsp;selector,
196                             <A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessor.html" title="class in org.apache.solr.update.processor">UpdateRequestProcessor</A>&nbsp;next)</CODE>
197
198<BR>
199&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
200</TR>
201</TABLE>
202&nbsp;
203<!-- ========== METHOD SUMMARY =========== -->
204
205<A NAME="method_summary"><!-- --></A>
206<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
207<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
208<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
209<B>Method Summary</B></FONT></TH>
210</TR>
211<TR BGCOLOR="white" CLASS="TableRowColor">
212<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
213<CODE>static&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>
214<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.html#createFieldNameSelector(org.apache.solr.core.SolrResourceLoader, org.apache.solr.schema.IndexSchema, java.util.Set, java.util.Set, java.util.Collection, java.util.Collection, org.apache.solr.update.processor.FieldMutatingUpdateProcessor.FieldNameSelector)">createFieldNameSelector</A></B>(<A HREF="../../../../../org/apache/solr/core/SolrResourceLoader.html" title="class in org.apache.solr.core">SolrResourceLoader</A>&nbsp;loader,
215                        <A HREF="../../../../../org/apache/solr/schema/IndexSchema.html" title="class in org.apache.solr.schema">IndexSchema</A>&nbsp;schema,
216                        <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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;&nbsp;fields,
217                        <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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;&nbsp;typeNames,
218                        <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;&nbsp;typeClasses,
219                        <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/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</A>&gt;&nbsp;regexes,
220                        <A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A>&nbsp;defSelector)</CODE>
221
222<BR>
223&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility method that can be used to define a FieldNameSelector
224 using the same types of rules as the FieldMutatingUpdateProcessor init
225 code.</TD>
226</TR>
227<TR BGCOLOR="white" CLASS="TableRowColor">
228<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
229<CODE>protected abstract &nbsp;<A HREF="../../../../../org/apache/solr/common/SolrInputField.html" title="class in org.apache.solr.common">SolrInputField</A></CODE></FONT></TD>
230<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.html#mutate(org.apache.solr.common.SolrInputField)">mutate</A></B>(<A HREF="../../../../../org/apache/solr/common/SolrInputField.html" title="class in org.apache.solr.common">SolrInputField</A>&nbsp;src)</CODE>
231
232<BR>
233&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method for mutating SolrInputFields associated with fields identified
234 by the FieldNameSelector associated with this processor</TD>
235</TR>
236<TR BGCOLOR="white" CLASS="TableRowColor">
237<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
238<CODE>&nbsp;void</CODE></FONT></TD>
239<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.html#processAdd(org.apache.solr.update.AddUpdateCommand)">processAdd</A></B>(<A HREF="../../../../../org/apache/solr/update/AddUpdateCommand.html" title="class in org.apache.solr.update">AddUpdateCommand</A>&nbsp;cmd)</CODE>
240
241<BR>
242&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Calls <code>mutate</code> on any fields identified by the selector
243 before forwarding the command down the chain.</TD>
244</TR>
245<TR BGCOLOR="white" CLASS="TableRowColor">
246<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
247<CODE>static&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>
248<TD><CODE><B><A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.html#wrap(org.apache.solr.update.processor.FieldMutatingUpdateProcessor.FieldNameSelector, org.apache.solr.update.processor.FieldMutatingUpdateProcessor.FieldNameSelector)">wrap</A></B>(<A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A>&nbsp;includes,
249     <A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A>&nbsp;excludes)</CODE>
250
251<BR>
252&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Wraps two FieldNameSelectors such that the FieldNameSelector
253 returned matches all fields specified by the "includes" unless they
254 are matched by "excludes"</TD>
255</TR>
256</TABLE>
257&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.update.processor.UpdateRequestProcessor"><!-- --></A>
258<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
259<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
260<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.update.processor.<A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessor.html" title="class in org.apache.solr.update.processor">UpdateRequestProcessor</A></B></TH>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<TD><CODE><A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessor.html#finish()">finish</A>, <A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessor.html#processCommit(org.apache.solr.update.CommitUpdateCommand)">processCommit</A>, <A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessor.html#processDelete(org.apache.solr.update.DeleteUpdateCommand)">processDelete</A>, <A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessor.html#processMergeIndexes(org.apache.solr.update.MergeIndexesCommand)">processMergeIndexes</A>, <A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessor.html#processRollback(org.apache.solr.update.RollbackUpdateCommand)">processRollback</A></CODE></TD>
264</TR>
265</TABLE>
266&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
267<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
268<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
269<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>
270</TR>
271<TR BGCOLOR="white" CLASS="TableRowColor">
272<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>
273</TR>
274</TABLE>
275&nbsp;
276<P>
277
278<!-- ============ FIELD DETAIL =========== -->
279
280<A NAME="field_detail"><!-- --></A>
281<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
282<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
283<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
284<B>Field Detail</B></FONT></TH>
285</TR>
286</TABLE>
287
288<A NAME="log"><!-- --></A><H3>
289log</H3>
290<PRE>
291public static final org.slf4j.Logger <B>log</B></PRE>
292<DL>
293<DL>
294</DL>
295</DL>
296<HR>
297
298<A NAME="SELECT_ALL_FIELDS"><!-- --></A><H3>
299SELECT_ALL_FIELDS</H3>
300<PRE>
301public static final <A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A> <B>SELECT_ALL_FIELDS</B></PRE>
302<DL>
303<DD>Singleton indicating all fields should be mutated
304<P>
305<DL>
306</DL>
307</DL>
308<HR>
309
310<A NAME="SELECT_NO_FIELDS"><!-- --></A><H3>
311SELECT_NO_FIELDS</H3>
312<PRE>
313public static final <A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A> <B>SELECT_NO_FIELDS</B></PRE>
314<DL>
315<DD>Singleton indicating no fields should be mutated
316<P>
317<DL>
318</DL>
319</DL>
320
321<!-- ========= CONSTRUCTOR DETAIL ======== -->
322
323<A NAME="constructor_detail"><!-- --></A>
324<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
325<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
326<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
327<B>Constructor Detail</B></FONT></TH>
328</TR>
329</TABLE>
330
331<A NAME="FieldMutatingUpdateProcessor(org.apache.solr.update.processor.FieldMutatingUpdateProcessor.FieldNameSelector, org.apache.solr.update.processor.UpdateRequestProcessor)"><!-- --></A><H3>
332FieldMutatingUpdateProcessor</H3>
333<PRE>
334public <B>FieldMutatingUpdateProcessor</B>(<A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A>&nbsp;selector,
335                                    <A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessor.html" title="class in org.apache.solr.update.processor">UpdateRequestProcessor</A>&nbsp;next)</PRE>
336<DL>
337</DL>
338
339<!-- ============ METHOD DETAIL ========== -->
340
341<A NAME="method_detail"><!-- --></A>
342<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
343<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
344<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
345<B>Method Detail</B></FONT></TH>
346</TR>
347</TABLE>
348
349<A NAME="mutate(org.apache.solr.common.SolrInputField)"><!-- --></A><H3>
350mutate</H3>
351<PRE>
352protected abstract <A HREF="../../../../../org/apache/solr/common/SolrInputField.html" title="class in org.apache.solr.common">SolrInputField</A> <B>mutate</B>(<A HREF="../../../../../org/apache/solr/common/SolrInputField.html" title="class in org.apache.solr.common">SolrInputField</A>&nbsp;src)</PRE>
353<DL>
354<DD>Method for mutating SolrInputFields associated with fields identified
355 by the FieldNameSelector associated with this processor
356<P>
357<DD><DL>
358<DT><B>Parameters:</B><DD><CODE>src</CODE> - the SolrInputField to mutate, may be modified in place and
359            returned
360<DT><B>Returns:</B><DD>the SolrInputField to use in replacing the original (src) value.
361         If null the field will be removed.</DL>
362</DD>
363</DL>
364<HR>
365
366<A NAME="processAdd(org.apache.solr.update.AddUpdateCommand)"><!-- --></A><H3>
367processAdd</H3>
368<PRE>
369public void <B>processAdd</B>(<A HREF="../../../../../org/apache/solr/update/AddUpdateCommand.html" title="class in org.apache.solr.update">AddUpdateCommand</A>&nbsp;cmd)
370                throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
371<DL>
372<DD>Calls <code>mutate</code> on any fields identified by the selector
373 before forwarding the command down the chain.  Any SolrExceptions
374 thrown by <code>mutate</code> will be logged with the Field name,
375 wrapped and re-thrown.
376<P>
377<DD><DL>
378<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessor.html#processAdd(org.apache.solr.update.AddUpdateCommand)">processAdd</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/update/processor/UpdateRequestProcessor.html" title="class in org.apache.solr.update.processor">UpdateRequestProcessor</A></CODE></DL>
379</DD>
380<DD><DL>
381
382<DT><B>Throws:</B>
383<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
384</DD>
385</DL>
386<HR>
387
388<A NAME="wrap(org.apache.solr.update.processor.FieldMutatingUpdateProcessor.FieldNameSelector, org.apache.solr.update.processor.FieldMutatingUpdateProcessor.FieldNameSelector)"><!-- --></A><H3>
389wrap</H3>
390<PRE>
391public static <A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A> <B>wrap</B>(<A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A>&nbsp;includes,
392                                                                  <A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A>&nbsp;excludes)</PRE>
393<DL>
394<DD>Wraps two FieldNameSelectors such that the FieldNameSelector
395 returned matches all fields specified by the "includes" unless they
396 are matched by "excludes"
397<P>
398<DD><DL>
399<DT><B>Parameters:</B><DD><CODE>includes</CODE> - a selector identifying field names that should be selected<DD><CODE>excludes</CODE> - a selector identifying field names that should be
400        <i>not</i> be selected, even if they are matched by the 'includes'
401        selector
402<DT><B>Returns:</B><DD>Either a new FieldNameSelector or one of the input selecors
403         if the combination lends itself to optimization.</DL>
404</DD>
405</DL>
406<HR>
407
408<A NAME="createFieldNameSelector(org.apache.solr.core.SolrResourceLoader, org.apache.solr.schema.IndexSchema, java.util.Set, java.util.Set, java.util.Collection, java.util.Collection, org.apache.solr.update.processor.FieldMutatingUpdateProcessor.FieldNameSelector)"><!-- --></A><H3>
409createFieldNameSelector</H3>
410<PRE>
411public static <A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A> <B>createFieldNameSelector</B>(<A HREF="../../../../../org/apache/solr/core/SolrResourceLoader.html" title="class in org.apache.solr.core">SolrResourceLoader</A>&nbsp;loader,
412                                                                                     <A HREF="../../../../../org/apache/solr/schema/IndexSchema.html" title="class in org.apache.solr.schema">IndexSchema</A>&nbsp;schema,
413                                                                                     <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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;&nbsp;fields,
414                                                                                     <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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;&nbsp;typeNames,
415                                                                                     <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;&nbsp;typeClasses,
416                                                                                     <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/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</A>&gt;&nbsp;regexes,
417                                                                                     <A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor">FieldMutatingUpdateProcessor.FieldNameSelector</A>&nbsp;defSelector)</PRE>
418<DL>
419<DD>Utility method that can be used to define a FieldNameSelector
420 using the same types of rules as the FieldMutatingUpdateProcessor init
421 code.  This may be useful for Factories that wish to define default
422 selectors in similar terms to what the configuration would look like.
423<P>
424<DD><DL>
425<DT><B>NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.</B></DT>
426  <DD></DD>
427</DL>
428</DD>
429</DL>
430<!-- ========= END OF CLASS DATA ========= -->
431<HR>
432
433
434<!-- ======= START OF BOTTOM NAVBAR ====== -->
435<A NAME="navbar_bottom"><!-- --></A>
436<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
437<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
438<TR>
439<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
440<A NAME="navbar_bottom_firstrow"><!-- --></A>
441<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
442  <TR ALIGN="center" VALIGN="top">
443  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
444  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
445  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
446  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FieldMutatingUpdateProcessor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
447  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
448  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
449  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
450  </TR>
451</TABLE>
452</TD>
453<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
454</EM>
455</TD>
456</TR>
457
458<TR>
459<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
460&nbsp;<A HREF="../../../../../org/apache/solr/update/processor/FieldLengthUpdateProcessorFactory.html" title="class in org.apache.solr.update.processor"><B>PREV CLASS</B></A>&nbsp;
461&nbsp;<A HREF="../../../../../org/apache/solr/update/processor/FieldMutatingUpdateProcessor.FieldNameSelector.html" title="interface in org.apache.solr.update.processor"><B>NEXT CLASS</B></A></FONT></TD>
462<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
463  <A HREF="../../../../../index.html?org/apache/solr/update/processor/FieldMutatingUpdateProcessor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
464&nbsp;<A HREF="FieldMutatingUpdateProcessor.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
465&nbsp;<SCRIPT type="text/javascript">
466  <!--
467  if(window==top) {
468    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
469  }
470  //-->
471</SCRIPT>
472<NOSCRIPT>
473  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
474</NOSCRIPT>
475
476
477</FONT></TD>
478</TR>
479<TR>
480<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
481  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
482<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
483DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
484</TR>
485</TABLE>
486<A NAME="skip-navbar_bottom"></A>
487<!-- ======== END OF BOTTOM NAVBAR ======= -->
488
489<HR>
490
491          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
492          <script src='../../../../../prettify.js' type='text/javascript'></script>
493          <script type='text/javascript'>
494            (function(){
495              var oldonload = window.onload;
496              if (typeof oldonload != 'function') {
497                window.onload = prettyPrint;
498              } else {
499                window.onload = function() {
500                  oldonload();
501                  prettyPrint();
502                }
503              }
504            })();
505          </script>
506       
507</BODY>
508</HTML>
Note: See TracBrowser for help on using the repository browser.