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

Revision 7588, 84.4 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>
8FieldType (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="FieldType (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/FieldType.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/FieldProperties.html" title="class in org.apache.solr.schema"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/schema/FieldType.DefaultAnalyzer.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/FieldType.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="FieldType.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.schema</FONT>
92<BR>
93Class FieldType</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 "><B>org.apache.solr.schema.FieldType</B>
98</PRE>
99<DL>
100<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/solr/schema/AbstractSubTypeFieldType.html" title="class in org.apache.solr.schema">AbstractSubTypeFieldType</A>, <A HREF="../../../../org/apache/solr/schema/BinaryField.html" title="class in org.apache.solr.schema">BinaryField</A>, <A HREF="../../../../org/apache/solr/schema/CollationField.html" title="class in org.apache.solr.schema">CollationField</A>, <A HREF="../../../../org/apache/solr/schema/CurrencyField.html" title="class in org.apache.solr.schema">CurrencyField</A>, <A HREF="../../../../org/apache/solr/schema/ExternalFileField.html" title="class in org.apache.solr.schema">ExternalFileField</A>, <A HREF="../../../../org/apache/solr/schema/GeoHashField.html" title="class in org.apache.solr.schema">GeoHashField</A>, <A HREF="../../../../org/apache/solr/schema/ICUCollationField.html" title="class in org.apache.solr.schema">ICUCollationField</A>, <A HREF="../../../../org/apache/solr/schema/PreAnalyzedField.html" title="class in org.apache.solr.schema">PreAnalyzedField</A>, <A HREF="../../../../org/apache/solr/schema/PrimitiveFieldType.html" title="class in org.apache.solr.schema">PrimitiveFieldType</A>, <A HREF="../../../../org/apache/solr/schema/RandomSortField.html" title="class in org.apache.solr.schema">RandomSortField</A>, <A HREF="../../../../org/apache/solr/schema/TextField.html" title="class in org.apache.solr.schema">TextField</A></DD>
101</DL>
102<HR>
103<DL>
104<DT><PRE>public abstract class <B>FieldType</B><DT>extends <A HREF="../../../../org/apache/solr/schema/FieldProperties.html" title="class in org.apache.solr.schema">FieldProperties</A></DL>
105</PRE>
106
107<P>
108Base class for all field types used by an index schema.
109<P>
110
111<P>
112<HR>
113
114<P>
115<!-- ======== NESTED CLASS SUMMARY ======== -->
116
117<A NAME="nested_class_summary"><!-- --></A>
118<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
119<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
120<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
121<B>Nested Class Summary</B></FONT></TH>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125<CODE>protected &nbsp;class</CODE></FONT></TD>
126<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.DefaultAnalyzer.html" title="class in org.apache.solr.schema">FieldType.DefaultAnalyzer</A></B></CODE>
127
128<BR>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default analyzer for types that only produce 1 verbatim token...</TD>
130</TR>
131</TABLE>
132&nbsp;<!-- =========== FIELD SUMMARY =========== -->
133
134<A NAME="field_summary"><!-- --></A>
135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
136<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
137<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
138<B>Field Summary</B></FONT></TH>
139</TR>
140<TR BGCOLOR="white" CLASS="TableRowColor">
141<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
142<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>
143<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#analyzer">analyzer</A></B></CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Analyzer set by schema for text types to use when indexing fields
147 of this type, subclasses can set analyzer themselves or override
148 getAnalyzer()</TD>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152<CODE>protected &nbsp;<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;</CODE></FONT></TD>
153<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#args">args</A></B></CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;additional arguments specified in the field type declaration</TD>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160<CODE>protected &nbsp;int</CODE></FONT></TD>
161<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#falseProperties">falseProperties</A></B></CODE>
162
163<BR>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;properties explicitly set to false</TD>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168<CODE>static&nbsp;org.slf4j.Logger</CODE></FONT></TD>
169<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#log">log</A></B></CODE>
170
171<BR>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
173</TR>
174<TR BGCOLOR="white" CLASS="TableRowColor">
175<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176<CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
177<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#POLY_FIELD_SEPARATOR">POLY_FIELD_SEPARATOR</A></B></CODE>
178
179<BR>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The default poly field separator.</TD>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184<CODE>protected &nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
185<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#postingsFormat">postingsFormat</A></B></CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The postings format used for this field type</TD>
189</TR>
190<TR BGCOLOR="white" CLASS="TableRowColor">
191<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
192<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>
193<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#queryAnalyzer">queryAnalyzer</A></B></CODE>
194
195<BR>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Analyzer set by schema for text types to use when searching fields
197 of this type, subclasses can set analyzer themselves or override
198 getAnalyzer()</TD>
199</TR>
200<TR BGCOLOR="white" CLASS="TableRowColor">
201<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202<CODE>protected &nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/similarities/Similarity.html?is-external=true" title="class or interface in org.apache.lucene.search.similarities">Similarity</A></CODE></FONT></TD>
203<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#similarity">similarity</A></B></CODE>
204
205<BR>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
207</TR>
208<TR BGCOLOR="white" CLASS="TableRowColor">
209<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
210<CODE>protected &nbsp;int</CODE></FONT></TD>
211<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#trueProperties">trueProperties</A></B></CODE>
212
213<BR>
214&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;properties explicitly set to true</TD>
215</TR>
216<TR BGCOLOR="white" CLASS="TableRowColor">
217<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218<CODE>protected &nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
219<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#typeName">typeName</A></B></CODE>
220
221<BR>
222&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of the type (not the name of the field)</TD>
223</TR>
224</TABLE>
225&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.schema.FieldProperties"><!-- --></A>
226<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
227<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
228<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>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<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>
232</TR>
233</TABLE>
234&nbsp;
235<!-- ======== CONSTRUCTOR SUMMARY ======== -->
236
237<A NAME="constructor_summary"><!-- --></A>
238<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
239<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
240<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
241<B>Constructor Summary</B></FONT></TH>
242</TR>
243<TR BGCOLOR="white" CLASS="TableRowColor">
244<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#FieldType()">FieldType</A></B>()</CODE>
245
246<BR>
247&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
248</TR>
249</TABLE>
250&nbsp;
251<!-- ========== METHOD SUMMARY =========== -->
252
253<A NAME="method_summary"><!-- --></A>
254<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
255<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
256<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
257<B>Method Summary</B></FONT></TH>
258</TR>
259<TR BGCOLOR="white" CLASS="TableRowColor">
260<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261<CODE>&nbsp;<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></CODE></FONT></TD>
262<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#createField(org.apache.solr.schema.SchemaField, java.lang.Object, float)">createField</A></B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
263            <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>&nbsp;value,
264            float&nbsp;boost)</CODE>
265
266<BR>
267&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used for adding a document when a field needs to be created from a
268 type and a string.</TD>
269</TR>
270<TR BGCOLOR="white" CLASS="TableRowColor">
271<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
272<CODE>protected &nbsp;<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></CODE></FONT></TD>
273<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#createField(java.lang.String, java.lang.String, org.apache.lucene.document.FieldType, float)">createField</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;name,
274            <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;val,
275            <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/document/FieldType.html?is-external=true" title="class or interface in org.apache.lucene.document">FieldType</A>&nbsp;type,
276            float&nbsp;boost)</CODE>
277
278<BR>
279&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create the field from native Lucene parts.</TD>
280</TR>
281<TR BGCOLOR="white" CLASS="TableRowColor">
282<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
283<CODE>&nbsp;<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>[]</CODE></FONT></TD>
284<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#createFields(org.apache.solr.schema.SchemaField, java.lang.Object, float)">createFields</A></B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
285             <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>&nbsp;value,
286             float&nbsp;boost)</CODE>
287
288<BR>
289&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given a <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema"><CODE>SchemaField</CODE></A>, create one or more <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"><CODE>IndexableField</CODE></A> instances</TD>
290</TR>
291<TR BGCOLOR="white" CLASS="TableRowColor">
292<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
293<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>
294<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#getAnalyzer()">getAnalyzer</A></B>()</CODE>
295
296<BR>
297&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the Analyzer to be used when indexing fields of this type.</TD>
298</TR>
299<TR BGCOLOR="white" CLASS="TableRowColor">
300<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
301<CODE>protected &nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
302<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#getArg(java.lang.String, java.util.Map)">getArg</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;n,
303       <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>
304
305<BR>
306&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
307</TR>
308<TR BGCOLOR="white" CLASS="TableRowColor">
309<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
310<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>
311<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.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,
312              <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
313              <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>
314
315<BR>
316&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a Query instance for doing searches against a field.</TD>
317</TR>
318<TR BGCOLOR="white" CLASS="TableRowColor">
319<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
320<CODE>protected &nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/FieldInfo.IndexOptions.html?is-external=true" title="class or interface in org.apache.lucene.index">FieldInfo.IndexOptions</A></CODE></FONT></TD>
321<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#getIndexOptions(org.apache.solr.schema.SchemaField, java.lang.String)">getIndexOptions</A></B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
322                <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;internalVal)</CODE>
323
324<BR>
325&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
326</TR>
327<TR BGCOLOR="white" CLASS="TableRowColor">
328<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
329<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
330<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#getPostingsFormat()">getPostingsFormat</A></B>()</CODE>
331
332<BR>
333&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
334</TR>
335<TR BGCOLOR="white" CLASS="TableRowColor">
336<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
337<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>
338<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#getQueryAnalyzer()">getQueryAnalyzer</A></B>()</CODE>
339
340<BR>
341&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the Analyzer to be used when searching fields of this type.</TD>
342</TR>
343<TR BGCOLOR="white" CLASS="TableRowColor">
344<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
345<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>
346<TD><CODE><B><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></B>(<A HREF="../../../../org/apache/solr/search/QParser.html" title="class in org.apache.solr.search">QParser</A>&nbsp;parser,
347              <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
348              <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,
349              <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,
350              boolean&nbsp;minInclusive,
351              boolean&nbsp;maxInclusive)</CODE>
352
353<BR>
354&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a Query instance for doing range searches on this field type.</TD>
355</TR>
356<TR BGCOLOR="white" CLASS="TableRowColor">
357<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
358<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/similarities/Similarity.html?is-external=true" title="class or interface in org.apache.lucene.search.similarities">Similarity</A></CODE></FONT></TD>
359<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#getSimilarity()">getSimilarity</A></B>()</CODE>
360
361<BR>
362&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the Similarity used when scoring fields of this type</TD>
363</TR>
364<TR BGCOLOR="white" CLASS="TableRowColor">
365<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
366<CODE>abstract &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>
367<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.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,
368             boolean&nbsp;top)</CODE>
369
370<BR>
371&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the SortField instance that should be used to sort fields
372 of this type.</TD>
373</TR>
374<TR BGCOLOR="white" CLASS="TableRowColor">
375<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
376<CODE>protected &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>
377<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#getStringSort(org.apache.solr.schema.SchemaField, boolean)">getStringSort</A></B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
378              boolean&nbsp;reverse)</CODE>
379
380<BR>
381&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility usable by subclasses when they want to get basic String sorting
382 using common checks.</TD>
383</TR>
384<TR BGCOLOR="white" CLASS="TableRowColor">
385<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
386<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
387<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#getTypeName()">getTypeName</A></B>()</CODE>
388
389<BR>
390&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Name of this FieldType as specified in the schema file</TD>
391</TR>
392<TR BGCOLOR="white" CLASS="TableRowColor">
393<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
394<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">ValueSource</A></CODE></FONT></TD>
395<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#getValueSource(org.apache.solr.schema.SchemaField, org.apache.solr.search.QParser)">getValueSource</A></B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
396               <A HREF="../../../../org/apache/solr/search/QParser.html" title="class in org.apache.solr.search">QParser</A>&nbsp;parser)</CODE>
397
398<BR>
399&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;called to get the default value source (normally, from the
400  Lucene FieldCache.)</TD>
401</TR>
402<TR BGCOLOR="white" CLASS="TableRowColor">
403<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
404<CODE>protected &nbsp;boolean</CODE></FONT></TD>
405<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#hasProperty(int)">hasProperty</A></B>(int&nbsp;p)</CODE>
406
407<BR>
408&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check if a property is set</TD>
409</TR>
410<TR BGCOLOR="white" CLASS="TableRowColor">
411<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
412<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/CharsRef.html?is-external=true" title="class or interface in org.apache.lucene.util">CharsRef</A></CODE></FONT></TD>
413<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#indexedToReadable(org.apache.lucene.util.BytesRef, org.apache.lucene.util.CharsRef)">indexedToReadable</A></B>(<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;input,
414                  <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/CharsRef.html?is-external=true" title="class or interface in org.apache.lucene.util">CharsRef</A>&nbsp;output)</CODE>
415
416<BR>
417&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given an indexed term, append the human readable representation</TD>
418</TR>
419<TR BGCOLOR="white" CLASS="TableRowColor">
420<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
421<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
422<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#indexedToReadable(java.lang.String)">indexedToReadable</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;indexedForm)</CODE>
423
424<BR>
425&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given an indexed term, return the human readable representation</TD>
426</TR>
427<TR BGCOLOR="white" CLASS="TableRowColor">
428<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
429<CODE>protected &nbsp;void</CODE></FONT></TD>
430<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.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,
431     <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>
432
433<BR>
434&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;subclasses should initialize themselves with the args provided
435 and remove valid arguments.</TD>
436</TR>
437<TR BGCOLOR="white" CLASS="TableRowColor">
438<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
439<CODE>&nbsp;boolean</CODE></FONT></TD>
440<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#isMultiValued()">isMultiValued</A></B>()</CODE>
441
442<BR>
443&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if fields can have multiple values</TD>
444</TR>
445<TR BGCOLOR="white" CLASS="TableRowColor">
446<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
447<CODE>&nbsp;boolean</CODE></FONT></TD>
448<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#isPolyField()">isPolyField</A></B>()</CODE>
449
450<BR>
451&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A "polyField" is a FieldType that can produce more than one IndexableField instance for a single value, via the <A HREF="../../../../org/apache/solr/schema/FieldType.html#createFields(org.apache.solr.schema.SchemaField, java.lang.Object, float)"><CODE>createFields(org.apache.solr.schema.SchemaField, Object, float)</CODE></A> method.</TD>
452</TR>
453<TR BGCOLOR="white" CLASS="TableRowColor">
454<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
455<CODE>&nbsp;boolean</CODE></FONT></TD>
456<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#isTokenized()">isTokenized</A></B>()</CODE>
457
458<BR>
459&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if fields of this type should be tokenized</TD>
460</TR>
461<TR BGCOLOR="white" CLASS="TableRowColor">
462<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
463<CODE>&nbsp;boolean</CODE></FONT></TD>
464<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#multiValuedFieldCache()">multiValuedFieldCache</A></B>()</CODE>
465
466<BR>
467&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if a single field value of this type has multiple logical values
468  for the purposes of faceting, sorting, etc.</TD>
469</TR>
470<TR BGCOLOR="white" CLASS="TableRowColor">
471<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
472<CODE>&nbsp;void</CODE></FONT></TD>
473<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#readableToIndexed(java.lang.CharSequence, org.apache.lucene.util.BytesRef)">readableToIndexed</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A>&nbsp;val,
474                  <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;result)</CODE>
475
476<BR>
477&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given the readable value, return the term value that will match it.</TD>
478</TR>
479<TR BGCOLOR="white" CLASS="TableRowColor">
480<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
481<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
482<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#readableToIndexed(java.lang.String)">readableToIndexed</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;val)</CODE>
483
484<BR>
485&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given the readable value, return the term value that will match it.</TD>
486</TR>
487<TR BGCOLOR="white" CLASS="TableRowColor">
488<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
489<CODE>protected &nbsp;void</CODE></FONT></TD>
490<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#restrictProps(int)">restrictProps</A></B>(int&nbsp;props)</CODE>
491
492<BR>
493&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;:TODO: document this method</TD>
494</TR>
495<TR BGCOLOR="white" CLASS="TableRowColor">
496<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
497<CODE>&nbsp;void</CODE></FONT></TD>
498<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.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>
499
500<BR>
501&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the Analyzer to be used when indexing fields of this type.</TD>
502</TR>
503<TR BGCOLOR="white" CLASS="TableRowColor">
504<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
505<CODE>&nbsp;void</CODE></FONT></TD>
506<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.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>
507
508<BR>
509&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the Analyzer to be used when querying fields of this type.</TD>
510</TR>
511<TR BGCOLOR="white" CLASS="TableRowColor">
512<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
513<CODE>&nbsp;void</CODE></FONT></TD>
514<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#setSimilarity(org.apache.lucene.search.similarities.Similarity)">setSimilarity</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/similarities/Similarity.html?is-external=true" title="class or interface in org.apache.lucene.search.similarities">Similarity</A>&nbsp;similarity)</CODE>
515
516<BR>
517&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the Similarity used when scoring fields of this type</TD>
518</TR>
519<TR BGCOLOR="white" CLASS="TableRowColor">
520<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
521<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
522<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#storedToIndexed(org.apache.lucene.index.IndexableField)">storedToIndexed</A></B>(<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>
523
524<BR>
525&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given the stored field, return the indexed form</TD>
526</TR>
527<TR BGCOLOR="white" CLASS="TableRowColor">
528<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
529<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
530<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#storedToReadable(org.apache.lucene.index.IndexableField)">storedToReadable</A></B>(<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>
531
532<BR>
533&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given the stored field, return the human readable representation</TD>
534</TR>
535<TR BGCOLOR="white" CLASS="TableRowColor">
536<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
537<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
538<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#toExternal(org.apache.lucene.index.IndexableField)">toExternal</A></B>(<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>
539
540<BR>
541&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert the stored-field format to an external (string, human readable)
542 value</TD>
543</TR>
544<TR BGCOLOR="white" CLASS="TableRowColor">
545<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
546<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
547<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#toInternal(java.lang.String)">toInternal</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;val)</CODE>
548
549<BR>
550&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert an external value (from XML update command or from query string)
551 into the internal format for both storing and indexing (which can be modified by any analyzers).</TD>
552</TR>
553<TR BGCOLOR="white" CLASS="TableRowColor">
554<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
555<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>
556<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#toObject(org.apache.lucene.index.IndexableField)">toObject</A></B>(<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>
557
558<BR>
559&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert the stored-field format to an external object.</TD>
560</TR>
561<TR BGCOLOR="white" CLASS="TableRowColor">
562<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
563<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>
564<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.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,
565         <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>
566
567<BR>
568&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
569</TR>
570<TR BGCOLOR="white" CLASS="TableRowColor">
571<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
572<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
573<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.html#toString()">toString</A></B>()</CODE>
574
575<BR>
576&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
577</TR>
578<TR BGCOLOR="white" CLASS="TableRowColor">
579<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
580<CODE>abstract &nbsp;void</CODE></FONT></TD>
581<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/FieldType.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,
582      <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,
583      <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>
584
585<BR>
586&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;calls back to TextResponseWriter to write the field value</TD>
587</TR>
588</TABLE>
589&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
590<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
591<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
592<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>
593</TR>
594<TR BGCOLOR="white" CLASS="TableRowColor">
595<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>
596</TR>
597</TABLE>
598&nbsp;
599<P>
600
601<!-- ============ FIELD DETAIL =========== -->
602
603<A NAME="field_detail"><!-- --></A>
604<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
605<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
606<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
607<B>Field Detail</B></FONT></TH>
608</TR>
609</TABLE>
610
611<A NAME="log"><!-- --></A><H3>
612log</H3>
613<PRE>
614public static final org.slf4j.Logger <B>log</B></PRE>
615<DL>
616<DL>
617</DL>
618</DL>
619<HR>
620
621<A NAME="POLY_FIELD_SEPARATOR"><!-- --></A><H3>
622POLY_FIELD_SEPARATOR</H3>
623<PRE>
624public static final <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>POLY_FIELD_SEPARATOR</B></PRE>
625<DL>
626<DD>The default poly field separator.
627<P>
628<DL>
629<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#createFields(org.apache.solr.schema.SchemaField, java.lang.Object, float)"><CODE>createFields(SchemaField, Object, float)</CODE></A>,
630<A HREF="../../../../org/apache/solr/schema/FieldType.html#isPolyField()"><CODE>isPolyField()</CODE></A>,
631<A HREF="../../../../constant-values.html#org.apache.solr.schema.FieldType.POLY_FIELD_SEPARATOR">Constant Field Values</A></DL>
632</DL>
633<HR>
634
635<A NAME="typeName"><!-- --></A><H3>
636typeName</H3>
637<PRE>
638protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>typeName</B></PRE>
639<DL>
640<DD>The name of the type (not the name of the field)
641<P>
642<DL>
643</DL>
644</DL>
645<HR>
646
647<A NAME="args"><!-- --></A><H3>
648args</H3>
649<PRE>
650protected <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; <B>args</B></PRE>
651<DL>
652<DD>additional arguments specified in the field type declaration
653<P>
654<DL>
655</DL>
656</DL>
657<HR>
658
659<A NAME="trueProperties"><!-- --></A><H3>
660trueProperties</H3>
661<PRE>
662protected int <B>trueProperties</B></PRE>
663<DL>
664<DD>properties explicitly set to true
665<P>
666<DL>
667</DL>
668</DL>
669<HR>
670
671<A NAME="falseProperties"><!-- --></A><H3>
672falseProperties</H3>
673<PRE>
674protected int <B>falseProperties</B></PRE>
675<DL>
676<DD>properties explicitly set to false
677<P>
678<DL>
679</DL>
680</DL>
681<HR>
682
683<A NAME="analyzer"><!-- --></A><H3>
684analyzer</H3>
685<PRE>
686protected <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>analyzer</B></PRE>
687<DL>
688<DD>Analyzer set by schema for text types to use when indexing fields
689 of this type, subclasses can set analyzer themselves or override
690 getAnalyzer()
691<P>
692<DL>
693<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#getAnalyzer()"><CODE>getAnalyzer()</CODE></A>,
694<A HREF="../../../../org/apache/solr/schema/FieldType.html#setAnalyzer(org.apache.lucene.analysis.Analyzer)"><CODE>setAnalyzer(org.apache.lucene.analysis.Analyzer)</CODE></A></DL>
695</DL>
696<HR>
697
698<A NAME="queryAnalyzer"><!-- --></A><H3>
699queryAnalyzer</H3>
700<PRE>
701protected <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>queryAnalyzer</B></PRE>
702<DL>
703<DD>Analyzer set by schema for text types to use when searching fields
704 of this type, subclasses can set analyzer themselves or override
705 getAnalyzer()
706<P>
707<DL>
708<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#getQueryAnalyzer()"><CODE>getQueryAnalyzer()</CODE></A>,
709<A HREF="../../../../org/apache/solr/schema/FieldType.html#setQueryAnalyzer(org.apache.lucene.analysis.Analyzer)"><CODE>setQueryAnalyzer(org.apache.lucene.analysis.Analyzer)</CODE></A></DL>
710</DL>
711<HR>
712
713<A NAME="similarity"><!-- --></A><H3>
714similarity</H3>
715<PRE>
716protected <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/similarities/Similarity.html?is-external=true" title="class or interface in org.apache.lucene.search.similarities">Similarity</A> <B>similarity</B></PRE>
717<DL>
718<DL>
719<DT><B>NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.</B></DT>
720  <DD></DD>
721</DL>
722</DL>
723<HR>
724
725<A NAME="postingsFormat"><!-- --></A><H3>
726postingsFormat</H3>
727<PRE>
728protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>postingsFormat</B></PRE>
729<DL>
730<DD>The postings format used for this field type
731<P>
732<DL>
733</DL>
734</DL>
735
736<!-- ========= CONSTRUCTOR DETAIL ======== -->
737
738<A NAME="constructor_detail"><!-- --></A>
739<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
740<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
741<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
742<B>Constructor Detail</B></FONT></TH>
743</TR>
744</TABLE>
745
746<A NAME="FieldType()"><!-- --></A><H3>
747FieldType</H3>
748<PRE>
749public <B>FieldType</B>()</PRE>
750<DL>
751</DL>
752
753<!-- ============ METHOD DETAIL ========== -->
754
755<A NAME="method_detail"><!-- --></A>
756<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
757<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
758<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
759<B>Method Detail</B></FONT></TH>
760</TR>
761</TABLE>
762
763<A NAME="isTokenized()"><!-- --></A><H3>
764isTokenized</H3>
765<PRE>
766public boolean <B>isTokenized</B>()</PRE>
767<DL>
768<DD>Returns true if fields of this type should be tokenized
769<P>
770<DD><DL>
771</DL>
772</DD>
773</DL>
774<HR>
775
776<A NAME="isMultiValued()"><!-- --></A><H3>
777isMultiValued</H3>
778<PRE>
779public boolean <B>isMultiValued</B>()</PRE>
780<DL>
781<DD>Returns true if fields can have multiple values
782<P>
783<DD><DL>
784</DL>
785</DD>
786</DL>
787<HR>
788
789<A NAME="hasProperty(int)"><!-- --></A><H3>
790hasProperty</H3>
791<PRE>
792protected boolean <B>hasProperty</B>(int&nbsp;p)</PRE>
793<DL>
794<DD>Check if a property is set
795<P>
796<DD><DL>
797</DL>
798</DD>
799</DL>
800<HR>
801
802<A NAME="isPolyField()"><!-- --></A><H3>
803isPolyField</H3>
804<PRE>
805public boolean <B>isPolyField</B>()</PRE>
806<DL>
807<DD>A "polyField" is a FieldType that can produce more than one IndexableField instance for a single value, via the <A HREF="../../../../org/apache/solr/schema/FieldType.html#createFields(org.apache.solr.schema.SchemaField, java.lang.Object, float)"><CODE>createFields(org.apache.solr.schema.SchemaField, Object, float)</CODE></A> method.  This is useful
808 when hiding the implementation details of a field from the Solr end user.  For instance, a spatial point may be represented by multiple different fields.
809<P>
810<DD><DL>
811
812<DT><B>Returns:</B><DD>true if the <A HREF="../../../../org/apache/solr/schema/FieldType.html#createFields(org.apache.solr.schema.SchemaField, java.lang.Object, float)"><CODE>createFields(org.apache.solr.schema.SchemaField, Object, float)</CODE></A> method may return more than one field</DL>
813</DD>
814</DL>
815<HR>
816
817<A NAME="multiValuedFieldCache()"><!-- --></A><H3>
818multiValuedFieldCache</H3>
819<PRE>
820public boolean <B>multiValuedFieldCache</B>()</PRE>
821<DL>
822<DD>Returns true if a single field value of this type has multiple logical values
823  for the purposes of faceting, sorting, etc.  Text fields normally return
824  true since each token/word is a logical value.
825<P>
826<DD><DL>
827</DL>
828</DD>
829</DL>
830<HR>
831
832<A NAME="init(org.apache.solr.schema.IndexSchema, java.util.Map)"><!-- --></A><H3>
833init</H3>
834<PRE>
835protected void <B>init</B>(<A HREF="../../../../org/apache/solr/schema/IndexSchema.html" title="class in org.apache.solr.schema">IndexSchema</A>&nbsp;schema,
836                    <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>
837<DL>
838<DD>subclasses should initialize themselves with the args provided
839 and remove valid arguments.  leftover arguments will cause an exception.
840 Common boolean properties have already been handled.
841<P>
842<DD><DL>
843</DL>
844</DD>
845</DL>
846<HR>
847
848<A NAME="getArg(java.lang.String, java.util.Map)"><!-- --></A><H3>
849getArg</H3>
850<PRE>
851protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getArg</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;n,
852                        <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>
853<DL>
854<DD><DL>
855</DL>
856</DD>
857</DL>
858<HR>
859
860<A NAME="restrictProps(int)"><!-- --></A><H3>
861restrictProps</H3>
862<PRE>
863protected void <B>restrictProps</B>(int&nbsp;props)</PRE>
864<DL>
865<DD>:TODO: document this method
866<P>
867<DD><DL>
868</DL>
869</DD>
870</DL>
871<HR>
872
873<A NAME="getTypeName()"><!-- --></A><H3>
874getTypeName</H3>
875<PRE>
876public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getTypeName</B>()</PRE>
877<DL>
878<DD>The Name of this FieldType as specified in the schema file
879<P>
880<DD><DL>
881</DL>
882</DD>
883</DL>
884<HR>
885
886<A NAME="toString()"><!-- --></A><H3>
887toString</H3>
888<PRE>
889public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
890<DL>
891<DD><DL>
892<DT><B>Overrides:</B><DD><CODE><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></CODE> in class <CODE><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></DL>
893</DD>
894<DD><DL>
895</DL>
896</DD>
897</DL>
898<HR>
899
900<A NAME="createField(org.apache.solr.schema.SchemaField, java.lang.Object, float)"><!-- --></A><H3>
901createField</H3>
902<PRE>
903public <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> <B>createField</B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
904                                  <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>&nbsp;value,
905                                  float&nbsp;boost)</PRE>
906<DL>
907<DD>Used for adding a document when a field needs to be created from a
908 type and a string.
909
910 <p>
911 By default, the indexed value is the same as the stored value
912 (taken from toInternal()).   Having a different representation for
913 external, internal, and indexed would present quite a few problems
914 given the current Lucene architecture.  An analyzer for adding docs
915 would need to translate internal->indexed while an analyzer for
916 querying would need to translate external-&gt;indexed.
917 </p>
918 <p>
919 The only other alternative to having internal==indexed would be to have
920 internal==external.   In this case, toInternal should convert to
921 the indexed representation, toExternal() should do nothing, and
922 createField() should *not* call toInternal, but use the external
923 value and set tokenized=true to get Lucene to convert to the
924 internal(indexed) form.
925 </p>
926
927 :TODO: clean up and clarify this explanation.
928<P>
929<DD><DL>
930<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#toInternal(java.lang.String)"><CODE>toInternal(java.lang.String)</CODE></A></DL>
931</DD>
932</DL>
933<HR>
934
935<A NAME="createField(java.lang.String, java.lang.String, org.apache.lucene.document.FieldType, float)"><!-- --></A><H3>
936createField</H3>
937<PRE>
938protected <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> <B>createField</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;name,
939                                     <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;val,
940                                     <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/document/FieldType.html?is-external=true" title="class or interface in org.apache.lucene.document">FieldType</A>&nbsp;type,
941                                     float&nbsp;boost)</PRE>
942<DL>
943<DD>Create the field from native Lucene parts.  Mostly intended for use by FieldTypes outputing multiple
944 Fields per SchemaField
945<P>
946<DD><DL>
947<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the field<DD><CODE>val</CODE> - The _internal_ value to index<DD><CODE>type</CODE> - <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/document/FieldType.html?is-external=true" title="class or interface in org.apache.lucene.document"><CODE>FieldType</CODE></A><DD><CODE>boost</CODE> - The boost value
948<DT><B>Returns:</B><DD>the <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"><CODE>IndexableField</CODE></A>.</DL>
949</DD>
950</DL>
951<HR>
952
953<A NAME="createFields(org.apache.solr.schema.SchemaField, java.lang.Object, float)"><!-- --></A><H3>
954createFields</H3>
955<PRE>
956public <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>[] <B>createFields</B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
957                                     <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>&nbsp;value,
958                                     float&nbsp;boost)</PRE>
959<DL>
960<DD>Given a <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema"><CODE>SchemaField</CODE></A>, create one or more <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"><CODE>IndexableField</CODE></A> instances
961<P>
962<DD><DL>
963<DT><B>Parameters:</B><DD><CODE>field</CODE> - the <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema"><CODE>SchemaField</CODE></A><DD><CODE>value</CODE> - The value to add to the field<DD><CODE>boost</CODE> - The boost to apply
964<DT><B>Returns:</B><DD>An array of <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"><CODE>IndexableField</CODE></A><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#createField(org.apache.solr.schema.SchemaField, java.lang.Object, float)"><CODE>createField(SchemaField, Object, float)</CODE></A>,
965<A HREF="../../../../org/apache/solr/schema/FieldType.html#isPolyField()"><CODE>isPolyField()</CODE></A></DL>
966</DD>
967</DL>
968<HR>
969
970<A NAME="getIndexOptions(org.apache.solr.schema.SchemaField, java.lang.String)"><!-- --></A><H3>
971getIndexOptions</H3>
972<PRE>
973protected <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/FieldInfo.IndexOptions.html?is-external=true" title="class or interface in org.apache.lucene.index">FieldInfo.IndexOptions</A> <B>getIndexOptions</B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
974                                                 <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;internalVal)</PRE>
975<DL>
976<DD><DL>
977</DL>
978</DD>
979</DL>
980<HR>
981
982<A NAME="toInternal(java.lang.String)"><!-- --></A><H3>
983toInternal</H3>
984<PRE>
985public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toInternal</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;val)</PRE>
986<DL>
987<DD>Convert an external value (from XML update command or from query string)
988 into the internal format for both storing and indexing (which can be modified by any analyzers).
989<P>
990<DD><DL>
991<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#toExternal(org.apache.lucene.index.IndexableField)"><CODE>toExternal(org.apache.lucene.index.IndexableField)</CODE></A></DL>
992</DD>
993</DL>
994<HR>
995
996<A NAME="toExternal(org.apache.lucene.index.IndexableField)"><!-- --></A><H3>
997toExternal</H3>
998<PRE>
999public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toExternal</B>(<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)</PRE>
1000<DL>
1001<DD>Convert the stored-field format to an external (string, human readable)
1002 value
1003<P>
1004<DD><DL>
1005<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#toInternal(java.lang.String)"><CODE>toInternal(java.lang.String)</CODE></A></DL>
1006</DD>
1007</DL>
1008<HR>
1009
1010<A NAME="toObject(org.apache.lucene.index.IndexableField)"><!-- --></A><H3>
1011toObject</H3>
1012<PRE>
1013public <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="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)</PRE>
1014<DL>
1015<DD>Convert the stored-field format to an external object.
1016<P>
1017<DD><DL>
1018<DT><B>Since:</B></DT>
1019  <DD>solr 1.3</DD>
1020<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#toInternal(java.lang.String)"><CODE>toInternal(java.lang.String)</CODE></A></DL>
1021</DD>
1022</DL>
1023<HR>
1024
1025<A NAME="toObject(org.apache.solr.schema.SchemaField, org.apache.lucene.util.BytesRef)"><!-- --></A><H3>
1026toObject</H3>
1027<PRE>
1028public <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,
1029                       <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>
1030<DL>
1031<DD><DL>
1032</DL>
1033</DD>
1034</DL>
1035<HR>
1036
1037<A NAME="indexedToReadable(java.lang.String)"><!-- --></A><H3>
1038indexedToReadable</H3>
1039<PRE>
1040public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>indexedToReadable</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;indexedForm)</PRE>
1041<DL>
1042<DD>Given an indexed term, return the human readable representation
1043<P>
1044<DD><DL>
1045</DL>
1046</DD>
1047</DL>
1048<HR>
1049
1050<A NAME="indexedToReadable(org.apache.lucene.util.BytesRef, org.apache.lucene.util.CharsRef)"><!-- --></A><H3>
1051indexedToReadable</H3>
1052<PRE>
1053public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/CharsRef.html?is-external=true" title="class or interface in org.apache.lucene.util">CharsRef</A> <B>indexedToReadable</B>(<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;input,
1054                                  <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/CharsRef.html?is-external=true" title="class or interface in org.apache.lucene.util">CharsRef</A>&nbsp;output)</PRE>
1055<DL>
1056<DD>Given an indexed term, append the human readable representation
1057<P>
1058<DD><DL>
1059</DL>
1060</DD>
1061</DL>
1062<HR>
1063
1064<A NAME="storedToReadable(org.apache.lucene.index.IndexableField)"><!-- --></A><H3>
1065storedToReadable</H3>
1066<PRE>
1067public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>storedToReadable</B>(<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)</PRE>
1068<DL>
1069<DD>Given the stored field, return the human readable representation
1070<P>
1071<DD><DL>
1072</DL>
1073</DD>
1074</DL>
1075<HR>
1076
1077<A NAME="storedToIndexed(org.apache.lucene.index.IndexableField)"><!-- --></A><H3>
1078storedToIndexed</H3>
1079<PRE>
1080public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>storedToIndexed</B>(<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)</PRE>
1081<DL>
1082<DD>Given the stored field, return the indexed form
1083<P>
1084<DD><DL>
1085</DL>
1086</DD>
1087</DL>
1088<HR>
1089
1090<A NAME="readableToIndexed(java.lang.String)"><!-- --></A><H3>
1091readableToIndexed</H3>
1092<PRE>
1093public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>readableToIndexed</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;val)</PRE>
1094<DL>
1095<DD>Given the readable value, return the term value that will match it.
1096<P>
1097<DD><DL>
1098</DL>
1099</DD>
1100</DL>
1101<HR>
1102
1103<A NAME="readableToIndexed(java.lang.CharSequence, org.apache.lucene.util.BytesRef)"><!-- --></A><H3>
1104readableToIndexed</H3>
1105<PRE>
1106public void <B>readableToIndexed</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A>&nbsp;val,
1107                              <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;result)</PRE>
1108<DL>
1109<DD>Given the readable value, return the term value that will match it.
1110<P>
1111<DD><DL>
1112</DL>
1113</DD>
1114</DL>
1115<HR>
1116
1117<A NAME="getAnalyzer()"><!-- --></A><H3>
1118getAnalyzer</H3>
1119<PRE>
1120public <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>getAnalyzer</B>()</PRE>
1121<DL>
1122<DD>Returns the Analyzer to be used when indexing fields of this type.
1123 <p>
1124 This method may be called many times, at any time.
1125 </p>
1126<P>
1127<DD><DL>
1128<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#getQueryAnalyzer()"><CODE>getQueryAnalyzer()</CODE></A></DL>
1129</DD>
1130</DL>
1131<HR>
1132
1133<A NAME="getQueryAnalyzer()"><!-- --></A><H3>
1134getQueryAnalyzer</H3>
1135<PRE>
1136public <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>getQueryAnalyzer</B>()</PRE>
1137<DL>
1138<DD>Returns the Analyzer to be used when searching fields of this type.
1139 <p>
1140 This method may be called many times, at any time.
1141 </p>
1142<P>
1143<DD><DL>
1144<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#getAnalyzer()"><CODE>getAnalyzer()</CODE></A></DL>
1145</DD>
1146</DL>
1147<HR>
1148
1149<A NAME="setAnalyzer(org.apache.lucene.analysis.Analyzer)"><!-- --></A><H3>
1150setAnalyzer</H3>
1151<PRE>
1152public 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>
1153<DL>
1154<DD>Sets the Analyzer to be used when indexing fields of this type.
1155
1156 <p>
1157 The default implementation throws a SolrException. 
1158 Subclasses that override this method need to ensure the behavior
1159 of the analyzer is consistent with the implementation of toInternal.
1160 </p>
1161<P>
1162<DD><DL>
1163<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#toInternal(java.lang.String)"><CODE>toInternal(java.lang.String)</CODE></A>,
1164<A HREF="../../../../org/apache/solr/schema/FieldType.html#setQueryAnalyzer(org.apache.lucene.analysis.Analyzer)"><CODE>setQueryAnalyzer(org.apache.lucene.analysis.Analyzer)</CODE></A>,
1165<A HREF="../../../../org/apache/solr/schema/FieldType.html#getAnalyzer()"><CODE>getAnalyzer()</CODE></A></DL>
1166</DD>
1167</DL>
1168<HR>
1169
1170<A NAME="setQueryAnalyzer(org.apache.lucene.analysis.Analyzer)"><!-- --></A><H3>
1171setQueryAnalyzer</H3>
1172<PRE>
1173public 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>
1174<DL>
1175<DD>Sets the Analyzer to be used when querying fields of this type.
1176
1177 <p>
1178 The default implementation throws a SolrException. 
1179 Subclasses that override this method need to ensure the behavior
1180 of the analyzer is consistent with the implementation of toInternal.
1181 </p>
1182<P>
1183<DD><DL>
1184<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#toInternal(java.lang.String)"><CODE>toInternal(java.lang.String)</CODE></A>,
1185<A HREF="../../../../org/apache/solr/schema/FieldType.html#setAnalyzer(org.apache.lucene.analysis.Analyzer)"><CODE>setAnalyzer(org.apache.lucene.analysis.Analyzer)</CODE></A>,
1186<A HREF="../../../../org/apache/solr/schema/FieldType.html#getQueryAnalyzer()"><CODE>getQueryAnalyzer()</CODE></A></DL>
1187</DD>
1188</DL>
1189<HR>
1190
1191<A NAME="getSimilarity()"><!-- --></A><H3>
1192getSimilarity</H3>
1193<PRE>
1194public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/similarities/Similarity.html?is-external=true" title="class or interface in org.apache.lucene.search.similarities">Similarity</A> <B>getSimilarity</B>()</PRE>
1195<DL>
1196<DD>Gets the Similarity used when scoring fields of this type
1197 
1198 <p>
1199 The default implementation returns null, which means this type
1200 has no custom similarity associated with it.
1201 </p>
1202<P>
1203<DD><DL>
1204<DT><B>NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.</B></DT>
1205  <DD></DD>
1206</DL>
1207</DD>
1208</DL>
1209<HR>
1210
1211<A NAME="setSimilarity(org.apache.lucene.search.similarities.Similarity)"><!-- --></A><H3>
1212setSimilarity</H3>
1213<PRE>
1214public void <B>setSimilarity</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/similarities/Similarity.html?is-external=true" title="class or interface in org.apache.lucene.search.similarities">Similarity</A>&nbsp;similarity)</PRE>
1215<DL>
1216<DD>Sets the Similarity used when scoring fields of this type
1217<P>
1218<DD><DL>
1219<DT><B>NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.</B></DT>
1220  <DD></DD>
1221</DL>
1222</DD>
1223</DL>
1224<HR>
1225
1226<A NAME="getPostingsFormat()"><!-- --></A><H3>
1227getPostingsFormat</H3>
1228<PRE>
1229public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getPostingsFormat</B>()</PRE>
1230<DL>
1231<DD><DL>
1232</DL>
1233</DD>
1234</DL>
1235<HR>
1236
1237<A NAME="write(org.apache.solr.response.TextResponseWriter, java.lang.String, org.apache.lucene.index.IndexableField)"><!-- --></A><H3>
1238write</H3>
1239<PRE>
1240public abstract void <B>write</B>(<A HREF="../../../../org/apache/solr/response/TextResponseWriter.html" title="class in org.apache.solr.response">TextResponseWriter</A>&nbsp;writer,
1241                           <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,
1242                           <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)
1243                    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>
1244<DL>
1245<DD>calls back to TextResponseWriter to write the field value
1246<P>
1247<DD><DL>
1248
1249<DT><B>Throws:</B>
1250<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>
1251</DD>
1252</DL>
1253<HR>
1254
1255<A NAME="getSortField(org.apache.solr.schema.SchemaField, boolean)"><!-- --></A><H3>
1256getSortField</H3>
1257<PRE>
1258public abstract <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,
1259                                       boolean&nbsp;top)</PRE>
1260<DL>
1261<DD>Returns the SortField instance that should be used to sort fields
1262 of this type.
1263<P>
1264<DD><DL>
1265<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/SchemaField.html#checkSortability()"><CODE>SchemaField.checkSortability()</CODE></A></DL>
1266</DD>
1267</DL>
1268<HR>
1269
1270<A NAME="getStringSort(org.apache.solr.schema.SchemaField, boolean)"><!-- --></A><H3>
1271getStringSort</H3>
1272<PRE>
1273protected <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>getStringSort</B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
1274                                  boolean&nbsp;reverse)</PRE>
1275<DL>
1276<DD>Utility usable by subclasses when they want to get basic String sorting
1277 using common checks.
1278<P>
1279<DD><DL>
1280<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/SchemaField.html#checkSortability()"><CODE>SchemaField.checkSortability()</CODE></A></DL>
1281</DD>
1282</DL>
1283<HR>
1284
1285<A NAME="getValueSource(org.apache.solr.schema.SchemaField, org.apache.solr.search.QParser)"><!-- --></A><H3>
1286getValueSource</H3>
1287<PRE>
1288public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">ValueSource</A> <B>getValueSource</B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
1289                                  <A HREF="../../../../org/apache/solr/search/QParser.html" title="class in org.apache.solr.search">QParser</A>&nbsp;parser)</PRE>
1290<DL>
1291<DD>called to get the default value source (normally, from the
1292  Lucene FieldCache.)
1293<P>
1294<DD><DL>
1295</DL>
1296</DD>
1297</DL>
1298<HR>
1299
1300<A NAME="getRangeQuery(org.apache.solr.search.QParser, org.apache.solr.schema.SchemaField, java.lang.String, java.lang.String, boolean, boolean)"><!-- --></A><H3>
1301getRangeQuery</H3>
1302<PRE>
1303public <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,
1304                           <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
1305                           <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,
1306                           <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,
1307                           boolean&nbsp;minInclusive,
1308                           boolean&nbsp;maxInclusive)</PRE>
1309<DL>
1310<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>
1311 currently passes part1 and part2 as null if they are '*' respectively. minInclusive and maxInclusive are both true
1312 currently by SolrQueryParser but that may change in the future. Also, other QueryParser implementations may have
1313 different semantics.
1314 <p/>
1315 Sub-classes should override this method to provide their own range query implementation. They should strive to
1316 handle nulls in part1 and/or part2 as well as unequal minInclusive and maxInclusive parameters gracefully.
1317<P>
1318<DD><DL>
1319<DT><B>Parameters:</B><DD><CODE>parser</CODE> - <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
1320<DT><B>Returns:</B><DD>a Query instance to perform range search according to given parameters</DL>
1321</DD>
1322</DL>
1323<HR>
1324
1325<A NAME="getFieldQuery(org.apache.solr.search.QParser, org.apache.solr.schema.SchemaField, java.lang.String)"><!-- --></A><H3>
1326getFieldQuery</H3>
1327<PRE>
1328public <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,
1329                           <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
1330                           <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>
1331<DL>
1332<DD>Returns a Query instance for doing searches against a field.
1333<P>
1334<DD><DL>
1335<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
1336<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>
1337</DD>
1338</DL>
1339<!-- ========= END OF CLASS DATA ========= -->
1340<HR>
1341
1342
1343<!-- ======= START OF BOTTOM NAVBAR ====== -->
1344<A NAME="navbar_bottom"><!-- --></A>
1345<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1346<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1347<TR>
1348<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1349<A NAME="navbar_bottom_firstrow"><!-- --></A>
1350<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1351  <TR ALIGN="center" VALIGN="top">
1352  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
1353  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1354  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1355  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FieldType.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
1356  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1357  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1358  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1359  </TR>
1360</TABLE>
1361</TD>
1362<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1363</EM>
1364</TD>
1365</TR>
1366
1367<TR>
1368<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1369&nbsp;<A HREF="../../../../org/apache/solr/schema/FieldProperties.html" title="class in org.apache.solr.schema"><B>PREV CLASS</B></A>&nbsp;
1370&nbsp;<A HREF="../../../../org/apache/solr/schema/FieldType.DefaultAnalyzer.html" title="class in org.apache.solr.schema"><B>NEXT CLASS</B></A></FONT></TD>
1371<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1372  <A HREF="../../../../index.html?org/apache/solr/schema/FieldType.html" target="_top"><B>FRAMES</B></A>  &nbsp;
1373&nbsp;<A HREF="FieldType.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
1374&nbsp;<SCRIPT type="text/javascript">
1375  <!--
1376  if(window==top) {
1377    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1378  }
1379  //-->
1380</SCRIPT>
1381<NOSCRIPT>
1382  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
1383</NOSCRIPT>
1384
1385
1386</FONT></TD>
1387</TR>
1388<TR>
1389<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1390  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>
1391<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1392DETAIL:&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>
1393</TR>
1394</TABLE>
1395<A NAME="skip-navbar_bottom"></A>
1396<!-- ======== END OF BOTTOM NAVBAR ======= -->
1397
1398<HR>
1399
1400          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
1401          <script src='../../../../prettify.js' type='text/javascript'></script>
1402          <script type='text/javascript'>
1403            (function(){
1404              var oldonload = window.onload;
1405              if (typeof oldonload != 'function') {
1406                window.onload = prettyPrint;
1407              } else {
1408                window.onload = function() {
1409                  oldonload();
1410                  prettyPrint();
1411                }
1412              }
1413            })();
1414          </script>
1415       
1416</BODY>
1417</HTML>
Note: See TracBrowser for help on using the repository browser.