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

Revision 7588, 36.9 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
RevLine 
[7588]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>
8CollationField (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="CollationField (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/CollationField.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/ByteField.html" title="class in org.apache.solr.schema"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/schema/CoordinateFieldType.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/CollationField.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="CollationField.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77<TR>
78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79  SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_org.apache.solr.schema.FieldType">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.solr.schema.FieldType">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;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82</TR>
83</TABLE>
84<A NAME="skip-navbar_top"></A>
85<!-- ========= END OF TOP NAVBAR ========= -->
86
87<HR>
88<!-- ======== START OF CLASS DATA ======== -->
89<H2>
90<FONT SIZE="-1">
91org.apache.solr.schema</FONT>
92<BR>
93Class CollationField</H2>
94<PRE>
95<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/solr/schema/FieldProperties.html" title="class in org.apache.solr.schema">org.apache.solr.schema.FieldProperties</A>
97      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">org.apache.solr.schema.FieldType</A>
98          <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.schema.CollationField</B>
99</PRE>
100<HR>
101<DL>
102<DT><PRE>public class <B>CollationField</B><DT>extends <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></DL>
103</PRE>
104
105<P>
106Field for collated sort keys.
107 These can be used for locale-sensitive sort and range queries.
108 <p>
109 This field can be created in two ways:
110 <ul>
111  <li>Based upon a system collator associated with a Locale.
112  <li>Based upon a tailored ruleset.
113 </ul>
114 <p>
115 Using a System collator:
116 <ul>
117  <li>language: ISO-639 language code (mandatory)
118  <li>country: ISO-3166 country code (optional)
119  <li>variant: vendor or browser-specific code (optional)
120  <li>strength: 'primary','secondary','tertiary', or 'identical' (optional)
121  <li>decomposition: 'no','canonical', or 'full' (optional)
122 </ul>
123 <p>
124 Using a Tailored ruleset:
125 <ul>
126  <li>custom: UTF-8 text file containing rules supported by RuleBasedCollator (mandatory)
127  <li>strength: 'primary','secondary','tertiary', or 'identical' (optional)
128  <li>decomposition: 'no','canonical', or 'full' (optional)
129 </ul>
130<P>
131
132<P>
133<DL>
134<DT><B>Since:</B></DT>
135  <DD>solr 4.0</DD>
136<DT><B>See Also:</B><DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/text/Collator.html?is-external=true" title="class or interface in java.text"><CODE>Collator</CODE></A>,
137<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util"><CODE>Locale</CODE></A>,
138<A HREF="http://download.oracle.com/javase/6/docs/api/java/text/RuleBasedCollator.html?is-external=true" title="class or interface in java.text"><CODE>RuleBasedCollator</CODE></A></DL>
139<HR>
140
141<P>
142<!-- ======== NESTED CLASS SUMMARY ======== -->
143
144<A NAME="nested_class_summary"><!-- --></A>
145<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
146<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
147<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
148<B>Nested Class Summary</B></FONT></TH>
149</TR>
150</TABLE>
151&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.schema.FieldType"><!-- --></A>
152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
153<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
154<TH ALIGN="left"><B>Nested classes/interfaces inherited from class org.apache.solr.schema.<A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></B></TH>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.DefaultAnalyzer.html" title="class in org.apache.solr.schema">FieldType.DefaultAnalyzer</A></CODE></TD>
158</TR>
159</TABLE>
160&nbsp;
161<!-- =========== FIELD SUMMARY =========== -->
162
163<A NAME="field_summary"><!-- --></A>
164<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
165<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
166<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
167<B>Field Summary</B></FONT></TH>
168</TR>
169</TABLE>
170&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.schema.FieldType"><!-- --></A>
171<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
172<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
173<TH ALIGN="left"><B>Fields inherited from class org.apache.solr.schema.<A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></B></TH>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#args">args</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#falseProperties">falseProperties</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#log">log</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#POLY_FIELD_SEPARATOR">POLY_FIELD_SEPARATOR</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#postingsFormat">postingsFormat</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#queryAnalyzer">queryAnalyzer</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#similarity">similarity</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#trueProperties">trueProperties</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#typeName">typeName</A></CODE></TD>
177</TR>
178</TABLE>
179&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.schema.FieldProperties"><!-- --></A>
180<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
181<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
182<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>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<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>
186</TR>
187</TABLE>
188&nbsp;
189<!-- ======== CONSTRUCTOR SUMMARY ======== -->
190
191<A NAME="constructor_summary"><!-- --></A>
192<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
193<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
194<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
195<B>Constructor Summary</B></FONT></TH>
196</TR>
197<TR BGCOLOR="white" CLASS="TableRowColor">
198<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/CollationField.html#CollationField()">CollationField</A></B>()</CODE>
199
200<BR>
201&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
202</TR>
203</TABLE>
204&nbsp;
205<!-- ========== METHOD SUMMARY =========== -->
206
207<A NAME="method_summary"><!-- --></A>
208<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
209<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
210<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
211<B>Method Summary</B></FONT></TH>
212</TR>
213<TR BGCOLOR="white" CLASS="TableRowColor">
214<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
215<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>
216<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/CollationField.html#getAnalyzer()">getAnalyzer</A></B>()</CODE>
217
218<BR>
219&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the Analyzer to be used when indexing fields of this type.</TD>
220</TR>
221<TR BGCOLOR="white" CLASS="TableRowColor">
222<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
223<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>
224<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/CollationField.html#getQueryAnalyzer()">getQueryAnalyzer</A></B>()</CODE>
225
226<BR>
227&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the Analyzer to be used when searching fields of this type.</TD>
228</TR>
229<TR BGCOLOR="white" CLASS="TableRowColor">
230<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231<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>
232<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/CollationField.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,
233              <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
234              <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,
235              <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,
236              boolean&nbsp;minInclusive,
237              boolean&nbsp;maxInclusive)</CODE>
238
239<BR>
240&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a Query instance for doing range searches on this field type.</TD>
241</TR>
242<TR BGCOLOR="white" CLASS="TableRowColor">
243<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/SortField.html?is-external=true" title="class or interface in org.apache.lucene.search">SortField</A></CODE></FONT></TD>
245<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/CollationField.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,
246             boolean&nbsp;top)</CODE>
247
248<BR>
249&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the SortField instance that should be used to sort fields
250 of this type.</TD>
251</TR>
252<TR BGCOLOR="white" CLASS="TableRowColor">
253<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
254<CODE>protected &nbsp;void</CODE></FONT></TD>
255<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/CollationField.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,
256     <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>
257
258<BR>
259&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;subclasses should initialize themselves with the args provided
260 and remove valid arguments.</TD>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264<CODE>&nbsp;void</CODE></FONT></TD>
265<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/CollationField.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,
266      <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,
267      <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>
268
269<BR>
270&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;calls back to TextResponseWriter to write the field value</TD>
271</TR>
272</TABLE>
273&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.schema.FieldType"><!-- --></A>
274<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
275<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
276<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.schema.<A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></B></TH>
277</TR>
278<TR BGCOLOR="white" CLASS="TableRowColor">
279<TD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#createField(org.apache.solr.schema.SchemaField, java.lang.Object, float)">createField</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#createField(java.lang.String, java.lang.String, org.apache.lucene.document.FieldType, float)">createField</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#createFields(org.apache.solr.schema.SchemaField, java.lang.Object, float)">createFields</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getArg(java.lang.String, java.util.Map)">getArg</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getFieldQuery(org.apache.solr.search.QParser, org.apache.solr.schema.SchemaField, java.lang.String)">getFieldQuery</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getIndexOptions(org.apache.solr.schema.SchemaField, java.lang.String)">getIndexOptions</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getPostingsFormat()">getPostingsFormat</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getSimilarity()">getSimilarity</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getStringSort(org.apache.solr.schema.SchemaField, boolean)">getStringSort</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getTypeName()">getTypeName</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getValueSource(org.apache.solr.schema.SchemaField, org.apache.solr.search.QParser)">getValueSource</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#hasProperty(int)">hasProperty</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#indexedToReadable(org.apache.lucene.util.BytesRef, org.apache.lucene.util.CharsRef)">indexedToReadable</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#indexedToReadable(java.lang.String)">indexedToReadable</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#isMultiValued()">isMultiValued</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#isPolyField()">isPolyField</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#isTokenized()">isTokenized</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#multiValuedFieldCache()">multiValuedFieldCache</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#readableToIndexed(java.lang.CharSequence, org.apache.lucene.util.BytesRef)">readableToIndexed</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#readableToIndexed(java.lang.String)">readableToIndexed</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#restrictProps(int)">restrictProps</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#setAnalyzer(org.apache.lucene.analysis.Analyzer)">setAnalyzer</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#setQueryAnalyzer(org.apache.lucene.analysis.Analyzer)">setQueryAnalyzer</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#setSimilarity(org.apache.lucene.search.similarities.Similarity)">setSimilarity</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#storedToIndexed(org.apache.lucene.index.IndexableField)">storedToIndexed</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#storedToReadable(org.apache.lucene.index.IndexableField)">storedToReadable</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#toExternal(org.apache.lucene.index.IndexableField)">toExternal</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#toInternal(java.lang.String)">toInternal</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#toObject(org.apache.lucene.index.IndexableField)">toObject</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#toObject(org.apache.solr.schema.SchemaField, org.apache.lucene.util.BytesRef)">toObject</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#toString()">toString</A></CODE></TD>
280</TR>
281</TABLE>
282&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
283<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
284<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
285<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>
286</TR>
287<TR BGCOLOR="white" CLASS="TableRowColor">
288<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>
289</TR>
290</TABLE>
291&nbsp;
292<P>
293
294<!-- ========= CONSTRUCTOR DETAIL ======== -->
295
296<A NAME="constructor_detail"><!-- --></A>
297<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
298<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
299<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
300<B>Constructor Detail</B></FONT></TH>
301</TR>
302</TABLE>
303
304<A NAME="CollationField()"><!-- --></A><H3>
305CollationField</H3>
306<PRE>
307public <B>CollationField</B>()</PRE>
308<DL>
309</DL>
310
311<!-- ============ METHOD DETAIL ========== -->
312
313<A NAME="method_detail"><!-- --></A>
314<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
315<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
316<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
317<B>Method Detail</B></FONT></TH>
318</TR>
319</TABLE>
320
321<A NAME="init(org.apache.solr.schema.IndexSchema, java.util.Map)"><!-- --></A><H3>
322init</H3>
323<PRE>
324protected void <B>init</B>(<A HREF="../../../../org/apache/solr/schema/IndexSchema.html" title="class in org.apache.solr.schema">IndexSchema</A>&nbsp;schema,
325                    <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>
326<DL>
327<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#init(org.apache.solr.schema.IndexSchema, java.util.Map)">FieldType</A></CODE></B></DD>
328<DD>subclasses should initialize themselves with the args provided
329 and remove valid arguments.  leftover arguments will cause an exception.
330 Common boolean properties have already been handled.
331<P>
332<DD><DL>
333<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#init(org.apache.solr.schema.IndexSchema, java.util.Map)">init</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
334</DD>
335<DD><DL>
336</DL>
337</DD>
338</DL>
339<HR>
340
341<A NAME="write(org.apache.solr.response.TextResponseWriter, java.lang.String, org.apache.lucene.index.IndexableField)"><!-- --></A><H3>
342write</H3>
343<PRE>
344public void <B>write</B>(<A HREF="../../../../org/apache/solr/response/TextResponseWriter.html" title="class in org.apache.solr.response">TextResponseWriter</A>&nbsp;writer,
345                  <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,
346                  <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)
347           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>
348<DL>
349<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#write(org.apache.solr.response.TextResponseWriter, java.lang.String, org.apache.lucene.index.IndexableField)">FieldType</A></CODE></B></DD>
350<DD>calls back to TextResponseWriter to write the field value
351<P>
352<DD><DL>
353<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#write(org.apache.solr.response.TextResponseWriter, java.lang.String, org.apache.lucene.index.IndexableField)">write</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
354</DD>
355<DD><DL>
356
357<DT><B>Throws:</B>
358<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>
359</DD>
360</DL>
361<HR>
362
363<A NAME="getSortField(org.apache.solr.schema.SchemaField, boolean)"><!-- --></A><H3>
364getSortField</H3>
365<PRE>
366public <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,
367                              boolean&nbsp;top)</PRE>
368<DL>
369<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getSortField(org.apache.solr.schema.SchemaField, boolean)">FieldType</A></CODE></B></DD>
370<DD>Returns the SortField instance that should be used to sort fields
371 of this type.
372<P>
373<DD><DL>
374<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getSortField(org.apache.solr.schema.SchemaField, boolean)">getSortField</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
375</DD>
376<DD><DL>
377<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/SchemaField.html#checkSortability()"><CODE>SchemaField.checkSortability()</CODE></A></DL>
378</DD>
379</DL>
380<HR>
381
382<A NAME="getAnalyzer()"><!-- --></A><H3>
383getAnalyzer</H3>
384<PRE>
385public <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>
386<DL>
387<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getAnalyzer()">FieldType</A></CODE></B></DD>
388<DD>Returns the Analyzer to be used when indexing fields of this type.
389 <p>
390 This method may be called many times, at any time.
391 </p>
392<P>
393<DD><DL>
394<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getAnalyzer()">getAnalyzer</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
395</DD>
396<DD><DL>
397<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#getQueryAnalyzer()"><CODE>FieldType.getQueryAnalyzer()</CODE></A></DL>
398</DD>
399</DL>
400<HR>
401
402<A NAME="getQueryAnalyzer()"><!-- --></A><H3>
403getQueryAnalyzer</H3>
404<PRE>
405public <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>
406<DL>
407<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getQueryAnalyzer()">FieldType</A></CODE></B></DD>
408<DD>Returns the Analyzer to be used when searching fields of this type.
409 <p>
410 This method may be called many times, at any time.
411 </p>
412<P>
413<DD><DL>
414<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getQueryAnalyzer()">getQueryAnalyzer</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
415</DD>
416<DD><DL>
417<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#getAnalyzer()"><CODE>FieldType.getAnalyzer()</CODE></A></DL>
418</DD>
419</DL>
420<HR>
421
422<A NAME="getRangeQuery(org.apache.solr.search.QParser, org.apache.solr.schema.SchemaField, java.lang.String, java.lang.String, boolean, boolean)"><!-- --></A><H3>
423getRangeQuery</H3>
424<PRE>
425public <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,
426                           <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
427                           <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,
428                           <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,
429                           boolean&nbsp;minInclusive,
430                           boolean&nbsp;maxInclusive)</PRE>
431<DL>
432<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getRangeQuery(org.apache.solr.search.QParser, org.apache.solr.schema.SchemaField, java.lang.String, java.lang.String, boolean, boolean)">FieldType</A></CODE></B></DD>
433<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>
434 currently passes part1 and part2 as null if they are '*' respectively. minInclusive and maxInclusive are both true
435 currently by SolrQueryParser but that may change in the future. Also, other QueryParser implementations may have
436 different semantics.
437 <p/>
438 Sub-classes should override this method to provide their own range query implementation. They should strive to
439 handle nulls in part1 and/or part2 as well as unequal minInclusive and maxInclusive parameters gracefully.
440<P>
441<DD><DL>
442<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getRangeQuery(org.apache.solr.search.QParser, org.apache.solr.schema.SchemaField, java.lang.String, java.lang.String, boolean, boolean)">getRangeQuery</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
443</DD>
444<DD><DL>
445<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
446<DT><B>Returns:</B><DD>a Query instance to perform range search according to given parameters</DL>
447</DD>
448</DL>
449<!-- ========= END OF CLASS DATA ========= -->
450<HR>
451
452
453<!-- ======= START OF BOTTOM NAVBAR ====== -->
454<A NAME="navbar_bottom"><!-- --></A>
455<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
456<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
457<TR>
458<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
459<A NAME="navbar_bottom_firstrow"><!-- --></A>
460<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
461  <TR ALIGN="center" VALIGN="top">
462  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
463  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
464  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
465  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/CollationField.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
466  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
467  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
468  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
469  </TR>
470</TABLE>
471</TD>
472<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
473</EM>
474</TD>
475</TR>
476
477<TR>
478<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
479&nbsp;<A HREF="../../../../org/apache/solr/schema/ByteField.html" title="class in org.apache.solr.schema"><B>PREV CLASS</B></A>&nbsp;
480&nbsp;<A HREF="../../../../org/apache/solr/schema/CoordinateFieldType.html" title="class in org.apache.solr.schema"><B>NEXT CLASS</B></A></FONT></TD>
481<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
482  <A HREF="../../../../index.html?org/apache/solr/schema/CollationField.html" target="_top"><B>FRAMES</B></A>  &nbsp;
483&nbsp;<A HREF="CollationField.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
484&nbsp;<SCRIPT type="text/javascript">
485  <!--
486  if(window==top) {
487    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
488  }
489  //-->
490</SCRIPT>
491<NOSCRIPT>
492  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
493</NOSCRIPT>
494
495
496</FONT></TD>
497</TR>
498<TR>
499<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
500  SUMMARY:&nbsp;<A HREF="#nested_classes_inherited_from_class_org.apache.solr.schema.FieldType">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.solr.schema.FieldType">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
501<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
502DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
503</TR>
504</TABLE>
505<A NAME="skip-navbar_bottom"></A>
506<!-- ======== END OF BOTTOM NAVBAR ======= -->
507
508<HR>
509
510          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
511          <script src='../../../../prettify.js' type='text/javascript'></script>
512          <script type='text/javascript'>
513            (function(){
514              var oldonload = window.onload;
515              if (typeof oldonload != 'function') {
516                window.onload = prettyPrint;
517              } else {
518                window.onload = function() {
519                  oldonload();
520                  prettyPrint();
521                }
522              }
523            })();
524          </script>
525       
526</BODY>
527</HTML>
Note: See TracBrowser for help on using the repository browser.