source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/schema/TextField.html @ 7588

Revision 7588, 49.3 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>
8TextField (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="TextField (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/TextField.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/schema/StrFieldSource.html" title="class in org.apache.solr.schema"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/schema/TrieDateField.html" title="class in org.apache.solr.schema"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../index.html?org/apache/solr/schema/TextField.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="TextField.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_classes_inherited_from_class_org.apache.solr.schema.FieldType">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.schema</FONT>
92<BR>
93Class TextField</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/schema/FieldProperties.html" title="class in org.apache.solr.schema">org.apache.solr.schema.FieldProperties</A>
97      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">org.apache.solr.schema.FieldType</A>
98          <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.schema.TextField</B>
99</PRE>
100<HR>
101<DL>
102<DT><PRE>public class <B>TextField</B><DT>extends <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></DL>
103</PRE>
104
105<P>
106<code>TextField</code> is the basic type for configurable text analysis.
107 Analyzers for field types using this implementation should be defined in the schema.
108<P>
109
110<P>
111<HR>
112
113<P>
114<!-- ======== NESTED CLASS SUMMARY ======== -->
115
116<A NAME="nested_class_summary"><!-- --></A>
117<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
118<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
119<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
120<B>Nested Class Summary</B></FONT></TH>
121</TR>
122</TABLE>
123&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.schema.FieldType"><!-- --></A>
124<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
125<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
126<TH ALIGN="left"><B>Nested classes/interfaces inherited from class org.apache.solr.schema.<A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></B></TH>
127</TR>
128<TR BGCOLOR="white" CLASS="TableRowColor">
129<TD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.DefaultAnalyzer.html" title="class in org.apache.solr.schema">FieldType.DefaultAnalyzer</A></CODE></TD>
130</TR>
131</TABLE>
132&nbsp;
133<!-- =========== FIELD SUMMARY =========== -->
134
135<A NAME="field_summary"><!-- --></A>
136<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
137<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
138<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
139<B>Field Summary</B></FONT></TH>
140</TR>
141<TR BGCOLOR="white" CLASS="TableRowColor">
142<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
143<CODE>protected &nbsp;boolean</CODE></FONT></TD>
144<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/TextField.html#autoGeneratePhraseQueries">autoGeneratePhraseQueries</A></B></CODE>
145
146<BR>
147&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
148</TR>
149<TR BGCOLOR="white" CLASS="TableRowColor">
150<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151<CODE>protected &nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A></CODE></FONT></TD>
152<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/TextField.html#multiTermAnalyzer">multiTermAnalyzer</A></B></CODE>
153
154<BR>
155&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Analyzer set by schema for text types to use when searching fields
156 of this type, subclasses can set analyzer themselves or override
157 getAnalyzer()
158 This analyzer is used to process wildcard, prefix, regex and other multiterm queries.</TD>
159</TR>
160</TABLE>
161&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.schema.FieldType"><!-- --></A>
162<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
163<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
164<TH ALIGN="left"><B>Fields inherited from class org.apache.solr.schema.<A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></B></TH>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#analyzer">analyzer</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#args">args</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#falseProperties">falseProperties</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#log">log</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#POLY_FIELD_SEPARATOR">POLY_FIELD_SEPARATOR</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#postingsFormat">postingsFormat</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#queryAnalyzer">queryAnalyzer</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#similarity">similarity</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#trueProperties">trueProperties</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#typeName">typeName</A></CODE></TD>
168</TR>
169</TABLE>
170&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.schema.FieldProperties"><!-- --></A>
171<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
172<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
173<TH ALIGN="left"><B>Fields inherited from class org.apache.solr.schema.<A HREF="../../../../org/apache/solr/schema/FieldProperties.html" title="class in org.apache.solr.schema">FieldProperties</A></B></TH>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD><CODE><A HREF="../../../../org/apache/solr/schema/FieldProperties.html#BINARY">BINARY</A>, <A HREF="../../../../org/apache/solr/schema/FieldProperties.html#INDEXED">INDEXED</A>, <A HREF="../../../../org/apache/solr/schema/FieldProperties.html#MULTIVALUED">MULTIVALUED</A>, <A HREF="../../../../org/apache/solr/schema/FieldProperties.html#OMIT_NORMS">OMIT_NORMS</A>, <A HREF="../../../../org/apache/solr/schema/FieldProperties.html#OMIT_POSITIONS">OMIT_POSITIONS</A>, <A HREF="../../../../org/apache/solr/schema/FieldProperties.html#OMIT_TF_POSITIONS">OMIT_TF_POSITIONS</A>, <A HREF="../../../../org/apache/solr/schema/FieldProperties.html#REQUIRED">REQUIRED</A>, <A HREF="../../../../org/apache/solr/schema/FieldProperties.html#SORT_MISSING_FIRST">SORT_MISSING_FIRST</A>, <A HREF="../../../../org/apache/solr/schema/FieldProperties.html#SORT_MISSING_LAST">SORT_MISSING_LAST</A>, <A HREF="../../../../org/apache/solr/schema/FieldProperties.html#STORE_TERMOFFSETS">STORE_TERMOFFSETS</A>, <A HREF="../../../../org/apache/solr/schema/FieldProperties.html#STORE_TERMPOSITIONS">STORE_TERMPOSITIONS</A>, <A HREF="../../../../org/apache/solr/schema/FieldProperties.html#STORE_TERMVECTORS">STORE_TERMVECTORS</A>, <A HREF="../../../../org/apache/solr/schema/FieldProperties.html#STORED">STORED</A>, <A HREF="../../../../org/apache/solr/schema/FieldProperties.html#TOKENIZED">TOKENIZED</A></CODE></TD>
177</TR>
178</TABLE>
179&nbsp;
180<!-- ======== CONSTRUCTOR SUMMARY ======== -->
181
182<A NAME="constructor_summary"><!-- --></A>
183<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
185<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
186<B>Constructor Summary</B></FONT></TH>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/TextField.html#TextField()">TextField</A></B>()</CODE>
190
191<BR>
192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
193</TR>
194</TABLE>
195&nbsp;
196<!-- ========== METHOD SUMMARY =========== -->
197
198<A NAME="method_summary"><!-- --></A>
199<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
200<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
201<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
202<B>Method Summary</B></FONT></TH>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206<CODE>static&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A></CODE></FONT></TD>
207<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/TextField.html#analyzeMultiTerm(java.lang.String, java.lang.String, org.apache.lucene.analysis.Analyzer)">analyzeMultiTerm</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>&nbsp;field,
208                 <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;part,
209                 <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A>&nbsp;analyzerIn)</CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>&nbsp;boolean</CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/TextField.html#getAutoGeneratePhraseQueries()">getAutoGeneratePhraseQueries</A></B>()</CODE>
218
219<BR>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A></CODE></FONT></TD>
225<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/TextField.html#getFieldQuery(org.apache.solr.search.QParser, org.apache.solr.schema.SchemaField, java.lang.String)">getFieldQuery</A></B>(<A HREF="../../../../org/apache/solr/search/QParser.html" title="class in org.apache.solr.search">QParser</A>&nbsp;parser,
226              <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
227              <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;externalVal)</CODE>
228
229<BR>
230&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a Query instance for doing searches against a field.</TD>
231</TR>
232<TR BGCOLOR="white" CLASS="TableRowColor">
233<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
234<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A></CODE></FONT></TD>
235<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/TextField.html#getMultiTermAnalyzer()">getMultiTermAnalyzer</A></B>()</CODE>
236
237<BR>
238&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the Analyzer to be used when searching fields of this type when mult-term queries are specified.</TD>
239</TR>
240<TR BGCOLOR="white" CLASS="TableRowColor">
241<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
242<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A></CODE></FONT></TD>
243<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/TextField.html#getRangeQuery(org.apache.solr.search.QParser, org.apache.solr.schema.SchemaField, java.lang.String, java.lang.String, boolean, boolean)">getRangeQuery</A></B>(<A HREF="../../../../org/apache/solr/search/QParser.html" title="class in org.apache.solr.search">QParser</A>&nbsp;parser,
244              <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
245              <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;part1,
246              <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;part2,
247              boolean&nbsp;minInclusive,
248              boolean&nbsp;maxInclusive)</CODE>
249
250<BR>
251&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a Query instance for doing range searches on this field type.</TD>
252</TR>
253<TR BGCOLOR="white" CLASS="TableRowColor">
254<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
255<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/SortField.html?is-external=true" title="class or interface in org.apache.lucene.search">SortField</A></CODE></FONT></TD>
256<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/TextField.html#getSortField(org.apache.solr.schema.SchemaField, boolean)">getSortField</A></B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
257             boolean&nbsp;reverse)</CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the SortField instance that should be used to sort fields
261 of this type.</TD>
262</TR>
263<TR BGCOLOR="white" CLASS="TableRowColor">
264<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
265<CODE>protected &nbsp;void</CODE></FONT></TD>
266<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/TextField.html#init(org.apache.solr.schema.IndexSchema, java.util.Map)">init</A></B>(<A HREF="../../../../org/apache/solr/schema/IndexSchema.html" title="class in org.apache.solr.schema">IndexSchema</A>&nbsp;schema,
267     <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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;args)</CODE>
268
269<BR>
270&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;subclasses should initialize themselves with the args provided
271 and remove valid arguments.</TD>
272</TR>
273<TR BGCOLOR="white" CLASS="TableRowColor">
274<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
275<CODE>&nbsp;void</CODE></FONT></TD>
276<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/TextField.html#setAnalyzer(org.apache.lucene.analysis.Analyzer)">setAnalyzer</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A>&nbsp;analyzer)</CODE>
277
278<BR>
279&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the Analyzer to be used when indexing fields of this type.</TD>
280</TR>
281<TR BGCOLOR="white" CLASS="TableRowColor">
282<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
283<CODE>&nbsp;void</CODE></FONT></TD>
284<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/TextField.html#setMultiTermAnalyzer(org.apache.lucene.analysis.Analyzer)">setMultiTermAnalyzer</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A>&nbsp;analyzer)</CODE>
285
286<BR>
287&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
288</TR>
289<TR BGCOLOR="white" CLASS="TableRowColor">
290<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
291<CODE>&nbsp;void</CODE></FONT></TD>
292<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/TextField.html#setQueryAnalyzer(org.apache.lucene.analysis.Analyzer)">setQueryAnalyzer</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A>&nbsp;analyzer)</CODE>
293
294<BR>
295&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the Analyzer to be used when querying fields of this type.</TD>
296</TR>
297<TR BGCOLOR="white" CLASS="TableRowColor">
298<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
299<CODE>&nbsp;<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></CODE></FONT></TD>
300<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/TextField.html#toObject(org.apache.solr.schema.SchemaField, org.apache.lucene.util.BytesRef)">toObject</A></B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;sf,
301         <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>&nbsp;term)</CODE>
302
303<BR>
304&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
305</TR>
306<TR BGCOLOR="white" CLASS="TableRowColor">
307<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
308<CODE>&nbsp;void</CODE></FONT></TD>
309<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/TextField.html#write(org.apache.solr.response.TextResponseWriter, java.lang.String, org.apache.lucene.index.IndexableField)">write</A></B>(<A HREF="../../../../org/apache/solr/response/TextResponseWriter.html" title="class in org.apache.solr.response">TextResponseWriter</A>&nbsp;writer,
310      <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;name,
311      <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexableField.html?is-external=true" title="class or interface in org.apache.lucene.index">IndexableField</A>&nbsp;f)</CODE>
312
313<BR>
314&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;calls back to TextResponseWriter to write the field value</TD>
315</TR>
316</TABLE>
317&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.schema.FieldType"><!-- --></A>
318<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
319<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
320<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.schema.<A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></B></TH>
321</TR>
322<TR BGCOLOR="white" CLASS="TableRowColor">
323<TD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#createField(org.apache.solr.schema.SchemaField, java.lang.Object, float)">createField</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#createField(java.lang.String, java.lang.String, org.apache.lucene.document.FieldType, float)">createField</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#createFields(org.apache.solr.schema.SchemaField, java.lang.Object, float)">createFields</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getAnalyzer()">getAnalyzer</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getArg(java.lang.String, java.util.Map)">getArg</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getIndexOptions(org.apache.solr.schema.SchemaField, java.lang.String)">getIndexOptions</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getPostingsFormat()">getPostingsFormat</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getQueryAnalyzer()">getQueryAnalyzer</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getSimilarity()">getSimilarity</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getStringSort(org.apache.solr.schema.SchemaField, boolean)">getStringSort</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getTypeName()">getTypeName</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getValueSource(org.apache.solr.schema.SchemaField, org.apache.solr.search.QParser)">getValueSource</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#hasProperty(int)">hasProperty</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#indexedToReadable(org.apache.lucene.util.BytesRef, org.apache.lucene.util.CharsRef)">indexedToReadable</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#indexedToReadable(java.lang.String)">indexedToReadable</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#isMultiValued()">isMultiValued</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#isPolyField()">isPolyField</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#isTokenized()">isTokenized</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#multiValuedFieldCache()">multiValuedFieldCache</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#readableToIndexed(java.lang.CharSequence, org.apache.lucene.util.BytesRef)">readableToIndexed</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#readableToIndexed(java.lang.String)">readableToIndexed</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#restrictProps(int)">restrictProps</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#setSimilarity(org.apache.lucene.search.similarities.Similarity)">setSimilarity</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#storedToIndexed(org.apache.lucene.index.IndexableField)">storedToIndexed</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#storedToReadable(org.apache.lucene.index.IndexableField)">storedToReadable</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#toExternal(org.apache.lucene.index.IndexableField)">toExternal</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#toInternal(java.lang.String)">toInternal</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#toObject(org.apache.lucene.index.IndexableField)">toObject</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#toString()">toString</A></CODE></TD>
324</TR>
325</TABLE>
326&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
327<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
328<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
329<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>
330</TR>
331<TR BGCOLOR="white" CLASS="TableRowColor">
332<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#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>
333</TR>
334</TABLE>
335&nbsp;
336<P>
337
338<!-- ============ FIELD DETAIL =========== -->
339
340<A NAME="field_detail"><!-- --></A>
341<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
342<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
343<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
344<B>Field Detail</B></FONT></TH>
345</TR>
346</TABLE>
347
348<A NAME="autoGeneratePhraseQueries"><!-- --></A><H3>
349autoGeneratePhraseQueries</H3>
350<PRE>
351protected boolean <B>autoGeneratePhraseQueries</B></PRE>
352<DL>
353<DL>
354</DL>
355</DL>
356<HR>
357
358<A NAME="multiTermAnalyzer"><!-- --></A><H3>
359multiTermAnalyzer</H3>
360<PRE>
361protected <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A> <B>multiTermAnalyzer</B></PRE>
362<DL>
363<DD>Analyzer set by schema for text types to use when searching fields
364 of this type, subclasses can set analyzer themselves or override
365 getAnalyzer()
366 This analyzer is used to process wildcard, prefix, regex and other multiterm queries. It
367 assembles a list of tokenizer +filters that "make sense" for this, primarily accent folding and
368 lowercasing filters, and charfilters.
369<P>
370<DL>
371<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/TextField.html#getMultiTermAnalyzer()"><CODE>getMultiTermAnalyzer()</CODE></A>,
372<A HREF="../../../../org/apache/solr/schema/TextField.html#setMultiTermAnalyzer(org.apache.lucene.analysis.Analyzer)"><CODE>setMultiTermAnalyzer(org.apache.lucene.analysis.Analyzer)</CODE></A></DL>
373</DL>
374
375<!-- ========= CONSTRUCTOR DETAIL ======== -->
376
377<A NAME="constructor_detail"><!-- --></A>
378<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
379<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
380<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
381<B>Constructor Detail</B></FONT></TH>
382</TR>
383</TABLE>
384
385<A NAME="TextField()"><!-- --></A><H3>
386TextField</H3>
387<PRE>
388public <B>TextField</B>()</PRE>
389<DL>
390</DL>
391
392<!-- ============ METHOD DETAIL ========== -->
393
394<A NAME="method_detail"><!-- --></A>
395<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
396<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
397<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
398<B>Method Detail</B></FONT></TH>
399</TR>
400</TABLE>
401
402<A NAME="init(org.apache.solr.schema.IndexSchema, java.util.Map)"><!-- --></A><H3>
403init</H3>
404<PRE>
405protected void <B>init</B>(<A HREF="../../../../org/apache/solr/schema/IndexSchema.html" title="class in org.apache.solr.schema">IndexSchema</A>&nbsp;schema,
406                    <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<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;args)</PRE>
407<DL>
408<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#init(org.apache.solr.schema.IndexSchema, java.util.Map)">FieldType</A></CODE></B></DD>
409<DD>subclasses should initialize themselves with the args provided
410 and remove valid arguments.  leftover arguments will cause an exception.
411 Common boolean properties have already been handled.
412<P>
413<DD><DL>
414<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#init(org.apache.solr.schema.IndexSchema, java.util.Map)">init</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
415</DD>
416<DD><DL>
417</DL>
418</DD>
419</DL>
420<HR>
421
422<A NAME="getMultiTermAnalyzer()"><!-- --></A><H3>
423getMultiTermAnalyzer</H3>
424<PRE>
425public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A> <B>getMultiTermAnalyzer</B>()</PRE>
426<DL>
427<DD>Returns the Analyzer to be used when searching fields of this type when mult-term queries are specified.
428 <p>
429 This method may be called many times, at any time.
430 </p>
431<P>
432<DD><DL>
433<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#getAnalyzer()"><CODE>FieldType.getAnalyzer()</CODE></A></DL>
434</DD>
435</DL>
436<HR>
437
438<A NAME="setMultiTermAnalyzer(org.apache.lucene.analysis.Analyzer)"><!-- --></A><H3>
439setMultiTermAnalyzer</H3>
440<PRE>
441public void <B>setMultiTermAnalyzer</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A>&nbsp;analyzer)</PRE>
442<DL>
443<DD><DL>
444</DL>
445</DD>
446</DL>
447<HR>
448
449<A NAME="getAutoGeneratePhraseQueries()"><!-- --></A><H3>
450getAutoGeneratePhraseQueries</H3>
451<PRE>
452public boolean <B>getAutoGeneratePhraseQueries</B>()</PRE>
453<DL>
454<DD><DL>
455</DL>
456</DD>
457</DL>
458<HR>
459
460<A NAME="getSortField(org.apache.solr.schema.SchemaField, boolean)"><!-- --></A><H3>
461getSortField</H3>
462<PRE>
463public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/SortField.html?is-external=true" title="class or interface in org.apache.lucene.search">SortField</A> <B>getSortField</B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
464                              boolean&nbsp;reverse)</PRE>
465<DL>
466<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getSortField(org.apache.solr.schema.SchemaField, boolean)">FieldType</A></CODE></B></DD>
467<DD>Returns the SortField instance that should be used to sort fields
468 of this type.
469<P>
470<DD><DL>
471<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getSortField(org.apache.solr.schema.SchemaField, boolean)">getSortField</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
472</DD>
473<DD><DL>
474<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/SchemaField.html#checkSortability()"><CODE>SchemaField.checkSortability()</CODE></A></DL>
475</DD>
476</DL>
477<HR>
478
479<A NAME="write(org.apache.solr.response.TextResponseWriter, java.lang.String, org.apache.lucene.index.IndexableField)"><!-- --></A><H3>
480write</H3>
481<PRE>
482public void <B>write</B>(<A HREF="../../../../org/apache/solr/response/TextResponseWriter.html" title="class in org.apache.solr.response">TextResponseWriter</A>&nbsp;writer,
483                  <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;name,
484                  <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexableField.html?is-external=true" title="class or interface in org.apache.lucene.index">IndexableField</A>&nbsp;f)
485           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>
486<DL>
487<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#write(org.apache.solr.response.TextResponseWriter, java.lang.String, org.apache.lucene.index.IndexableField)">FieldType</A></CODE></B></DD>
488<DD>calls back to TextResponseWriter to write the field value
489<P>
490<DD><DL>
491<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#write(org.apache.solr.response.TextResponseWriter, java.lang.String, org.apache.lucene.index.IndexableField)">write</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
492</DD>
493<DD><DL>
494
495<DT><B>Throws:</B>
496<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>
497</DD>
498</DL>
499<HR>
500
501<A NAME="getFieldQuery(org.apache.solr.search.QParser, org.apache.solr.schema.SchemaField, java.lang.String)"><!-- --></A><H3>
502getFieldQuery</H3>
503<PRE>
504public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A> <B>getFieldQuery</B>(<A HREF="../../../../org/apache/solr/search/QParser.html" title="class in org.apache.solr.search">QParser</A>&nbsp;parser,
505                           <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
506                           <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;externalVal)</PRE>
507<DL>
508<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getFieldQuery(org.apache.solr.search.QParser, org.apache.solr.schema.SchemaField, java.lang.String)">FieldType</A></CODE></B></DD>
509<DD>Returns a Query instance for doing searches against a field.
510<P>
511<DD><DL>
512<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getFieldQuery(org.apache.solr.search.QParser, org.apache.solr.schema.SchemaField, java.lang.String)">getFieldQuery</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
513</DD>
514<DD><DL>
515<DT><B>Parameters:</B><DD><CODE>parser</CODE> - The <A HREF="../../../../org/apache/solr/search/QParser.html" title="class in org.apache.solr.search"><CODE>QParser</CODE></A> calling the method<DD><CODE>field</CODE> - The <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema"><CODE>SchemaField</CODE></A> of the field to search<DD><CODE>externalVal</CODE> - The String representation of the value to search
516<DT><B>Returns:</B><DD>The <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search"><CODE>Query</CODE></A> instance.  This implementation returns a <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/TermQuery.html?is-external=true" title="class or interface in org.apache.lucene.search"><CODE>TermQuery</CODE></A> but overriding queries may not</DL>
517</DD>
518</DL>
519<HR>
520
521<A NAME="toObject(org.apache.solr.schema.SchemaField, org.apache.lucene.util.BytesRef)"><!-- --></A><H3>
522toObject</H3>
523<PRE>
524public <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>toObject</B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;sf,
525                       <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>&nbsp;term)</PRE>
526<DL>
527<DD><DL>
528<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#toObject(org.apache.solr.schema.SchemaField, org.apache.lucene.util.BytesRef)">toObject</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
529</DD>
530<DD><DL>
531</DL>
532</DD>
533</DL>
534<HR>
535
536<A NAME="setAnalyzer(org.apache.lucene.analysis.Analyzer)"><!-- --></A><H3>
537setAnalyzer</H3>
538<PRE>
539public void <B>setAnalyzer</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A>&nbsp;analyzer)</PRE>
540<DL>
541<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#setAnalyzer(org.apache.lucene.analysis.Analyzer)">FieldType</A></CODE></B></DD>
542<DD>Sets the Analyzer to be used when indexing fields of this type.
543
544 <p>
545 The default implementation throws a SolrException. 
546 Subclasses that override this method need to ensure the behavior
547 of the analyzer is consistent with the implementation of toInternal.
548 </p>
549<P>
550<DD><DL>
551<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#setAnalyzer(org.apache.lucene.analysis.Analyzer)">setAnalyzer</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
552</DD>
553<DD><DL>
554<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#toInternal(java.lang.String)"><CODE>FieldType.toInternal(java.lang.String)</CODE></A>,
555<A HREF="../../../../org/apache/solr/schema/FieldType.html#setQueryAnalyzer(org.apache.lucene.analysis.Analyzer)"><CODE>FieldType.setQueryAnalyzer(org.apache.lucene.analysis.Analyzer)</CODE></A>,
556<A HREF="../../../../org/apache/solr/schema/FieldType.html#getAnalyzer()"><CODE>FieldType.getAnalyzer()</CODE></A></DL>
557</DD>
558</DL>
559<HR>
560
561<A NAME="setQueryAnalyzer(org.apache.lucene.analysis.Analyzer)"><!-- --></A><H3>
562setQueryAnalyzer</H3>
563<PRE>
564public void <B>setQueryAnalyzer</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A>&nbsp;analyzer)</PRE>
565<DL>
566<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#setQueryAnalyzer(org.apache.lucene.analysis.Analyzer)">FieldType</A></CODE></B></DD>
567<DD>Sets the Analyzer to be used when querying fields of this type.
568
569 <p>
570 The default implementation throws a SolrException. 
571 Subclasses that override this method need to ensure the behavior
572 of the analyzer is consistent with the implementation of toInternal.
573 </p>
574<P>
575<DD><DL>
576<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#setQueryAnalyzer(org.apache.lucene.analysis.Analyzer)">setQueryAnalyzer</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
577</DD>
578<DD><DL>
579<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#toInternal(java.lang.String)"><CODE>FieldType.toInternal(java.lang.String)</CODE></A>,
580<A HREF="../../../../org/apache/solr/schema/FieldType.html#setAnalyzer(org.apache.lucene.analysis.Analyzer)"><CODE>FieldType.setAnalyzer(org.apache.lucene.analysis.Analyzer)</CODE></A>,
581<A HREF="../../../../org/apache/solr/schema/FieldType.html#getQueryAnalyzer()"><CODE>FieldType.getQueryAnalyzer()</CODE></A></DL>
582</DD>
583</DL>
584<HR>
585
586<A NAME="getRangeQuery(org.apache.solr.search.QParser, org.apache.solr.schema.SchemaField, java.lang.String, java.lang.String, boolean, boolean)"><!-- --></A><H3>
587getRangeQuery</H3>
588<PRE>
589public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A> <B>getRangeQuery</B>(<A HREF="../../../../org/apache/solr/search/QParser.html" title="class in org.apache.solr.search">QParser</A>&nbsp;parser,
590                           <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
591                           <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;part1,
592                           <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;part2,
593                           boolean&nbsp;minInclusive,
594                           boolean&nbsp;maxInclusive)</PRE>
595<DL>
596<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getRangeQuery(org.apache.solr.search.QParser, org.apache.solr.schema.SchemaField, java.lang.String, java.lang.String, boolean, boolean)">FieldType</A></CODE></B></DD>
597<DD>Returns a Query instance for doing range searches on this field type. <A HREF="../../../../org/apache/solr/search/SolrQueryParser.html" title="class in org.apache.solr.search"><CODE>SolrQueryParser</CODE></A>
598 currently passes part1 and part2 as null if they are '*' respectively. minInclusive and maxInclusive are both true
599 currently by SolrQueryParser but that may change in the future. Also, other QueryParser implementations may have
600 different semantics.
601 <p/>
602 Sub-classes should override this method to provide their own range query implementation. They should strive to
603 handle nulls in part1 and/or part2 as well as unequal minInclusive and maxInclusive parameters gracefully.
604<P>
605<DD><DL>
606<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getRangeQuery(org.apache.solr.search.QParser, org.apache.solr.schema.SchemaField, java.lang.String, java.lang.String, boolean, boolean)">getRangeQuery</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
607</DD>
608<DD><DL>
609<DD><CODE>field</CODE> - the schema field<DD><CODE>part1</CODE> - the lower boundary of the range, nulls are allowed.<DD><CODE>part2</CODE> - the upper boundary of the range, nulls are allowed<DD><CODE>minInclusive</CODE> - whether the minimum of the range is inclusive or not<DD><CODE>maxInclusive</CODE> - whether the maximum of the range is inclusive or not
610<DT><B>Returns:</B><DD>a Query instance to perform range search according to given parameters</DL>
611</DD>
612</DL>
613<HR>
614
615<A NAME="analyzeMultiTerm(java.lang.String, java.lang.String, org.apache.lucene.analysis.Analyzer)"><!-- --></A><H3>
616analyzeMultiTerm</H3>
617<PRE>
618public static <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A> <B>analyzeMultiTerm</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>&nbsp;field,
619                                        <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;part,
620                                        <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A>&nbsp;analyzerIn)</PRE>
621<DL>
622<DD><DL>
623</DL>
624</DD>
625</DL>
626<!-- ========= END OF CLASS DATA ========= -->
627<HR>
628
629
630<!-- ======= START OF BOTTOM NAVBAR ====== -->
631<A NAME="navbar_bottom"><!-- --></A>
632<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
633<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
634<TR>
635<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
636<A NAME="navbar_bottom_firstrow"><!-- --></A>
637<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
638  <TR ALIGN="center" VALIGN="top">
639  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
640  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
641  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
642  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TextField.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
643  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
644  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
645  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
646  </TR>
647</TABLE>
648</TD>
649<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
650</EM>
651</TD>
652</TR>
653
654<TR>
655<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
656&nbsp;<A HREF="../../../../org/apache/solr/schema/StrFieldSource.html" title="class in org.apache.solr.schema"><B>PREV CLASS</B></A>&nbsp;
657&nbsp;<A HREF="../../../../org/apache/solr/schema/TrieDateField.html" title="class in org.apache.solr.schema"><B>NEXT CLASS</B></A></FONT></TD>
658<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
659  <A HREF="../../../../index.html?org/apache/solr/schema/TextField.html" target="_top"><B>FRAMES</B></A>  &nbsp;
660&nbsp;<A HREF="TextField.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
661&nbsp;<SCRIPT type="text/javascript">
662  <!--
663  if(window==top) {
664    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
665  }
666  //-->
667</SCRIPT>
668<NOSCRIPT>
669  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
670</NOSCRIPT>
671
672
673</FONT></TD>
674</TR>
675<TR>
676<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
677  SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_org.apache.solr.schema.FieldType">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>
678<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
679DETAIL:&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>
680</TR>
681</TABLE>
682<A NAME="skip-navbar_bottom"></A>
683<!-- ======== END OF BOTTOM NAVBAR ======= -->
684
685<HR>
686
687          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
688          <script src='../../../../prettify.js' type='text/javascript'></script>
689          <script type='text/javascript'>
690            (function(){
691              var oldonload = window.onload;
692              if (typeof oldonload != 'function') {
693                window.onload = prettyPrint;
694              } else {
695                window.onload = function() {
696                  oldonload();
697                  prettyPrint();
698                }
699              }
700            })();
701          </script>
702       
703</BODY>
704</HTML>
Note: See TracBrowser for help on using the repository browser.