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> |
---|
8 | SchemaField (Solr 4.0.0-ALPHA API) |
---|
9 | </TITLE> |
---|
10 | |
---|
11 | <META NAME="date" CONTENT="2012-06-25"> |
---|
12 | |
---|
13 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
---|
14 | |
---|
15 | <SCRIPT type="text/javascript"> |
---|
16 | function windowTitle() |
---|
17 | { |
---|
18 | if (location.href.indexOf('is-external=true') == -1) { |
---|
19 | parent.document.title="SchemaField (Solr 4.0.0-ALPHA API)"; |
---|
20 | } |
---|
21 | } |
---|
22 | </SCRIPT> |
---|
23 | <NOSCRIPT> |
---|
24 | </NOSCRIPT> |
---|
25 | |
---|
26 | </HEAD> |
---|
27 | |
---|
28 | <BODY BGCOLOR="white" onload="windowTitle();"> |
---|
29 | <HR> |
---|
30 | |
---|
31 | |
---|
32 | <!-- ========= START OF TOP NAVBAR ======= --> |
---|
33 | <A NAME="navbar_top"><!-- --></A> |
---|
34 | <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
---|
35 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
36 | <TR> |
---|
37 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
38 | <A NAME="navbar_top_firstrow"><!-- --></A> |
---|
39 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
40 | <TR ALIGN="center" VALIGN="top"> |
---|
41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
42 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
43 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
44 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SchemaField.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
45 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
46 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
47 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
48 | </TR> |
---|
49 | </TABLE> |
---|
50 | </TD> |
---|
51 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
52 | </EM> |
---|
53 | </TD> |
---|
54 | </TR> |
---|
55 | |
---|
56 | <TR> |
---|
57 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
58 | <A HREF="../../../../org/apache/solr/schema/SchemaAware.html" title="interface in org.apache.solr.schema"><B>PREV CLASS</B></A> |
---|
59 | <A HREF="../../../../org/apache/solr/schema/ShortField.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/SchemaField.html" target="_top"><B>FRAMES</B></A> |
---|
62 | <A HREF="SchemaField.html" target="_top"><B>NO FRAMES</B></A> |
---|
63 | <SCRIPT type="text/javascript"> |
---|
64 | <!-- |
---|
65 | if(window==top) { |
---|
66 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
67 | } |
---|
68 | //--> |
---|
69 | </SCRIPT> |
---|
70 | <NOSCRIPT> |
---|
71 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
72 | </NOSCRIPT> |
---|
73 | |
---|
74 | |
---|
75 | </FONT></TD> |
---|
76 | </TR> |
---|
77 | <TR> |
---|
78 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
79 | SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.apache.solr.schema.FieldProperties">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
80 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
81 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
82 | </TR> |
---|
83 | </TABLE> |
---|
84 | <A NAME="skip-navbar_top"></A> |
---|
85 | <!-- ========= END OF TOP NAVBAR ========= --> |
---|
86 | |
---|
87 | <HR> |
---|
88 | <!-- ======== START OF CLASS DATA ======== --> |
---|
89 | <H2> |
---|
90 | <FONT SIZE="-1"> |
---|
91 | org.apache.solr.schema</FONT> |
---|
92 | <BR> |
---|
93 | Class SchemaField</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.SchemaField</B> |
---|
98 | </PRE> |
---|
99 | <HR> |
---|
100 | <DL> |
---|
101 | <DT><PRE>public final class <B>SchemaField</B><DT>extends <A HREF="../../../../org/apache/solr/schema/FieldProperties.html" title="class in org.apache.solr.schema">FieldProperties</A></DL> |
---|
102 | </PRE> |
---|
103 | |
---|
104 | <P> |
---|
105 | Encapsulates all information about a Field in a Solr Schema |
---|
106 | <P> |
---|
107 | |
---|
108 | <P> |
---|
109 | <HR> |
---|
110 | |
---|
111 | <P> |
---|
112 | <!-- =========== FIELD SUMMARY =========== --> |
---|
113 | |
---|
114 | <A NAME="field_summary"><!-- --></A> |
---|
115 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
116 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
117 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
118 | <B>Field Summary</B></FONT></TH> |
---|
119 | </TR> |
---|
120 | </TABLE> |
---|
121 | <A NAME="fields_inherited_from_class_org.apache.solr.schema.FieldProperties"><!-- --></A> |
---|
122 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
123 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
124 | <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> |
---|
125 | </TR> |
---|
126 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
127 | <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> |
---|
128 | </TR> |
---|
129 | </TABLE> |
---|
130 | |
---|
131 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
---|
132 | |
---|
133 | <A NAME="constructor_summary"><!-- --></A> |
---|
134 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
135 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
136 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
137 | <B>Constructor Summary</B></FONT></TH> |
---|
138 | </TR> |
---|
139 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
140 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#SchemaField(org.apache.solr.schema.SchemaField, java.lang.String)">SchemaField</A></B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A> prototype, |
---|
141 | <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE> |
---|
142 | |
---|
143 | <BR> |
---|
144 | Create a new SchemaField from an existing one by using all |
---|
145 | of the properties of the prototype except the field name.</TD> |
---|
146 | </TR> |
---|
147 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
148 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#SchemaField(java.lang.String, org.apache.solr.schema.FieldType)">SchemaField</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
---|
149 | <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A> type)</CODE> |
---|
150 | |
---|
151 | <BR> |
---|
152 | Create a new SchemaField with the given name and type, |
---|
153 | using all the default properties from the type.</TD> |
---|
154 | </TR> |
---|
155 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
156 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#SchemaField(java.lang.String, org.apache.solr.schema.FieldType, int, java.lang.String)">SchemaField</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
---|
157 | <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A> type, |
---|
158 | int properties, |
---|
159 | <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> defaultValue)</CODE> |
---|
160 | |
---|
161 | <BR> |
---|
162 | Create a new SchemaField with the given name and type, |
---|
163 | and with the specified properties.</TD> |
---|
164 | </TR> |
---|
165 | </TABLE> |
---|
166 | |
---|
167 | <!-- ========== METHOD SUMMARY =========== --> |
---|
168 | |
---|
169 | <A NAME="method_summary"><!-- --></A> |
---|
170 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
171 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
172 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
173 | <B>Method Summary</B></FONT></TH> |
---|
174 | </TR> |
---|
175 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
176 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
177 | <CODE> void</CODE></FONT></TD> |
---|
178 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#checkFieldCacheSource(org.apache.solr.search.QParser)">checkFieldCacheSource</A></B>(<A HREF="../../../../org/apache/solr/search/QParser.html" title="class in org.apache.solr.search">QParser</A> parser)</CODE> |
---|
179 | |
---|
180 | <BR> |
---|
181 | Sanity checks that the properties of this field type are plausible |
---|
182 | for a field that may be used to get a FieldCacheSource, throwing |
---|
183 | an appropriate exception (including the field name) if it is not.</TD> |
---|
184 | </TR> |
---|
185 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
186 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
187 | <CODE> void</CODE></FONT></TD> |
---|
188 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#checkSortability()">checkSortability</A></B>()</CODE> |
---|
189 | |
---|
190 | <BR> |
---|
191 | Sanity checks that the properties of this field type are plausible |
---|
192 | for a field that may be used in sorting, throwing an appropriate |
---|
193 | exception (including the field name) if it is not.</TD> |
---|
194 | </TR> |
---|
195 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
196 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
197 | <CODE> <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> |
---|
198 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#createField(java.lang.Object, float)">createField</A></B>(<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> val, |
---|
199 | float boost)</CODE> |
---|
200 | |
---|
201 | <BR> |
---|
202 | </TD> |
---|
203 | </TR> |
---|
204 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
205 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
206 | <CODE> <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> |
---|
207 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#createFields(java.lang.Object, float)">createFields</A></B>(<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> val, |
---|
208 | float boost)</CODE> |
---|
209 | |
---|
210 | <BR> |
---|
211 | </TD> |
---|
212 | </TR> |
---|
213 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
214 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
215 | <CODE> boolean</CODE></FONT></TD> |
---|
216 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#equals(java.lang.Object)">equals</A></B>(<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> obj)</CODE> |
---|
217 | |
---|
218 | <BR> |
---|
219 | </TD> |
---|
220 | </TR> |
---|
221 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
222 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
223 | <CODE> <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> |
---|
224 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#getDefaultValue()">getDefaultValue</A></B>()</CODE> |
---|
225 | |
---|
226 | <BR> |
---|
227 | </TD> |
---|
228 | </TR> |
---|
229 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
230 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
231 | <CODE> <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> |
---|
232 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#getName()">getName</A></B>()</CODE> |
---|
233 | |
---|
234 | <BR> |
---|
235 | </TD> |
---|
236 | </TR> |
---|
237 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
238 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
239 | <CODE> <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> |
---|
240 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#getSortField(boolean)">getSortField</A></B>(boolean top)</CODE> |
---|
241 | |
---|
242 | <BR> |
---|
243 | Delegates to the FieldType for this field</TD> |
---|
244 | </TR> |
---|
245 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
246 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
247 | <CODE> <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></FONT></TD> |
---|
248 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#getType()">getType</A></B>()</CODE> |
---|
249 | |
---|
250 | <BR> |
---|
251 | </TD> |
---|
252 | </TR> |
---|
253 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
254 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
255 | <CODE> int</CODE></FONT></TD> |
---|
256 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#hashCode()">hashCode</A></B>()</CODE> |
---|
257 | |
---|
258 | <BR> |
---|
259 | </TD> |
---|
260 | </TR> |
---|
261 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
262 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
263 | <CODE> boolean</CODE></FONT></TD> |
---|
264 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#indexed()">indexed</A></B>()</CODE> |
---|
265 | |
---|
266 | <BR> |
---|
267 | </TD> |
---|
268 | </TR> |
---|
269 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
270 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
271 | <CODE> boolean</CODE></FONT></TD> |
---|
272 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#isPolyField()">isPolyField</A></B>()</CODE> |
---|
273 | |
---|
274 | <BR> |
---|
275 | If true, then use <A HREF="../../../../org/apache/solr/schema/SchemaField.html#createFields(java.lang.Object, float)"><CODE>createFields(Object, float)</CODE></A>, else use <A HREF="../../../../org/apache/solr/schema/SchemaField.html#createField(java.lang.Object, float)"><CODE>createField(java.lang.Object, float)</CODE></A> to save an extra allocation</TD> |
---|
276 | </TR> |
---|
277 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
278 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
279 | <CODE> boolean</CODE></FONT></TD> |
---|
280 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#isRequired()">isRequired</A></B>()</CODE> |
---|
281 | |
---|
282 | <BR> |
---|
283 | </TD> |
---|
284 | </TR> |
---|
285 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
286 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
287 | <CODE> boolean</CODE></FONT></TD> |
---|
288 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#multiValued()">multiValued</A></B>()</CODE> |
---|
289 | |
---|
290 | <BR> |
---|
291 | </TD> |
---|
292 | </TR> |
---|
293 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
294 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
295 | <CODE> boolean</CODE></FONT></TD> |
---|
296 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#omitNorms()">omitNorms</A></B>()</CODE> |
---|
297 | |
---|
298 | <BR> |
---|
299 | </TD> |
---|
300 | </TR> |
---|
301 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
302 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
303 | <CODE> boolean</CODE></FONT></TD> |
---|
304 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#omitPositions()">omitPositions</A></B>()</CODE> |
---|
305 | |
---|
306 | <BR> |
---|
307 | </TD> |
---|
308 | </TR> |
---|
309 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
310 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
311 | <CODE> boolean</CODE></FONT></TD> |
---|
312 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#omitTermFreqAndPositions()">omitTermFreqAndPositions</A></B>()</CODE> |
---|
313 | |
---|
314 | <BR> |
---|
315 | </TD> |
---|
316 | </TR> |
---|
317 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
318 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
319 | <CODE> boolean</CODE></FONT></TD> |
---|
320 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#omitTf()">omitTf</A></B>()</CODE> |
---|
321 | |
---|
322 | <BR> |
---|
323 | <B>Deprecated.</B> <I>Use <A HREF="../../../../org/apache/solr/schema/SchemaField.html#omitTermFreqAndPositions()"><CODE>omitTermFreqAndPositions()</CODE></A></I></TD> |
---|
324 | </TR> |
---|
325 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
326 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
327 | <CODE> boolean</CODE></FONT></TD> |
---|
328 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#sortMissingFirst()">sortMissingFirst</A></B>()</CODE> |
---|
329 | |
---|
330 | <BR> |
---|
331 | </TD> |
---|
332 | </TR> |
---|
333 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
334 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
335 | <CODE> boolean</CODE></FONT></TD> |
---|
336 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#sortMissingLast()">sortMissingLast</A></B>()</CODE> |
---|
337 | |
---|
338 | <BR> |
---|
339 | </TD> |
---|
340 | </TR> |
---|
341 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
342 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
343 | <CODE> boolean</CODE></FONT></TD> |
---|
344 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#stored()">stored</A></B>()</CODE> |
---|
345 | |
---|
346 | <BR> |
---|
347 | </TD> |
---|
348 | </TR> |
---|
349 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
350 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
351 | <CODE> boolean</CODE></FONT></TD> |
---|
352 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#storeTermOffsets()">storeTermOffsets</A></B>()</CODE> |
---|
353 | |
---|
354 | <BR> |
---|
355 | </TD> |
---|
356 | </TR> |
---|
357 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
358 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
359 | <CODE> boolean</CODE></FONT></TD> |
---|
360 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#storeTermPositions()">storeTermPositions</A></B>()</CODE> |
---|
361 | |
---|
362 | <BR> |
---|
363 | </TD> |
---|
364 | </TR> |
---|
365 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
366 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
367 | <CODE> boolean</CODE></FONT></TD> |
---|
368 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#storeTermVector()">storeTermVector</A></B>()</CODE> |
---|
369 | |
---|
370 | <BR> |
---|
371 | </TD> |
---|
372 | </TR> |
---|
373 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
374 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
375 | <CODE> <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> |
---|
376 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.html#toString()">toString</A></B>()</CODE> |
---|
377 | |
---|
378 | <BR> |
---|
379 | </TD> |
---|
380 | </TR> |
---|
381 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
382 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
383 | <CODE> void</CODE></FONT></TD> |
---|
384 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SchemaField.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> writer, |
---|
385 | <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
---|
386 | <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> val)</CODE> |
---|
387 | |
---|
388 | <BR> |
---|
389 | </TD> |
---|
390 | </TR> |
---|
391 | </TABLE> |
---|
392 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
393 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
394 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
395 | <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> |
---|
396 | </TR> |
---|
397 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
398 | <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#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#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> |
---|
399 | </TR> |
---|
400 | </TABLE> |
---|
401 | |
---|
402 | <P> |
---|
403 | |
---|
404 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
405 | |
---|
406 | <A NAME="constructor_detail"><!-- --></A> |
---|
407 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
408 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
409 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
410 | <B>Constructor Detail</B></FONT></TH> |
---|
411 | </TR> |
---|
412 | </TABLE> |
---|
413 | |
---|
414 | <A NAME="SchemaField(java.lang.String, org.apache.solr.schema.FieldType)"><!-- --></A><H3> |
---|
415 | SchemaField</H3> |
---|
416 | <PRE> |
---|
417 | public <B>SchemaField</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
---|
418 | <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A> type)</PRE> |
---|
419 | <DL> |
---|
420 | <DD>Create a new SchemaField with the given name and type, |
---|
421 | using all the default properties from the type. |
---|
422 | <P> |
---|
423 | </DL> |
---|
424 | <HR> |
---|
425 | |
---|
426 | <A NAME="SchemaField(org.apache.solr.schema.SchemaField, java.lang.String)"><!-- --></A><H3> |
---|
427 | SchemaField</H3> |
---|
428 | <PRE> |
---|
429 | public <B>SchemaField</B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A> prototype, |
---|
430 | <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE> |
---|
431 | <DL> |
---|
432 | <DD>Create a new SchemaField from an existing one by using all |
---|
433 | of the properties of the prototype except the field name. |
---|
434 | <P> |
---|
435 | </DL> |
---|
436 | <HR> |
---|
437 | |
---|
438 | <A NAME="SchemaField(java.lang.String, org.apache.solr.schema.FieldType, int, java.lang.String)"><!-- --></A><H3> |
---|
439 | SchemaField</H3> |
---|
440 | <PRE> |
---|
441 | public <B>SchemaField</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
---|
442 | <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A> type, |
---|
443 | int properties, |
---|
444 | <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> defaultValue)</PRE> |
---|
445 | <DL> |
---|
446 | <DD>Create a new SchemaField with the given name and type, |
---|
447 | and with the specified properties. Properties are *not* |
---|
448 | inherited from the type in this case, so users of this |
---|
449 | constructor should derive the properties from type.getProperties() |
---|
450 | using all the default properties from the type. |
---|
451 | <P> |
---|
452 | </DL> |
---|
453 | |
---|
454 | <!-- ============ METHOD DETAIL ========== --> |
---|
455 | |
---|
456 | <A NAME="method_detail"><!-- --></A> |
---|
457 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
458 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
459 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
460 | <B>Method Detail</B></FONT></TH> |
---|
461 | </TR> |
---|
462 | </TABLE> |
---|
463 | |
---|
464 | <A NAME="getName()"><!-- --></A><H3> |
---|
465 | getName</H3> |
---|
466 | <PRE> |
---|
467 | public <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>getName</B>()</PRE> |
---|
468 | <DL> |
---|
469 | <DD><DL> |
---|
470 | </DL> |
---|
471 | </DD> |
---|
472 | </DL> |
---|
473 | <HR> |
---|
474 | |
---|
475 | <A NAME="getType()"><!-- --></A><H3> |
---|
476 | getType</H3> |
---|
477 | <PRE> |
---|
478 | public <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A> <B>getType</B>()</PRE> |
---|
479 | <DL> |
---|
480 | <DD><DL> |
---|
481 | </DL> |
---|
482 | </DD> |
---|
483 | </DL> |
---|
484 | <HR> |
---|
485 | |
---|
486 | <A NAME="indexed()"><!-- --></A><H3> |
---|
487 | indexed</H3> |
---|
488 | <PRE> |
---|
489 | public boolean <B>indexed</B>()</PRE> |
---|
490 | <DL> |
---|
491 | <DD><DL> |
---|
492 | </DL> |
---|
493 | </DD> |
---|
494 | </DL> |
---|
495 | <HR> |
---|
496 | |
---|
497 | <A NAME="stored()"><!-- --></A><H3> |
---|
498 | stored</H3> |
---|
499 | <PRE> |
---|
500 | public boolean <B>stored</B>()</PRE> |
---|
501 | <DL> |
---|
502 | <DD><DL> |
---|
503 | </DL> |
---|
504 | </DD> |
---|
505 | </DL> |
---|
506 | <HR> |
---|
507 | |
---|
508 | <A NAME="storeTermVector()"><!-- --></A><H3> |
---|
509 | storeTermVector</H3> |
---|
510 | <PRE> |
---|
511 | public boolean <B>storeTermVector</B>()</PRE> |
---|
512 | <DL> |
---|
513 | <DD><DL> |
---|
514 | </DL> |
---|
515 | </DD> |
---|
516 | </DL> |
---|
517 | <HR> |
---|
518 | |
---|
519 | <A NAME="storeTermPositions()"><!-- --></A><H3> |
---|
520 | storeTermPositions</H3> |
---|
521 | <PRE> |
---|
522 | public boolean <B>storeTermPositions</B>()</PRE> |
---|
523 | <DL> |
---|
524 | <DD><DL> |
---|
525 | </DL> |
---|
526 | </DD> |
---|
527 | </DL> |
---|
528 | <HR> |
---|
529 | |
---|
530 | <A NAME="storeTermOffsets()"><!-- --></A><H3> |
---|
531 | storeTermOffsets</H3> |
---|
532 | <PRE> |
---|
533 | public boolean <B>storeTermOffsets</B>()</PRE> |
---|
534 | <DL> |
---|
535 | <DD><DL> |
---|
536 | </DL> |
---|
537 | </DD> |
---|
538 | </DL> |
---|
539 | <HR> |
---|
540 | |
---|
541 | <A NAME="omitNorms()"><!-- --></A><H3> |
---|
542 | omitNorms</H3> |
---|
543 | <PRE> |
---|
544 | public boolean <B>omitNorms</B>()</PRE> |
---|
545 | <DL> |
---|
546 | <DD><DL> |
---|
547 | </DL> |
---|
548 | </DD> |
---|
549 | </DL> |
---|
550 | <HR> |
---|
551 | |
---|
552 | <A NAME="omitTf()"><!-- --></A><H3> |
---|
553 | omitTf</H3> |
---|
554 | <PRE> |
---|
555 | <FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A> |
---|
556 | </FONT>public boolean <B>omitTf</B>()</PRE> |
---|
557 | <DL> |
---|
558 | <DD><B>Deprecated.</B> <I>Use <A HREF="../../../../org/apache/solr/schema/SchemaField.html#omitTermFreqAndPositions()"><CODE>omitTermFreqAndPositions()</CODE></A></I> |
---|
559 | <P> |
---|
560 | <DD><DL> |
---|
561 | </DL> |
---|
562 | </DD> |
---|
563 | </DL> |
---|
564 | <HR> |
---|
565 | |
---|
566 | <A NAME="omitTermFreqAndPositions()"><!-- --></A><H3> |
---|
567 | omitTermFreqAndPositions</H3> |
---|
568 | <PRE> |
---|
569 | public boolean <B>omitTermFreqAndPositions</B>()</PRE> |
---|
570 | <DL> |
---|
571 | <DD><DL> |
---|
572 | </DL> |
---|
573 | </DD> |
---|
574 | </DL> |
---|
575 | <HR> |
---|
576 | |
---|
577 | <A NAME="omitPositions()"><!-- --></A><H3> |
---|
578 | omitPositions</H3> |
---|
579 | <PRE> |
---|
580 | public boolean <B>omitPositions</B>()</PRE> |
---|
581 | <DL> |
---|
582 | <DD><DL> |
---|
583 | </DL> |
---|
584 | </DD> |
---|
585 | </DL> |
---|
586 | <HR> |
---|
587 | |
---|
588 | <A NAME="multiValued()"><!-- --></A><H3> |
---|
589 | multiValued</H3> |
---|
590 | <PRE> |
---|
591 | public boolean <B>multiValued</B>()</PRE> |
---|
592 | <DL> |
---|
593 | <DD><DL> |
---|
594 | </DL> |
---|
595 | </DD> |
---|
596 | </DL> |
---|
597 | <HR> |
---|
598 | |
---|
599 | <A NAME="sortMissingFirst()"><!-- --></A><H3> |
---|
600 | sortMissingFirst</H3> |
---|
601 | <PRE> |
---|
602 | public boolean <B>sortMissingFirst</B>()</PRE> |
---|
603 | <DL> |
---|
604 | <DD><DL> |
---|
605 | </DL> |
---|
606 | </DD> |
---|
607 | </DL> |
---|
608 | <HR> |
---|
609 | |
---|
610 | <A NAME="sortMissingLast()"><!-- --></A><H3> |
---|
611 | sortMissingLast</H3> |
---|
612 | <PRE> |
---|
613 | public boolean <B>sortMissingLast</B>()</PRE> |
---|
614 | <DL> |
---|
615 | <DD><DL> |
---|
616 | </DL> |
---|
617 | </DD> |
---|
618 | </DL> |
---|
619 | <HR> |
---|
620 | |
---|
621 | <A NAME="isRequired()"><!-- --></A><H3> |
---|
622 | isRequired</H3> |
---|
623 | <PRE> |
---|
624 | public boolean <B>isRequired</B>()</PRE> |
---|
625 | <DL> |
---|
626 | <DD><DL> |
---|
627 | </DL> |
---|
628 | </DD> |
---|
629 | </DL> |
---|
630 | <HR> |
---|
631 | |
---|
632 | <A NAME="createField(java.lang.Object, float)"><!-- --></A><H3> |
---|
633 | createField</H3> |
---|
634 | <PRE> |
---|
635 | public <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/Object.html?is-external=true" title="class or interface in java.lang">Object</A> val, |
---|
636 | float boost)</PRE> |
---|
637 | <DL> |
---|
638 | <DD><DL> |
---|
639 | </DL> |
---|
640 | </DD> |
---|
641 | </DL> |
---|
642 | <HR> |
---|
643 | |
---|
644 | <A NAME="createFields(java.lang.Object, float)"><!-- --></A><H3> |
---|
645 | createFields</H3> |
---|
646 | <PRE> |
---|
647 | public <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="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> val, |
---|
648 | float boost)</PRE> |
---|
649 | <DL> |
---|
650 | <DD><DL> |
---|
651 | </DL> |
---|
652 | </DD> |
---|
653 | </DL> |
---|
654 | <HR> |
---|
655 | |
---|
656 | <A NAME="isPolyField()"><!-- --></A><H3> |
---|
657 | isPolyField</H3> |
---|
658 | <PRE> |
---|
659 | public boolean <B>isPolyField</B>()</PRE> |
---|
660 | <DL> |
---|
661 | <DD>If true, then use <A HREF="../../../../org/apache/solr/schema/SchemaField.html#createFields(java.lang.Object, float)"><CODE>createFields(Object, float)</CODE></A>, else use <A HREF="../../../../org/apache/solr/schema/SchemaField.html#createField(java.lang.Object, float)"><CODE>createField(java.lang.Object, float)</CODE></A> to save an extra allocation |
---|
662 | <P> |
---|
663 | <DD><DL> |
---|
664 | |
---|
665 | <DT><B>Returns:</B><DD>true if this field is a poly field</DL> |
---|
666 | </DD> |
---|
667 | </DL> |
---|
668 | <HR> |
---|
669 | |
---|
670 | <A NAME="toString()"><!-- --></A><H3> |
---|
671 | toString</H3> |
---|
672 | <PRE> |
---|
673 | public <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> |
---|
674 | <DL> |
---|
675 | <DD><DL> |
---|
676 | <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> |
---|
677 | </DD> |
---|
678 | <DD><DL> |
---|
679 | </DL> |
---|
680 | </DD> |
---|
681 | </DL> |
---|
682 | <HR> |
---|
683 | |
---|
684 | <A NAME="write(org.apache.solr.response.TextResponseWriter, java.lang.String, org.apache.lucene.index.IndexableField)"><!-- --></A><H3> |
---|
685 | write</H3> |
---|
686 | <PRE> |
---|
687 | public void <B>write</B>(<A HREF="../../../../org/apache/solr/response/TextResponseWriter.html" title="class in org.apache.solr.response">TextResponseWriter</A> writer, |
---|
688 | <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
---|
689 | <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> val) |
---|
690 | 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> |
---|
691 | <DL> |
---|
692 | <DD><DL> |
---|
693 | |
---|
694 | <DT><B>Throws:</B> |
---|
695 | <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> |
---|
696 | </DD> |
---|
697 | </DL> |
---|
698 | <HR> |
---|
699 | |
---|
700 | <A NAME="getSortField(boolean)"><!-- --></A><H3> |
---|
701 | getSortField</H3> |
---|
702 | <PRE> |
---|
703 | public <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>(boolean top)</PRE> |
---|
704 | <DL> |
---|
705 | <DD>Delegates to the FieldType for this field |
---|
706 | <P> |
---|
707 | <DD><DL> |
---|
708 | <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#getSortField(org.apache.solr.schema.SchemaField, boolean)"><CODE>FieldType.getSortField(org.apache.solr.schema.SchemaField, boolean)</CODE></A></DL> |
---|
709 | </DD> |
---|
710 | </DL> |
---|
711 | <HR> |
---|
712 | |
---|
713 | <A NAME="checkSortability()"><!-- --></A><H3> |
---|
714 | checkSortability</H3> |
---|
715 | <PRE> |
---|
716 | public void <B>checkSortability</B>() |
---|
717 | throws <A HREF="../../../../org/apache/solr/common/SolrException.html" title="class in org.apache.solr.common">SolrException</A></PRE> |
---|
718 | <DL> |
---|
719 | <DD>Sanity checks that the properties of this field type are plausible |
---|
720 | for a field that may be used in sorting, throwing an appropriate |
---|
721 | exception (including the field name) if it is not. FieldType subclasses |
---|
722 | can choose to call this method in their getSortField implementation |
---|
723 | <P> |
---|
724 | <DD><DL> |
---|
725 | |
---|
726 | <DT><B>Throws:</B> |
---|
727 | <DD><CODE><A HREF="../../../../org/apache/solr/common/SolrException.html" title="class in org.apache.solr.common">SolrException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#getSortField(org.apache.solr.schema.SchemaField, boolean)"><CODE>FieldType.getSortField(org.apache.solr.schema.SchemaField, boolean)</CODE></A></DL> |
---|
728 | </DD> |
---|
729 | </DL> |
---|
730 | <HR> |
---|
731 | |
---|
732 | <A NAME="checkFieldCacheSource(org.apache.solr.search.QParser)"><!-- --></A><H3> |
---|
733 | checkFieldCacheSource</H3> |
---|
734 | <PRE> |
---|
735 | public void <B>checkFieldCacheSource</B>(<A HREF="../../../../org/apache/solr/search/QParser.html" title="class in org.apache.solr.search">QParser</A> parser) |
---|
736 | throws <A HREF="../../../../org/apache/solr/common/SolrException.html" title="class in org.apache.solr.common">SolrException</A></PRE> |
---|
737 | <DL> |
---|
738 | <DD>Sanity checks that the properties of this field type are plausible |
---|
739 | for a field that may be used to get a FieldCacheSource, throwing |
---|
740 | an appropriate exception (including the field name) if it is not. |
---|
741 | FieldType subclasses can choose to call this method in their |
---|
742 | getValueSource implementation |
---|
743 | <P> |
---|
744 | <DD><DL> |
---|
745 | |
---|
746 | <DT><B>Throws:</B> |
---|
747 | <DD><CODE><A HREF="../../../../org/apache/solr/common/SolrException.html" title="class in org.apache.solr.common">SolrException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#getValueSource(org.apache.solr.schema.SchemaField, org.apache.solr.search.QParser)"><CODE>FieldType.getValueSource(org.apache.solr.schema.SchemaField, org.apache.solr.search.QParser)</CODE></A></DL> |
---|
748 | </DD> |
---|
749 | </DL> |
---|
750 | <HR> |
---|
751 | |
---|
752 | <A NAME="getDefaultValue()"><!-- --></A><H3> |
---|
753 | getDefaultValue</H3> |
---|
754 | <PRE> |
---|
755 | public <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>getDefaultValue</B>()</PRE> |
---|
756 | <DL> |
---|
757 | <DD><DL> |
---|
758 | </DL> |
---|
759 | </DD> |
---|
760 | </DL> |
---|
761 | <HR> |
---|
762 | |
---|
763 | <A NAME="hashCode()"><!-- --></A><H3> |
---|
764 | hashCode</H3> |
---|
765 | <PRE> |
---|
766 | public int <B>hashCode</B>()</PRE> |
---|
767 | <DL> |
---|
768 | <DD><DL> |
---|
769 | <DT><B>Overrides:</B><DD><CODE><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></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> |
---|
770 | </DD> |
---|
771 | <DD><DL> |
---|
772 | </DL> |
---|
773 | </DD> |
---|
774 | </DL> |
---|
775 | <HR> |
---|
776 | |
---|
777 | <A NAME="equals(java.lang.Object)"><!-- --></A><H3> |
---|
778 | equals</H3> |
---|
779 | <PRE> |
---|
780 | public boolean <B>equals</B>(<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> obj)</PRE> |
---|
781 | <DL> |
---|
782 | <DD><DL> |
---|
783 | <DT><B>Overrides:</B><DD><CODE><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></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> |
---|
784 | </DD> |
---|
785 | <DD><DL> |
---|
786 | </DL> |
---|
787 | </DD> |
---|
788 | </DL> |
---|
789 | <!-- ========= END OF CLASS DATA ========= --> |
---|
790 | <HR> |
---|
791 | |
---|
792 | |
---|
793 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
794 | <A NAME="navbar_bottom"><!-- --></A> |
---|
795 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
796 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
797 | <TR> |
---|
798 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
799 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
800 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
801 | <TR ALIGN="center" VALIGN="top"> |
---|
802 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
803 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
804 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
805 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SchemaField.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
806 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
807 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
808 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
809 | </TR> |
---|
810 | </TABLE> |
---|
811 | </TD> |
---|
812 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
813 | </EM> |
---|
814 | </TD> |
---|
815 | </TR> |
---|
816 | |
---|
817 | <TR> |
---|
818 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
819 | <A HREF="../../../../org/apache/solr/schema/SchemaAware.html" title="interface in org.apache.solr.schema"><B>PREV CLASS</B></A> |
---|
820 | <A HREF="../../../../org/apache/solr/schema/ShortField.html" title="class in org.apache.solr.schema"><B>NEXT CLASS</B></A></FONT></TD> |
---|
821 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
822 | <A HREF="../../../../index.html?org/apache/solr/schema/SchemaField.html" target="_top"><B>FRAMES</B></A> |
---|
823 | <A HREF="SchemaField.html" target="_top"><B>NO FRAMES</B></A> |
---|
824 | <SCRIPT type="text/javascript"> |
---|
825 | <!-- |
---|
826 | if(window==top) { |
---|
827 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
828 | } |
---|
829 | //--> |
---|
830 | </SCRIPT> |
---|
831 | <NOSCRIPT> |
---|
832 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
833 | </NOSCRIPT> |
---|
834 | |
---|
835 | |
---|
836 | </FONT></TD> |
---|
837 | </TR> |
---|
838 | <TR> |
---|
839 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
840 | SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.apache.solr.schema.FieldProperties">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
841 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
842 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
843 | </TR> |
---|
844 | </TABLE> |
---|
845 | <A NAME="skip-navbar_bottom"></A> |
---|
846 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
847 | |
---|
848 | <HR> |
---|
849 | |
---|
850 | <address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address> |
---|
851 | <script src='../../../../prettify.js' type='text/javascript'></script> |
---|
852 | <script type='text/javascript'> |
---|
853 | (function(){ |
---|
854 | var oldonload = window.onload; |
---|
855 | if (typeof oldonload != 'function') { |
---|
856 | window.onload = prettyPrint; |
---|
857 | } else { |
---|
858 | window.onload = function() { |
---|
859 | oldonload(); |
---|
860 | prettyPrint(); |
---|
861 | } |
---|
862 | } |
---|
863 | })(); |
---|
864 | </script> |
---|
865 | |
---|
866 | </BODY> |
---|
867 | </HTML> |
---|