1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
---|
2 | <!--NewPage--> |
---|
3 | <HTML> |
---|
4 | <HEAD> |
---|
5 | <!-- Generated by javadoc (build 1.6.0_24) on Mon Jun 25 15:26:25 EDT 2012 --> |
---|
6 | <META http-equiv="Content-Type" content="text/html; charset=utf-8"> |
---|
7 | <TITLE> |
---|
8 | SimplePreAnalyzedParser (Solr 4.0.0-ALPHA API) |
---|
9 | </TITLE> |
---|
10 | |
---|
11 | <META NAME="date" CONTENT="2012-06-25"> |
---|
12 | |
---|
13 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
---|
14 | |
---|
15 | <SCRIPT type="text/javascript"> |
---|
16 | function windowTitle() |
---|
17 | { |
---|
18 | if (location.href.indexOf('is-external=true') == -1) { |
---|
19 | parent.document.title="SimplePreAnalyzedParser (Solr 4.0.0-ALPHA API)"; |
---|
20 | } |
---|
21 | } |
---|
22 | </SCRIPT> |
---|
23 | <NOSCRIPT> |
---|
24 | </NOSCRIPT> |
---|
25 | |
---|
26 | </HEAD> |
---|
27 | |
---|
28 | <BODY BGCOLOR="white" onload="windowTitle();"> |
---|
29 | <HR> |
---|
30 | |
---|
31 | |
---|
32 | <!-- ========= START OF TOP NAVBAR ======= --> |
---|
33 | <A NAME="navbar_top"><!-- --></A> |
---|
34 | <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
---|
35 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
36 | <TR> |
---|
37 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
38 | <A NAME="navbar_top_firstrow"><!-- --></A> |
---|
39 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
40 | <TR ALIGN="center" VALIGN="top"> |
---|
41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
42 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
43 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
44 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SimplePreAnalyzedParser.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
45 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
46 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
47 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
48 | </TR> |
---|
49 | </TABLE> |
---|
50 | </TD> |
---|
51 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
52 | </EM> |
---|
53 | </TD> |
---|
54 | </TR> |
---|
55 | |
---|
56 | <TR> |
---|
57 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
58 | <A HREF="../../../../org/apache/solr/schema/SimilarityFactory.html" title="class in org.apache.solr.schema"><B>PREV CLASS</B></A> |
---|
59 | <A HREF="../../../../org/apache/solr/schema/SortableDoubleField.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/SimplePreAnalyzedParser.html" target="_top"><B>FRAMES</B></A> |
---|
62 | <A HREF="SimplePreAnalyzedParser.html" target="_top"><B>NO FRAMES</B></A> |
---|
63 | <SCRIPT type="text/javascript"> |
---|
64 | <!-- |
---|
65 | if(window==top) { |
---|
66 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
67 | } |
---|
68 | //--> |
---|
69 | </SCRIPT> |
---|
70 | <NOSCRIPT> |
---|
71 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
72 | </NOSCRIPT> |
---|
73 | |
---|
74 | |
---|
75 | </FONT></TD> |
---|
76 | </TR> |
---|
77 | <TR> |
---|
78 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
79 | SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
80 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
81 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
82 | </TR> |
---|
83 | </TABLE> |
---|
84 | <A NAME="skip-navbar_top"></A> |
---|
85 | <!-- ========= END OF TOP NAVBAR ========= --> |
---|
86 | |
---|
87 | <HR> |
---|
88 | <!-- ======== START OF CLASS DATA ======== --> |
---|
89 | <H2> |
---|
90 | <FONT SIZE="-1"> |
---|
91 | org.apache.solr.schema</FONT> |
---|
92 | <BR> |
---|
93 | Class SimplePreAnalyzedParser</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 "><B>org.apache.solr.schema.SimplePreAnalyzedParser</B> |
---|
97 | </PRE> |
---|
98 | <DL> |
---|
99 | <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/solr/schema/PreAnalyzedField.PreAnalyzedParser.html" title="interface in org.apache.solr.schema">PreAnalyzedField.PreAnalyzedParser</A></DD> |
---|
100 | </DL> |
---|
101 | <HR> |
---|
102 | <DL> |
---|
103 | <DT><PRE>public final class <B>SimplePreAnalyzedParser</B><DT>extends <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><DT>implements <A HREF="../../../../org/apache/solr/schema/PreAnalyzedField.PreAnalyzedParser.html" title="interface in org.apache.solr.schema">PreAnalyzedField.PreAnalyzedParser</A></DL> |
---|
104 | </PRE> |
---|
105 | |
---|
106 | <P> |
---|
107 | Simple plain text format parser for <A HREF="../../../../org/apache/solr/schema/PreAnalyzedField.html" title="class in org.apache.solr.schema"><CODE>PreAnalyzedField</CODE></A>. |
---|
108 | <h2>Serialization format</h2> |
---|
109 | <p>The format of the serialization is as follows: |
---|
110 | <pre> |
---|
111 | content ::= version (stored)? tokens |
---|
112 | version ::= digit+ " " |
---|
113 | ; stored field value - any "=" inside must be escaped! |
---|
114 | stored ::= "=" text "=" |
---|
115 | tokens ::= (token ((" ") + token)*)* |
---|
116 | token ::= text ("," attrib)* |
---|
117 | attrib ::= name '=' value |
---|
118 | name ::= text |
---|
119 | value ::= text |
---|
120 | </pre> |
---|
121 | <p>Special characters in "text" values can be escaped |
---|
122 | using the escape character \ . The following escape sequences are recognized: |
---|
123 | <pre> |
---|
124 | "\ " - literal space character |
---|
125 | "\," - literal , character |
---|
126 | "\=" - literal = character |
---|
127 | "\\" - literal \ character |
---|
128 | "\n" - newline |
---|
129 | "\r" - carriage return |
---|
130 | "\t" - horizontal tab |
---|
131 | </pre> |
---|
132 | Please note that Unicode sequences (e.g. ) are not supported. |
---|
133 | <h2>Supported attribute names</h2> |
---|
134 | The following token attributes are supported, and identified with short |
---|
135 | symbolic names: |
---|
136 | <pre> |
---|
137 | i - position increment (integer) |
---|
138 | s - token offset, start position (integer) |
---|
139 | e - token offset, end position (integer) |
---|
140 | t - token type (string) |
---|
141 | f - token flags (hexadecimal integer) |
---|
142 | p - payload (bytes in hexadecimal format) |
---|
143 | </pre> |
---|
144 | Token positions are tracked and implicitly added to the token stream - |
---|
145 | the start and end offsets consider only the term text and whitespace, |
---|
146 | and exclude the space taken by token attributes. |
---|
147 | <h2>Example token streams</h2> |
---|
148 | <pre> |
---|
149 | 1 one two three |
---|
150 | - version 1 |
---|
151 | - stored: 'null' |
---|
152 | - tok: '(term=one,startOffset=0,endOffset=3)' |
---|
153 | - tok: '(term=two,startOffset=4,endOffset=7)' |
---|
154 | - tok: '(term=three,startOffset=8,endOffset=13)' |
---|
155 | 1 one two three |
---|
156 | - version 1 |
---|
157 | - stored: 'null' |
---|
158 | - tok: '(term=one,startOffset=1,endOffset=4)' |
---|
159 | - tok: '(term=two,startOffset=6,endOffset=9)' |
---|
160 | - tok: '(term=three,startOffset=12,endOffset=17)' |
---|
161 | 1 one,s=123,e=128,i=22 two three,s=20,e=22 |
---|
162 | - version 1 |
---|
163 | - stored: 'null' |
---|
164 | - tok: '(term=one,positionIncrement=22,startOffset=123,endOffset=128)' |
---|
165 | - tok: '(term=two,positionIncrement=1,startOffset=5,endOffset=8)' |
---|
166 | - tok: '(term=three,positionIncrement=1,startOffset=20,endOffset=22)' |
---|
167 | 1 \ one\ \,,i=22,a=\, two\= |
---|
168 | |
---|
169 | \n,\ =\ \ |
---|
170 | - version 1 |
---|
171 | - stored: 'null' |
---|
172 | - tok: '(term= one ,,positionIncrement=22,startOffset=0,endOffset=6)' |
---|
173 | - tok: '(term=two= |
---|
174 | |
---|
175 | |
---|
176 | ,positionIncrement=1,startOffset=7,endOffset=15)' |
---|
177 | - tok: '(term=\,positionIncrement=1,startOffset=17,endOffset=18)' |
---|
178 | 1 ,i=22 ,i=33,s=2,e=20 , |
---|
179 | - version 1 |
---|
180 | - stored: 'null' |
---|
181 | - tok: '(term=,positionIncrement=22,startOffset=0,endOffset=0)' |
---|
182 | - tok: '(term=,positionIncrement=33,startOffset=2,endOffset=20)' |
---|
183 | - tok: '(term=,positionIncrement=1,startOffset=2,endOffset=2)' |
---|
184 | 1 =This is the stored part with \= |
---|
185 | \n \t escapes.=one two three |
---|
186 | - version 1 |
---|
187 | - stored: 'This is the stored part with = |
---|
188 | \n \t escapes.' |
---|
189 | - tok: '(term=one,startOffset=0,endOffset=3)' |
---|
190 | - tok: '(term=two,startOffset=4,endOffset=7)' |
---|
191 | - tok: '(term=three,startOffset=8,endOffset=13)' |
---|
192 | 1 == |
---|
193 | - version 1 |
---|
194 | - stored: '' |
---|
195 | - (no tokens) |
---|
196 | 1 =this is a test.= |
---|
197 | - version 1 |
---|
198 | - stored: 'this is a test.' |
---|
199 | - (no tokens) |
---|
200 | </pre> |
---|
201 | <P> |
---|
202 | |
---|
203 | <P> |
---|
204 | <HR> |
---|
205 | |
---|
206 | <P> |
---|
207 | |
---|
208 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
---|
209 | |
---|
210 | <A NAME="constructor_summary"><!-- --></A> |
---|
211 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
212 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
213 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
214 | <B>Constructor Summary</B></FONT></TH> |
---|
215 | </TR> |
---|
216 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
217 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SimplePreAnalyzedParser.html#SimplePreAnalyzedParser()">SimplePreAnalyzedParser</A></B>()</CODE> |
---|
218 | |
---|
219 | <BR> |
---|
220 | </TD> |
---|
221 | </TR> |
---|
222 | </TABLE> |
---|
223 | |
---|
224 | <!-- ========== METHOD SUMMARY =========== --> |
---|
225 | |
---|
226 | <A NAME="method_summary"><!-- --></A> |
---|
227 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
228 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
229 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
230 | <B>Method Summary</B></FONT></TH> |
---|
231 | </TR> |
---|
232 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
233 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
234 | <CODE> <A HREF="../../../../org/apache/solr/schema/PreAnalyzedField.ParseResult.html" title="class in org.apache.solr.schema">PreAnalyzedField.ParseResult</A></CODE></FONT></TD> |
---|
235 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SimplePreAnalyzedParser.html#parse(java.io.Reader, org.apache.lucene.util.AttributeSource)">parse</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> reader, |
---|
236 | <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/AttributeSource.html?is-external=true" title="class or interface in org.apache.lucene.util">AttributeSource</A> parent)</CODE> |
---|
237 | |
---|
238 | <BR> |
---|
239 | Parse input.</TD> |
---|
240 | </TR> |
---|
241 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
242 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
243 | <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
---|
244 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/SimplePreAnalyzedParser.html#toFormattedString(org.apache.lucene.document.Field)">toFormattedString</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/document/Field.html?is-external=true" title="class or interface in org.apache.lucene.document">Field</A> f)</CODE> |
---|
245 | |
---|
246 | <BR> |
---|
247 | Format a field so that the resulting String is valid for parsing with <A HREF="../../../../org/apache/solr/schema/PreAnalyzedField.PreAnalyzedParser.html#parse(java.io.Reader, org.apache.lucene.util.AttributeSource)"><CODE>PreAnalyzedField.PreAnalyzedParser.parse(Reader, AttributeSource)</CODE></A>.</TD> |
---|
248 | </TR> |
---|
249 | </TABLE> |
---|
250 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
251 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
252 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
253 | <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> |
---|
254 | </TR> |
---|
255 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
256 | <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#toString()" title="class or interface in java.lang">toString</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> |
---|
257 | </TR> |
---|
258 | </TABLE> |
---|
259 | |
---|
260 | <P> |
---|
261 | |
---|
262 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
263 | |
---|
264 | <A NAME="constructor_detail"><!-- --></A> |
---|
265 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
266 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
267 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
268 | <B>Constructor Detail</B></FONT></TH> |
---|
269 | </TR> |
---|
270 | </TABLE> |
---|
271 | |
---|
272 | <A NAME="SimplePreAnalyzedParser()"><!-- --></A><H3> |
---|
273 | SimplePreAnalyzedParser</H3> |
---|
274 | <PRE> |
---|
275 | public <B>SimplePreAnalyzedParser</B>()</PRE> |
---|
276 | <DL> |
---|
277 | </DL> |
---|
278 | |
---|
279 | <!-- ============ METHOD DETAIL ========== --> |
---|
280 | |
---|
281 | <A NAME="method_detail"><!-- --></A> |
---|
282 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
283 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
284 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
285 | <B>Method Detail</B></FONT></TH> |
---|
286 | </TR> |
---|
287 | </TABLE> |
---|
288 | |
---|
289 | <A NAME="parse(java.io.Reader, org.apache.lucene.util.AttributeSource)"><!-- --></A><H3> |
---|
290 | parse</H3> |
---|
291 | <PRE> |
---|
292 | public <A HREF="../../../../org/apache/solr/schema/PreAnalyzedField.ParseResult.html" title="class in org.apache.solr.schema">PreAnalyzedField.ParseResult</A> <B>parse</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> reader, |
---|
293 | <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/AttributeSource.html?is-external=true" title="class or interface in org.apache.lucene.util">AttributeSource</A> parent) |
---|
294 | 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> |
---|
295 | <DL> |
---|
296 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/schema/PreAnalyzedField.PreAnalyzedParser.html#parse(java.io.Reader, org.apache.lucene.util.AttributeSource)">PreAnalyzedField.PreAnalyzedParser</A></CODE></B></DD> |
---|
297 | <DD>Parse input. |
---|
298 | <P> |
---|
299 | <DD><DL> |
---|
300 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/PreAnalyzedField.PreAnalyzedParser.html#parse(java.io.Reader, org.apache.lucene.util.AttributeSource)">parse</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/schema/PreAnalyzedField.PreAnalyzedParser.html" title="interface in org.apache.solr.schema">PreAnalyzedField.PreAnalyzedParser</A></CODE></DL> |
---|
301 | </DD> |
---|
302 | <DD><DL> |
---|
303 | <DT><B>Parameters:</B><DD><CODE>reader</CODE> - input to read from<DD><CODE>parent</CODE> - parent who will own the resulting states (tokens with attributes) |
---|
304 | <DT><B>Returns:</B><DD>parse result, with possibly null stored and/or states fields. |
---|
305 | <DT><B>Throws:</B> |
---|
306 | <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> - if a parsing error or IO error occurs</DL> |
---|
307 | </DD> |
---|
308 | </DL> |
---|
309 | <HR> |
---|
310 | |
---|
311 | <A NAME="toFormattedString(org.apache.lucene.document.Field)"><!-- --></A><H3> |
---|
312 | toFormattedString</H3> |
---|
313 | <PRE> |
---|
314 | public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toFormattedString</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/document/Field.html?is-external=true" title="class or interface in org.apache.lucene.document">Field</A> f) |
---|
315 | 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> |
---|
316 | <DL> |
---|
317 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/schema/PreAnalyzedField.PreAnalyzedParser.html#toFormattedString(org.apache.lucene.document.Field)">PreAnalyzedField.PreAnalyzedParser</A></CODE></B></DD> |
---|
318 | <DD>Format a field so that the resulting String is valid for parsing with <A HREF="../../../../org/apache/solr/schema/PreAnalyzedField.PreAnalyzedParser.html#parse(java.io.Reader, org.apache.lucene.util.AttributeSource)"><CODE>PreAnalyzedField.PreAnalyzedParser.parse(Reader, AttributeSource)</CODE></A>. |
---|
319 | <P> |
---|
320 | <DD><DL> |
---|
321 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/schema/PreAnalyzedField.PreAnalyzedParser.html#toFormattedString(org.apache.lucene.document.Field)">toFormattedString</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/schema/PreAnalyzedField.PreAnalyzedParser.html" title="interface in org.apache.solr.schema">PreAnalyzedField.PreAnalyzedParser</A></CODE></DL> |
---|
322 | </DD> |
---|
323 | <DD><DL> |
---|
324 | <DT><B>Parameters:</B><DD><CODE>f</CODE> - field instance |
---|
325 | <DT><B>Returns:</B><DD>formatted string |
---|
326 | <DT><B>Throws:</B> |
---|
327 | <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> |
---|
328 | </DD> |
---|
329 | </DL> |
---|
330 | <!-- ========= END OF CLASS DATA ========= --> |
---|
331 | <HR> |
---|
332 | |
---|
333 | |
---|
334 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
335 | <A NAME="navbar_bottom"><!-- --></A> |
---|
336 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
337 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
338 | <TR> |
---|
339 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
340 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
341 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
342 | <TR ALIGN="center" VALIGN="top"> |
---|
343 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
344 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
345 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
346 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SimplePreAnalyzedParser.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
347 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
348 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
349 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
350 | </TR> |
---|
351 | </TABLE> |
---|
352 | </TD> |
---|
353 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
354 | </EM> |
---|
355 | </TD> |
---|
356 | </TR> |
---|
357 | |
---|
358 | <TR> |
---|
359 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
360 | <A HREF="../../../../org/apache/solr/schema/SimilarityFactory.html" title="class in org.apache.solr.schema"><B>PREV CLASS</B></A> |
---|
361 | <A HREF="../../../../org/apache/solr/schema/SortableDoubleField.html" title="class in org.apache.solr.schema"><B>NEXT CLASS</B></A></FONT></TD> |
---|
362 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
363 | <A HREF="../../../../index.html?org/apache/solr/schema/SimplePreAnalyzedParser.html" target="_top"><B>FRAMES</B></A> |
---|
364 | <A HREF="SimplePreAnalyzedParser.html" target="_top"><B>NO FRAMES</B></A> |
---|
365 | <SCRIPT type="text/javascript"> |
---|
366 | <!-- |
---|
367 | if(window==top) { |
---|
368 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
369 | } |
---|
370 | //--> |
---|
371 | </SCRIPT> |
---|
372 | <NOSCRIPT> |
---|
373 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
374 | </NOSCRIPT> |
---|
375 | |
---|
376 | |
---|
377 | </FONT></TD> |
---|
378 | </TR> |
---|
379 | <TR> |
---|
380 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
381 | SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
382 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
383 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
384 | </TR> |
---|
385 | </TABLE> |
---|
386 | <A NAME="skip-navbar_bottom"></A> |
---|
387 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
388 | |
---|
389 | <HR> |
---|
390 | |
---|
391 | <address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address> |
---|
392 | <script src='../../../../prettify.js' type='text/javascript'></script> |
---|
393 | <script type='text/javascript'> |
---|
394 | (function(){ |
---|
395 | var oldonload = window.onload; |
---|
396 | if (typeof oldonload != 'function') { |
---|
397 | window.onload = prettyPrint; |
---|
398 | } else { |
---|
399 | window.onload = function() { |
---|
400 | oldonload(); |
---|
401 | prettyPrint(); |
---|
402 | } |
---|
403 | } |
---|
404 | })(); |
---|
405 | </script> |
---|
406 | |
---|
407 | </BODY> |
---|
408 | </HTML> |
---|