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

Revision 7588, 32.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
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>
8BinaryField (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="BinaryField (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/BinaryField.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/BCDStrField.html" title="class in org.apache.solr.schema"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/schema/BoolField.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/BinaryField.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="BinaryField.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 BinaryField</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.BinaryField</B>
99</PRE>
100<HR>
101<DL>
102<DT><PRE>public class <B>BinaryField</B><DT>extends <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></DL>
103</PRE>
104
105<P>
106<HR>
107
108<P>
109<!-- ======== NESTED CLASS SUMMARY ======== -->
110
111<A NAME="nested_class_summary"><!-- --></A>
112<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
113<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
114<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
115<B>Nested Class Summary</B></FONT></TH>
116</TR>
117</TABLE>
118&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.schema.FieldType"><!-- --></A>
119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
121<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>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.DefaultAnalyzer.html" title="class in org.apache.solr.schema">FieldType.DefaultAnalyzer</A></CODE></TD>
125</TR>
126</TABLE>
127&nbsp;
128<!-- =========== FIELD SUMMARY =========== -->
129
130<A NAME="field_summary"><!-- --></A>
131<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
132<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
133<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
134<B>Field Summary</B></FONT></TH>
135</TR>
136</TABLE>
137&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.schema.FieldType"><!-- --></A>
138<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
139<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
140<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>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#analyzer">analyzer</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#args">args</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#falseProperties">falseProperties</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#log">log</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#POLY_FIELD_SEPARATOR">POLY_FIELD_SEPARATOR</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#postingsFormat">postingsFormat</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#queryAnalyzer">queryAnalyzer</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#similarity">similarity</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#trueProperties">trueProperties</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#typeName">typeName</A></CODE></TD>
144</TR>
145</TABLE>
146&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.schema.FieldProperties"><!-- --></A>
147<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
148<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
149<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>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<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>
153</TR>
154</TABLE>
155&nbsp;
156<!-- ======== CONSTRUCTOR SUMMARY ======== -->
157
158<A NAME="constructor_summary"><!-- --></A>
159<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
160<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
161<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
162<B>Constructor Summary</B></FONT></TH>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/BinaryField.html#BinaryField()">BinaryField</A></B>()</CODE>
166
167<BR>
168&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
169</TR>
170</TABLE>
171&nbsp;
172<!-- ========== METHOD SUMMARY =========== -->
173
174<A NAME="method_summary"><!-- --></A>
175<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
176<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
177<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
178<B>Method Summary</B></FONT></TH>
179</TR>
180<TR BGCOLOR="white" CLASS="TableRowColor">
181<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
182<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>
183<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/BinaryField.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,
184            <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;val,
185            float&nbsp;boost)</CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used for adding a document when a field needs to be created from a
189 type and a string.</TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
193<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>
194<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/BinaryField.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,
195             boolean&nbsp;top)</CODE>
196
197<BR>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the SortField instance that should be used to sort fields
199 of this type.</TD>
200</TR>
201<TR BGCOLOR="white" CLASS="TableRowColor">
202<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
203<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>
204<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/BinaryField.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>
205
206<BR>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert the stored-field format to an external (string, human readable)
208 value</TD>
209</TR>
210<TR BGCOLOR="white" CLASS="TableRowColor">
211<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
212<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</A></CODE></FONT></TD>
213<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/BinaryField.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>
214
215<BR>
216&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert the stored-field format to an external object.</TD>
217</TR>
218<TR BGCOLOR="white" CLASS="TableRowColor">
219<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220<CODE>&nbsp;void</CODE></FONT></TD>
221<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/BinaryField.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,
222      <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,
223      <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>
224
225<BR>
226&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;calls back to TextResponseWriter to write the field value</TD>
227</TR>
228</TABLE>
229&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.schema.FieldType"><!-- --></A>
230<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
231<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
232<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>
233</TR>
234<TR BGCOLOR="white" CLASS="TableRowColor">
235<TD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#createField(java.lang.String, java.lang.String, org.apache.lucene.document.FieldType, float)">createField</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#createFields(org.apache.solr.schema.SchemaField, java.lang.Object, float)">createFields</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getAnalyzer()">getAnalyzer</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getArg(java.lang.String, java.util.Map)">getArg</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#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#getQueryAnalyzer()">getQueryAnalyzer</A>, <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>, <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#init(org.apache.solr.schema.IndexSchema, java.util.Map)">init</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#toInternal(java.lang.String)">toInternal</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>
236</TR>
237</TABLE>
238&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
239<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
240<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
241<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>
242</TR>
243<TR BGCOLOR="white" CLASS="TableRowColor">
244<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>
245</TR>
246</TABLE>
247&nbsp;
248<P>
249
250<!-- ========= CONSTRUCTOR DETAIL ======== -->
251
252<A NAME="constructor_detail"><!-- --></A>
253<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
254<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
255<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
256<B>Constructor Detail</B></FONT></TH>
257</TR>
258</TABLE>
259
260<A NAME="BinaryField()"><!-- --></A><H3>
261BinaryField</H3>
262<PRE>
263public <B>BinaryField</B>()</PRE>
264<DL>
265</DL>
266
267<!-- ============ METHOD DETAIL ========== -->
268
269<A NAME="method_detail"><!-- --></A>
270<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
271<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
272<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
273<B>Method Detail</B></FONT></TH>
274</TR>
275</TABLE>
276
277<A NAME="write(org.apache.solr.response.TextResponseWriter, java.lang.String, org.apache.lucene.index.IndexableField)"><!-- --></A><H3>
278write</H3>
279<PRE>
280public void <B>write</B>(<A HREF="../../../../org/apache/solr/response/TextResponseWriter.html" title="class in org.apache.solr.response">TextResponseWriter</A>&nbsp;writer,
281                  <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,
282                  <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)
283           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>
284<DL>
285<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>
286<DD>calls back to TextResponseWriter to write the field value
287<P>
288<DD><DL>
289<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>
290</DD>
291<DD><DL>
292
293<DT><B>Throws:</B>
294<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>
295</DD>
296</DL>
297<HR>
298
299<A NAME="getSortField(org.apache.solr.schema.SchemaField, boolean)"><!-- --></A><H3>
300getSortField</H3>
301<PRE>
302public <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,
303                              boolean&nbsp;top)</PRE>
304<DL>
305<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>
306<DD>Returns the SortField instance that should be used to sort fields
307 of this type.
308<P>
309<DD><DL>
310<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>
311</DD>
312<DD><DL>
313<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/SchemaField.html#checkSortability()"><CODE>SchemaField.checkSortability()</CODE></A></DL>
314</DD>
315</DL>
316<HR>
317
318<A NAME="toExternal(org.apache.lucene.index.IndexableField)"><!-- --></A><H3>
319toExternal</H3>
320<PRE>
321public <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>
322<DL>
323<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#toExternal(org.apache.lucene.index.IndexableField)">FieldType</A></CODE></B></DD>
324<DD>Convert the stored-field format to an external (string, human readable)
325 value
326<P>
327<DD><DL>
328<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#toExternal(org.apache.lucene.index.IndexableField)">toExternal</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
329</DD>
330<DD><DL>
331<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#toInternal(java.lang.String)"><CODE>FieldType.toInternal(java.lang.String)</CODE></A></DL>
332</DD>
333</DL>
334<HR>
335
336<A NAME="toObject(org.apache.lucene.index.IndexableField)"><!-- --></A><H3>
337toObject</H3>
338<PRE>
339public <A HREF="http://download.oracle.com/javase/6/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</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>
340<DL>
341<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#toObject(org.apache.lucene.index.IndexableField)">FieldType</A></CODE></B></DD>
342<DD>Convert the stored-field format to an external object.
343<P>
344<DD><DL>
345<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#toObject(org.apache.lucene.index.IndexableField)">toObject</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
346</DD>
347<DD><DL>
348<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#toInternal(java.lang.String)"><CODE>FieldType.toInternal(java.lang.String)</CODE></A></DL>
349</DD>
350</DL>
351<HR>
352
353<A NAME="createField(org.apache.solr.schema.SchemaField, java.lang.Object, float)"><!-- --></A><H3>
354createField</H3>
355<PRE>
356public <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,
357                                  <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;val,
358                                  float&nbsp;boost)</PRE>
359<DL>
360<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#createField(org.apache.solr.schema.SchemaField, java.lang.Object, float)">FieldType</A></CODE></B></DD>
361<DD>Used for adding a document when a field needs to be created from a
362 type and a string.
363
364 <p>
365 By default, the indexed value is the same as the stored value
366 (taken from toInternal()).   Having a different representation for
367 external, internal, and indexed would present quite a few problems
368 given the current Lucene architecture.  An analyzer for adding docs
369 would need to translate internal->indexed while an analyzer for
370 querying would need to translate external-&gt;indexed.
371 </p>
372 <p>
373 The only other alternative to having internal==indexed would be to have
374 internal==external.   In this case, toInternal should convert to
375 the indexed representation, toExternal() should do nothing, and
376 createField() should *not* call toInternal, but use the external
377 value and set tokenized=true to get Lucene to convert to the
378 internal(indexed) form.
379 </p>
380
381 :TODO: clean up and clarify this explanation.
382<P>
383<DD><DL>
384<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#createField(org.apache.solr.schema.SchemaField, java.lang.Object, float)">createField</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
385</DD>
386<DD><DL>
387<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/FieldType.html#toInternal(java.lang.String)"><CODE>FieldType.toInternal(java.lang.String)</CODE></A></DL>
388</DD>
389</DL>
390<!-- ========= END OF CLASS DATA ========= -->
391<HR>
392
393
394<!-- ======= START OF BOTTOM NAVBAR ====== -->
395<A NAME="navbar_bottom"><!-- --></A>
396<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
397<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
398<TR>
399<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
400<A NAME="navbar_bottom_firstrow"><!-- --></A>
401<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
402  <TR ALIGN="center" VALIGN="top">
403  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
404  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
405  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
406  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BinaryField.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
407  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
408  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
409  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
410  </TR>
411</TABLE>
412</TD>
413<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
414</EM>
415</TD>
416</TR>
417
418<TR>
419<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
420&nbsp;<A HREF="../../../../org/apache/solr/schema/BCDStrField.html" title="class in org.apache.solr.schema"><B>PREV CLASS</B></A>&nbsp;
421&nbsp;<A HREF="../../../../org/apache/solr/schema/BoolField.html" title="class in org.apache.solr.schema"><B>NEXT CLASS</B></A></FONT></TD>
422<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
423  <A HREF="../../../../index.html?org/apache/solr/schema/BinaryField.html" target="_top"><B>FRAMES</B></A>  &nbsp;
424&nbsp;<A HREF="BinaryField.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
425&nbsp;<SCRIPT type="text/javascript">
426  <!--
427  if(window==top) {
428    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
429  }
430  //-->
431</SCRIPT>
432<NOSCRIPT>
433  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
434</NOSCRIPT>
435
436
437</FONT></TD>
438</TR>
439<TR>
440<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
441  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>
442<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
443DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
444</TR>
445</TABLE>
446<A NAME="skip-navbar_bottom"></A>
447<!-- ======== END OF BOTTOM NAVBAR ======= -->
448
449<HR>
450
451          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
452          <script src='../../../../prettify.js' type='text/javascript'></script>
453          <script type='text/javascript'>
454            (function(){
455              var oldonload = window.onload;
456              if (typeof oldonload != 'function') {
457                window.onload = prettyPrint;
458              } else {
459                window.onload = function() {
460                  oldonload();
461                  prettyPrint();
462                }
463              }
464            })();
465          </script>
466       
467</BODY>
468</HTML>
Note: See TracBrowser for help on using the repository browser.