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

Revision 7588, 32.3 KB checked in by adir, 11 years ago (diff)

Ticket #000 - Adicionando a integracao de buscas com Solr na base a ser isnerida na comunidade

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_24) on Mon Jun 25 15:26:25 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8ExternalFileField (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="ExternalFileField (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/ExternalFileField.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/ExchangeRateProvider.html" title="interface in org.apache.solr.schema"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/schema/FieldProperties.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/ExternalFileField.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="ExternalFileField.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 ExternalFileField</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.ExternalFileField</B>
99</PRE>
100<HR>
101<DL>
102<DT><PRE>public class <B>ExternalFileField</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>
106Get values from an external file instead of the index.
107
108 <p/><code>keyField</code> will normally be the unique key field, but it doesn't have to be.
109 <ul><li> It's OK to have a keyField value that can't be found in the index</li>
110 <li>It's OK to have some documents without a keyField in the file (defVal is used as the default)</li>
111 <li>It's OK for a keyField value to point to multiple documents (no uniqueness requirement)</li>
112 </ul>
113 <code>valType</code> is a reference to another fieldType to define the value type of this field
114 (must currently be TrieFloatField or FloatField (valType="pfloat|float|tfloat") if used).
115 This parameter has never been implemented. As of Solr 3.6/4.0 it is optional and can be omitted.
116
117 The format of the external file is simply newline separated keyFieldValue=floatValue.
118 <br/>Example:
119 <br/><code>doc33=1.414</code>
120 <br/><code>doc34=3.14159</code>
121 <br/><code>doc40=42</code>
122
123 <p/>Solr looks for the external file in the index directory under the name of
124 external_&lt;fieldname&gt; or external_&lt;fieldname&gt;.*
125
126 <p/>If any files of the latter pattern appear, the last (after being sorted by name) will be used and previous versions will be deleted.
127 This is to help support systems where one may not be able to overwrite a file (like Windows, if the file is in use).
128 <p/>If the external file has already been loaded, and it is changed, those changes will not be visible until a commit has been done.
129 <p/>The external file may be sorted or unsorted by the key field, but it will be substantially slower (untested) if it isn't sorted.
130 <p/>Fields of this type may currently only be used as a ValueSource in a FunctionQuery.
131<P>
132
133<P>
134<HR>
135
136<P>
137<!-- ======== NESTED CLASS SUMMARY ======== -->
138
139<A NAME="nested_class_summary"><!-- --></A>
140<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
141<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
142<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
143<B>Nested Class Summary</B></FONT></TH>
144</TR>
145</TABLE>
146&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.schema.FieldType"><!-- --></A>
147<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
148<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
149<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>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.DefaultAnalyzer.html" title="class in org.apache.solr.schema">FieldType.DefaultAnalyzer</A></CODE></TD>
153</TR>
154</TABLE>
155&nbsp;
156<!-- =========== FIELD SUMMARY =========== -->
157
158<A NAME="field_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>Field Summary</B></FONT></TH>
163</TR>
164</TABLE>
165&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.schema.FieldType"><!-- --></A>
166<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
167<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
168<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>
169</TR>
170<TR BGCOLOR="white" CLASS="TableRowColor">
171<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>
172</TR>
173</TABLE>
174&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.schema.FieldProperties"><!-- --></A>
175<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
176<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
177<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>
178</TR>
179<TR BGCOLOR="white" CLASS="TableRowColor">
180<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>
181</TR>
182</TABLE>
183&nbsp;
184<!-- ======== CONSTRUCTOR SUMMARY ======== -->
185
186<A NAME="constructor_summary"><!-- --></A>
187<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
188<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
189<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
190<B>Constructor Summary</B></FONT></TH>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/ExternalFileField.html#ExternalFileField()">ExternalFileField</A></B>()</CODE>
194
195<BR>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
197</TR>
198</TABLE>
199&nbsp;
200<!-- ========== METHOD SUMMARY =========== -->
201
202<A NAME="method_summary"><!-- --></A>
203<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
204<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
205<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
206<B>Method Summary</B></FONT></TH>
207</TR>
208<TR BGCOLOR="white" CLASS="TableRowColor">
209<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
210<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>
211<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/ExternalFileField.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,
212             boolean&nbsp;reverse)</CODE>
213
214<BR>
215&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the SortField instance that should be used to sort fields
216 of this type.</TD>
217</TR>
218<TR BGCOLOR="white" CLASS="TableRowColor">
219<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">ValueSource</A></CODE></FONT></TD>
221<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/ExternalFileField.html#getValueSource(org.apache.solr.schema.SchemaField, org.apache.solr.search.QParser)">getValueSource</A></B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
222               <A HREF="../../../../org/apache/solr/search/QParser.html" title="class in org.apache.solr.search">QParser</A>&nbsp;parser)</CODE>
223
224<BR>
225&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;called to get the default value source (normally, from the
226  Lucene FieldCache.)</TD>
227</TR>
228<TR BGCOLOR="white" CLASS="TableRowColor">
229<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
230<CODE>protected &nbsp;void</CODE></FONT></TD>
231<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/ExternalFileField.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,
232     <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>
233
234<BR>
235&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;subclasses should initialize themselves with the args provided
236 and remove valid arguments.</TD>
237</TR>
238<TR BGCOLOR="white" CLASS="TableRowColor">
239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240<CODE>&nbsp;void</CODE></FONT></TD>
241<TD><CODE><B><A HREF="../../../../org/apache/solr/schema/ExternalFileField.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,
242      <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,
243      <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>
244
245<BR>
246&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;calls back to TextResponseWriter to write the field value</TD>
247</TR>
248</TABLE>
249&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.schema.FieldType"><!-- --></A>
250<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
251<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
252<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>
253</TR>
254<TR BGCOLOR="white" CLASS="TableRowColor">
255<TD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#createField(org.apache.solr.schema.SchemaField, java.lang.Object, float)">createField</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#createField(java.lang.String, java.lang.String, org.apache.lucene.document.FieldType, float)">createField</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#createFields(org.apache.solr.schema.SchemaField, java.lang.Object, float)">createFields</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getAnalyzer()">getAnalyzer</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#getArg(java.lang.String, java.util.Map)">getArg</A>, <A HREF="../../../../org/apache/solr/schema/FieldType.html#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#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>
256</TR>
257</TABLE>
258&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
259<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
260<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
261<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>
262</TR>
263<TR BGCOLOR="white" CLASS="TableRowColor">
264<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>
265</TR>
266</TABLE>
267&nbsp;
268<P>
269
270<!-- ========= CONSTRUCTOR DETAIL ======== -->
271
272<A NAME="constructor_detail"><!-- --></A>
273<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
274<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
275<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
276<B>Constructor Detail</B></FONT></TH>
277</TR>
278</TABLE>
279
280<A NAME="ExternalFileField()"><!-- --></A><H3>
281ExternalFileField</H3>
282<PRE>
283public <B>ExternalFileField</B>()</PRE>
284<DL>
285</DL>
286
287<!-- ============ METHOD DETAIL ========== -->
288
289<A NAME="method_detail"><!-- --></A>
290<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
291<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
292<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
293<B>Method Detail</B></FONT></TH>
294</TR>
295</TABLE>
296
297<A NAME="init(org.apache.solr.schema.IndexSchema, java.util.Map)"><!-- --></A><H3>
298init</H3>
299<PRE>
300protected void <B>init</B>(<A HREF="../../../../org/apache/solr/schema/IndexSchema.html" title="class in org.apache.solr.schema">IndexSchema</A>&nbsp;schema,
301                    <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>
302<DL>
303<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>
304<DD>subclasses should initialize themselves with the args provided
305 and remove valid arguments.  leftover arguments will cause an exception.
306 Common boolean properties have already been handled.
307<P>
308<DD><DL>
309<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>
310</DD>
311<DD><DL>
312</DL>
313</DD>
314</DL>
315<HR>
316
317<A NAME="write(org.apache.solr.response.TextResponseWriter, java.lang.String, org.apache.lucene.index.IndexableField)"><!-- --></A><H3>
318write</H3>
319<PRE>
320public void <B>write</B>(<A HREF="../../../../org/apache/solr/response/TextResponseWriter.html" title="class in org.apache.solr.response">TextResponseWriter</A>&nbsp;writer,
321                  <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,
322                  <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)
323           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>
324<DL>
325<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>
326<DD>calls back to TextResponseWriter to write the field value
327<P>
328<DD><DL>
329<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>
330</DD>
331<DD><DL>
332
333<DT><B>Throws:</B>
334<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>
335</DD>
336</DL>
337<HR>
338
339<A NAME="getSortField(org.apache.solr.schema.SchemaField, boolean)"><!-- --></A><H3>
340getSortField</H3>
341<PRE>
342public <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,
343                              boolean&nbsp;reverse)</PRE>
344<DL>
345<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>
346<DD>Returns the SortField instance that should be used to sort fields
347 of this type.
348<P>
349<DD><DL>
350<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>
351</DD>
352<DD><DL>
353<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/SchemaField.html#checkSortability()"><CODE>SchemaField.checkSortability()</CODE></A></DL>
354</DD>
355</DL>
356<HR>
357
358<A NAME="getValueSource(org.apache.solr.schema.SchemaField, org.apache.solr.search.QParser)"><!-- --></A><H3>
359getValueSource</H3>
360<PRE>
361public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//queries/org/apache/lucene/queries/function/ValueSource.html?is-external=true" title="class or interface in org.apache.lucene.queries.function">ValueSource</A> <B>getValueSource</B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>&nbsp;field,
362                                  <A HREF="../../../../org/apache/solr/search/QParser.html" title="class in org.apache.solr.search">QParser</A>&nbsp;parser)</PRE>
363<DL>
364<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getValueSource(org.apache.solr.schema.SchemaField, org.apache.solr.search.QParser)">FieldType</A></CODE></B></DD>
365<DD>called to get the default value source (normally, from the
366  Lucene FieldCache.)
367<P>
368<DD><DL>
369<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html#getValueSource(org.apache.solr.schema.SchemaField, org.apache.solr.search.QParser)">getValueSource</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></DL>
370</DD>
371<DD><DL>
372</DL>
373</DD>
374</DL>
375<!-- ========= END OF CLASS DATA ========= -->
376<HR>
377
378
379<!-- ======= START OF BOTTOM NAVBAR ====== -->
380<A NAME="navbar_bottom"><!-- --></A>
381<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
382<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
383<TR>
384<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
385<A NAME="navbar_bottom_firstrow"><!-- --></A>
386<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
387  <TR ALIGN="center" VALIGN="top">
388  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
389  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
390  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
391  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ExternalFileField.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
392  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
393  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
394  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
395  </TR>
396</TABLE>
397</TD>
398<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
399</EM>
400</TD>
401</TR>
402
403<TR>
404<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
405&nbsp;<A HREF="../../../../org/apache/solr/schema/ExchangeRateProvider.html" title="interface in org.apache.solr.schema"><B>PREV CLASS</B></A>&nbsp;
406&nbsp;<A HREF="../../../../org/apache/solr/schema/FieldProperties.html" title="class in org.apache.solr.schema"><B>NEXT CLASS</B></A></FONT></TD>
407<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
408  <A HREF="../../../../index.html?org/apache/solr/schema/ExternalFileField.html" target="_top"><B>FRAMES</B></A>  &nbsp;
409&nbsp;<A HREF="ExternalFileField.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
410&nbsp;<SCRIPT type="text/javascript">
411  <!--
412  if(window==top) {
413    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
414  }
415  //-->
416</SCRIPT>
417<NOSCRIPT>
418  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
419</NOSCRIPT>
420
421
422</FONT></TD>
423</TR>
424<TR>
425<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
426  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>
427<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
428DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
429</TR>
430</TABLE>
431<A NAME="skip-navbar_bottom"></A>
432<!-- ======== END OF BOTTOM NAVBAR ======= -->
433
434<HR>
435
436          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
437          <script src='../../../../prettify.js' type='text/javascript'></script>
438          <script type='text/javascript'>
439            (function(){
440              var oldonload = window.onload;
441              if (typeof oldonload != 'function') {
442                window.onload = prettyPrint;
443              } else {
444                window.onload = function() {
445                  oldonload();
446                  prettyPrint();
447                }
448              }
449            })();
450          </script>
451       
452</BODY>
453</HTML>
Note: See TracBrowser for help on using the repository browser.