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 | IndexSchema (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="IndexSchema (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/IndexSchema.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/ICUCollationField.html" title="class in org.apache.solr.schema"><B>PREV CLASS</B></A> |
---|
59 | <A HREF="../../../../org/apache/solr/schema/IntField.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/IndexSchema.html" target="_top"><B>FRAMES</B></A> |
---|
62 | <A HREF="IndexSchema.html" target="_top"><B>NO FRAMES</B></A> |
---|
63 | <SCRIPT type="text/javascript"> |
---|
64 | <!-- |
---|
65 | if(window==top) { |
---|
66 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
67 | } |
---|
68 | //--> |
---|
69 | </SCRIPT> |
---|
70 | <NOSCRIPT> |
---|
71 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
72 | </NOSCRIPT> |
---|
73 | |
---|
74 | |
---|
75 | </FONT></TD> |
---|
76 | </TR> |
---|
77 | <TR> |
---|
78 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
79 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
80 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
81 | DETAIL: <A HREF="#field_detail">FIELD</A> | <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 IndexSchema</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.IndexSchema</B> |
---|
97 | </PRE> |
---|
98 | <HR> |
---|
99 | <DL> |
---|
100 | <DT><PRE>public final class <B>IndexSchema</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></DL> |
---|
101 | </PRE> |
---|
102 | |
---|
103 | <P> |
---|
104 | <code>IndexSchema</code> contains information about the valid fields in an index |
---|
105 | and the types of those fields. |
---|
106 | <P> |
---|
107 | |
---|
108 | <P> |
---|
109 | <HR> |
---|
110 | |
---|
111 | <P> |
---|
112 | <!-- =========== FIELD SUMMARY =========== --> |
---|
113 | |
---|
114 | <A NAME="field_summary"><!-- --></A> |
---|
115 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
116 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
117 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
118 | <B>Field Summary</B></FONT></TH> |
---|
119 | </TR> |
---|
120 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
121 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
122 | <CODE>static <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> |
---|
123 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#DEFAULT_SCHEMA_FILE">DEFAULT_SCHEMA_FILE</A></B></CODE> |
---|
124 | |
---|
125 | <BR> |
---|
126 | </TD> |
---|
127 | </TR> |
---|
128 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
129 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
130 | <CODE>static <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> |
---|
131 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#LUCENE_MATCH_VERSION_PARAM">LUCENE_MATCH_VERSION_PARAM</A></B></CODE> |
---|
132 | |
---|
133 | <BR> |
---|
134 | </TD> |
---|
135 | </TR> |
---|
136 | </TABLE> |
---|
137 | |
---|
138 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
---|
139 | |
---|
140 | <A NAME="constructor_summary"><!-- --></A> |
---|
141 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
142 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
143 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
144 | <B>Constructor Summary</B></FONT></TH> |
---|
145 | </TR> |
---|
146 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
147 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#IndexSchema(org.apache.solr.core.SolrConfig, java.lang.String, org.xml.sax.InputSource)">IndexSchema</A></B>(<A HREF="../../../../org/apache/solr/core/SolrConfig.html" title="class in org.apache.solr.core">SolrConfig</A> solrConfig, |
---|
148 | <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
---|
149 | <A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/InputSource.html?is-external=true" title="class or interface in org.xml.sax">InputSource</A> is)</CODE> |
---|
150 | |
---|
151 | <BR> |
---|
152 | Constructs a schema using the specified resource name and stream.</TD> |
---|
153 | </TR> |
---|
154 | </TABLE> |
---|
155 | |
---|
156 | <!-- ========== METHOD SUMMARY =========== --> |
---|
157 | |
---|
158 | <A NAME="method_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>Method Summary</B></FONT></TH> |
---|
163 | </TR> |
---|
164 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
165 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
166 | <CODE> <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A></CODE></FONT></TD> |
---|
167 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getAnalyzer()">getAnalyzer</A></B>()</CODE> |
---|
168 | |
---|
169 | <BR> |
---|
170 | Returns the Analyzer used when indexing documents for this index</TD> |
---|
171 | </TR> |
---|
172 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
173 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
174 | <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../org/apache/solr/schema/CopyField.html" title="class in org.apache.solr.schema">CopyField</A>></CODE></FONT></TD> |
---|
175 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getCopyFieldsList(java.lang.String)">getCopyFieldsList</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> sourceField)</CODE> |
---|
176 | |
---|
177 | <BR> |
---|
178 | Get all copy fields for a specified source field, both static |
---|
179 | and dynamic ones.</TD> |
---|
180 | </TR> |
---|
181 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
182 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
183 | <CODE> <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>[]</CODE></FONT></TD> |
---|
184 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getCopySources(java.lang.String)">getCopySources</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> destField)</CODE> |
---|
185 | |
---|
186 | <BR> |
---|
187 | Get all copy fields, both the static and the dynamic ones.</TD> |
---|
188 | </TR> |
---|
189 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
190 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
191 | <CODE> <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/Version.html?is-external=true" title="class or interface in org.apache.lucene.util">Version</A></CODE></FONT></TD> |
---|
192 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getDefaultLuceneMatchVersion()">getDefaultLuceneMatchVersion</A></B>()</CODE> |
---|
193 | |
---|
194 | <BR> |
---|
195 | The Default Lucene Match Version for this IndexSchema</TD> |
---|
196 | </TR> |
---|
197 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
198 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
199 | <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> |
---|
200 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getDefaultSearchFieldName()">getDefaultSearchFieldName</A></B>()</CODE> |
---|
201 | |
---|
202 | <BR> |
---|
203 | Name of the default search field specified in the schema file.</TD> |
---|
204 | </TR> |
---|
205 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
206 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
207 | <CODE> <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>[]</CODE></FONT></TD> |
---|
208 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getDynamicFieldPrototypes()">getDynamicFieldPrototypes</A></B>()</CODE> |
---|
209 | |
---|
210 | <BR> |
---|
211 | </TD> |
---|
212 | </TR> |
---|
213 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
214 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
215 | <CODE> <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></FONT></TD> |
---|
216 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getDynamicFieldType(java.lang.String)">getDynamicFieldType</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</CODE> |
---|
217 | |
---|
218 | <BR> |
---|
219 | Returns the FieldType of the best matching dynamic field for |
---|
220 | the specified field name</TD> |
---|
221 | </TR> |
---|
222 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
223 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
224 | <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> |
---|
225 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getDynamicPattern(java.lang.String)">getDynamicPattern</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</CODE> |
---|
226 | |
---|
227 | <BR> |
---|
228 | </TD> |
---|
229 | </TR> |
---|
230 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
231 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
232 | <CODE> <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A></CODE></FONT></TD> |
---|
233 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getField(java.lang.String)">getField</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</CODE> |
---|
234 | |
---|
235 | <BR> |
---|
236 | Returns the SchemaField that should be used for the specified field name</TD> |
---|
237 | </TR> |
---|
238 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
239 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
240 | <CODE> <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A></CODE></FONT></TD> |
---|
241 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFieldOrNull(java.lang.String)">getFieldOrNull</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</CODE> |
---|
242 | |
---|
243 | <BR> |
---|
244 | Returns the SchemaField that should be used for the specified field name, or |
---|
245 | null if none exists.</TD> |
---|
246 | </TR> |
---|
247 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
248 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
249 | <CODE> <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><<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="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>></CODE></FONT></TD> |
---|
250 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFields()">getFields</A></B>()</CODE> |
---|
251 | |
---|
252 | <BR> |
---|
253 | Provides direct access to the Map containing all explicit |
---|
254 | (ie: non-dynamic) fields in the index, keyed on field name.</TD> |
---|
255 | </TR> |
---|
256 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
257 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
258 | <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>></CODE></FONT></TD> |
---|
259 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFieldsWithDefaultValue()">getFieldsWithDefaultValue</A></B>()</CODE> |
---|
260 | |
---|
261 | <BR> |
---|
262 | Provides direct access to the List containing all fields with a default value</TD> |
---|
263 | </TR> |
---|
264 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
265 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
266 | <CODE> <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></FONT></TD> |
---|
267 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFieldType(java.lang.String)">getFieldType</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</CODE> |
---|
268 | |
---|
269 | <BR> |
---|
270 | Returns the FieldType for the specified field name.</TD> |
---|
271 | </TR> |
---|
272 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
273 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
274 | <CODE> <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></FONT></TD> |
---|
275 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFieldTypeByName(java.lang.String)">getFieldTypeByName</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldTypeName)</CODE> |
---|
276 | |
---|
277 | <BR> |
---|
278 | Given the name of a <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema"><CODE>FieldType</CODE></A> (not to be confused with <A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFieldType(java.lang.String)"><CODE>getFieldType(String)</CODE></A> which |
---|
279 | takes in the name of a field), return the <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema"><CODE>FieldType</CODE></A>.</TD> |
---|
280 | </TR> |
---|
281 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
282 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
283 | <CODE> <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A></CODE></FONT></TD> |
---|
284 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFieldTypeNoEx(java.lang.String)">getFieldTypeNoEx</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</CODE> |
---|
285 | |
---|
286 | <BR> |
---|
287 | Returns the FieldType for the specified field name.</TD> |
---|
288 | </TR> |
---|
289 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
290 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
291 | <CODE> <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><<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="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A>></CODE></FONT></TD> |
---|
292 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFieldTypes()">getFieldTypes</A></B>()</CODE> |
---|
293 | |
---|
294 | <BR> |
---|
295 | Provides direct access to the Map containing all Field Types |
---|
296 | in the index, keyed on field type name.</TD> |
---|
297 | </TR> |
---|
298 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
299 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
300 | <CODE> <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A></CODE></FONT></TD> |
---|
301 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getQueryAnalyzer()">getQueryAnalyzer</A></B>()</CODE> |
---|
302 | |
---|
303 | <BR> |
---|
304 | Returns the Analyzer used when searching this index</TD> |
---|
305 | </TR> |
---|
306 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
307 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
308 | <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> |
---|
309 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getQueryParserDefaultOperator()">getQueryParserDefaultOperator</A></B>()</CODE> |
---|
310 | |
---|
311 | <BR> |
---|
312 | default operator ("AND" or "OR") for QueryParser</TD> |
---|
313 | </TR> |
---|
314 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
315 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
316 | <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>></CODE></FONT></TD> |
---|
317 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getRequiredFields()">getRequiredFields</A></B>()</CODE> |
---|
318 | |
---|
319 | <BR> |
---|
320 | Provides direct access to the List containing all required fields.</TD> |
---|
321 | </TR> |
---|
322 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
323 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
324 | <CODE> <A HREF="../../../../org/apache/solr/core/SolrResourceLoader.html" title="class in org.apache.solr.core">SolrResourceLoader</A></CODE></FONT></TD> |
---|
325 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getResourceLoader()">getResourceLoader</A></B>()</CODE> |
---|
326 | |
---|
327 | <BR> |
---|
328 | </TD> |
---|
329 | </TR> |
---|
330 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
331 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
332 | <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> |
---|
333 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getResourceName()">getResourceName</A></B>()</CODE> |
---|
334 | |
---|
335 | <BR> |
---|
336 | Gets the name of the resource used to instantiate this schema.</TD> |
---|
337 | </TR> |
---|
338 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
339 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
340 | <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> |
---|
341 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getSchemaName()">getSchemaName</A></B>()</CODE> |
---|
342 | |
---|
343 | <BR> |
---|
344 | Gets the name of the schema as specified in the schema resource.</TD> |
---|
345 | </TR> |
---|
346 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
347 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
348 | <CODE> <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/similarities/Similarity.html?is-external=true" title="class or interface in org.apache.lucene.search.similarities">Similarity</A></CODE></FONT></TD> |
---|
349 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getSimilarity()">getSimilarity</A></B>()</CODE> |
---|
350 | |
---|
351 | <BR> |
---|
352 | Returns the Similarity used for this index</TD> |
---|
353 | </TR> |
---|
354 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
355 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
356 | <CODE> <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A></CODE></FONT></TD> |
---|
357 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getUniqueKeyField()">getUniqueKeyField</A></B>()</CODE> |
---|
358 | |
---|
359 | <BR> |
---|
360 | Unique Key field specified in the schema file</TD> |
---|
361 | </TR> |
---|
362 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
363 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
364 | <CODE> <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexableField.html?is-external=true" title="class or interface in org.apache.lucene.index">IndexableField</A></CODE></FONT></TD> |
---|
365 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getUniqueKeyField(org.apache.lucene.document.Document)">getUniqueKeyField</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/document/Document.html?is-external=true" title="class or interface in org.apache.lucene.document">Document</A> doc)</CODE> |
---|
366 | |
---|
367 | <BR> |
---|
368 | The raw (field type encoded) value of the Unique Key field for |
---|
369 | the specified Document</TD> |
---|
370 | </TR> |
---|
371 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
372 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
373 | <CODE> boolean</CODE></FONT></TD> |
---|
374 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#hasExplicitField(java.lang.String)">hasExplicitField</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</CODE> |
---|
375 | |
---|
376 | <BR> |
---|
377 | Does the schema have the specified field defined explicitly, i.e.</TD> |
---|
378 | </TR> |
---|
379 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
380 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
381 | <CODE> boolean</CODE></FONT></TD> |
---|
382 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#isCopyFieldTarget(org.apache.solr.schema.SchemaField)">isCopyFieldTarget</A></B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A> f)</CODE> |
---|
383 | |
---|
384 | <BR> |
---|
385 | Check if a field is used as the destination of a copyField operation</TD> |
---|
386 | </TR> |
---|
387 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
388 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
389 | <CODE> boolean</CODE></FONT></TD> |
---|
390 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#isDynamicField(java.lang.String)">isDynamicField</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</CODE> |
---|
391 | |
---|
392 | <BR> |
---|
393 | Is the specified field dynamic or not.</TD> |
---|
394 | </TR> |
---|
395 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
396 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
397 | <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> |
---|
398 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#printableUniqueKey(org.apache.lucene.document.Document)">printableUniqueKey</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/document/Document.html?is-external=true" title="class or interface in org.apache.lucene.document">Document</A> doc)</CODE> |
---|
399 | |
---|
400 | <BR> |
---|
401 | The printable value of the Unique Key field for |
---|
402 | the specified Document</TD> |
---|
403 | </TR> |
---|
404 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
405 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
406 | <CODE> void</CODE></FONT></TD> |
---|
407 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#refreshAnalyzers()">refreshAnalyzers</A></B>()</CODE> |
---|
408 | |
---|
409 | <BR> |
---|
410 | This will re-create the Analyzers.</TD> |
---|
411 | </TR> |
---|
412 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
413 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
414 | <CODE> void</CODE></FONT></TD> |
---|
415 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#registerCopyField(java.lang.String, java.lang.String)">registerCopyField</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> source, |
---|
416 | <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> dest)</CODE> |
---|
417 | |
---|
418 | <BR> |
---|
419 | </TD> |
---|
420 | </TR> |
---|
421 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
422 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
423 | <CODE> void</CODE></FONT></TD> |
---|
424 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#registerCopyField(java.lang.String, java.lang.String, int)">registerCopyField</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> source, |
---|
425 | <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> dest, |
---|
426 | int maxChars)</CODE> |
---|
427 | |
---|
428 | <BR> |
---|
429 | |
---|
430 | NOTE: this function is not thread safe.</TD> |
---|
431 | </TR> |
---|
432 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
433 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
434 | <CODE> void</CODE></FONT></TD> |
---|
435 | <TD><CODE><B><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#registerDynamicField(org.apache.solr.schema.SchemaField...)">registerDynamicField</A></B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>... f)</CODE> |
---|
436 | |
---|
437 | <BR> |
---|
438 | Register one or more new Dynamic Field with the Schema.</TD> |
---|
439 | </TR> |
---|
440 | </TABLE> |
---|
441 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
442 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
443 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
444 | <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> |
---|
445 | </TR> |
---|
446 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
447 | <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> |
---|
448 | </TR> |
---|
449 | </TABLE> |
---|
450 | |
---|
451 | <P> |
---|
452 | |
---|
453 | <!-- ============ FIELD DETAIL =========== --> |
---|
454 | |
---|
455 | <A NAME="field_detail"><!-- --></A> |
---|
456 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
457 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
458 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
459 | <B>Field Detail</B></FONT></TH> |
---|
460 | </TR> |
---|
461 | </TABLE> |
---|
462 | |
---|
463 | <A NAME="DEFAULT_SCHEMA_FILE"><!-- --></A><H3> |
---|
464 | DEFAULT_SCHEMA_FILE</H3> |
---|
465 | <PRE> |
---|
466 | public static final <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>DEFAULT_SCHEMA_FILE</B></PRE> |
---|
467 | <DL> |
---|
468 | <DL> |
---|
469 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.schema.IndexSchema.DEFAULT_SCHEMA_FILE">Constant Field Values</A></DL> |
---|
470 | </DL> |
---|
471 | <HR> |
---|
472 | |
---|
473 | <A NAME="LUCENE_MATCH_VERSION_PARAM"><!-- --></A><H3> |
---|
474 | LUCENE_MATCH_VERSION_PARAM</H3> |
---|
475 | <PRE> |
---|
476 | public static final <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>LUCENE_MATCH_VERSION_PARAM</B></PRE> |
---|
477 | <DL> |
---|
478 | <DL> |
---|
479 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.schema.IndexSchema.LUCENE_MATCH_VERSION_PARAM">Constant Field Values</A></DL> |
---|
480 | </DL> |
---|
481 | |
---|
482 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
483 | |
---|
484 | <A NAME="constructor_detail"><!-- --></A> |
---|
485 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
486 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
487 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
488 | <B>Constructor Detail</B></FONT></TH> |
---|
489 | </TR> |
---|
490 | </TABLE> |
---|
491 | |
---|
492 | <A NAME="IndexSchema(org.apache.solr.core.SolrConfig, java.lang.String, org.xml.sax.InputSource)"><!-- --></A><H3> |
---|
493 | IndexSchema</H3> |
---|
494 | <PRE> |
---|
495 | public <B>IndexSchema</B>(<A HREF="../../../../org/apache/solr/core/SolrConfig.html" title="class in org.apache.solr.core">SolrConfig</A> solrConfig, |
---|
496 | <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
---|
497 | <A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/InputSource.html?is-external=true" title="class or interface in org.xml.sax">InputSource</A> is)</PRE> |
---|
498 | <DL> |
---|
499 | <DD>Constructs a schema using the specified resource name and stream. |
---|
500 | If the is stream is null, the resource loader will load the schema resource by name. |
---|
501 | <P> |
---|
502 | <DL> |
---|
503 | <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/core/SolrResourceLoader.html#openSchema(java.lang.String)"><CODE>By default, this follows the normal config path directory searching rules.</CODE></A>, |
---|
504 | <A HREF="../../../../org/apache/solr/core/SolrResourceLoader.html#openResource(java.lang.String)"><CODE>SolrResourceLoader.openResource(java.lang.String)</CODE></A></DL> |
---|
505 | </DL> |
---|
506 | |
---|
507 | <!-- ============ METHOD DETAIL ========== --> |
---|
508 | |
---|
509 | <A NAME="method_detail"><!-- --></A> |
---|
510 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
511 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
512 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
513 | <B>Method Detail</B></FONT></TH> |
---|
514 | </TR> |
---|
515 | </TABLE> |
---|
516 | |
---|
517 | <A NAME="getResourceLoader()"><!-- --></A><H3> |
---|
518 | getResourceLoader</H3> |
---|
519 | <PRE> |
---|
520 | public <A HREF="../../../../org/apache/solr/core/SolrResourceLoader.html" title="class in org.apache.solr.core">SolrResourceLoader</A> <B>getResourceLoader</B>()</PRE> |
---|
521 | <DL> |
---|
522 | <DD><DL> |
---|
523 | <DT><B>Since:</B></DT> |
---|
524 | <DD>solr 1.4</DD> |
---|
525 | </DL> |
---|
526 | </DD> |
---|
527 | </DL> |
---|
528 | <HR> |
---|
529 | |
---|
530 | <A NAME="getResourceName()"><!-- --></A><H3> |
---|
531 | getResourceName</H3> |
---|
532 | <PRE> |
---|
533 | 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>getResourceName</B>()</PRE> |
---|
534 | <DL> |
---|
535 | <DD>Gets the name of the resource used to instantiate this schema. |
---|
536 | <P> |
---|
537 | <DD><DL> |
---|
538 | </DL> |
---|
539 | </DD> |
---|
540 | </DL> |
---|
541 | <HR> |
---|
542 | |
---|
543 | <A NAME="getSchemaName()"><!-- --></A><H3> |
---|
544 | getSchemaName</H3> |
---|
545 | <PRE> |
---|
546 | 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>getSchemaName</B>()</PRE> |
---|
547 | <DL> |
---|
548 | <DD>Gets the name of the schema as specified in the schema resource. |
---|
549 | <P> |
---|
550 | <DD><DL> |
---|
551 | </DL> |
---|
552 | </DD> |
---|
553 | </DL> |
---|
554 | <HR> |
---|
555 | |
---|
556 | <A NAME="getDefaultLuceneMatchVersion()"><!-- --></A><H3> |
---|
557 | getDefaultLuceneMatchVersion</H3> |
---|
558 | <PRE> |
---|
559 | public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/Version.html?is-external=true" title="class or interface in org.apache.lucene.util">Version</A> <B>getDefaultLuceneMatchVersion</B>()</PRE> |
---|
560 | <DL> |
---|
561 | <DD>The Default Lucene Match Version for this IndexSchema |
---|
562 | <P> |
---|
563 | <DD><DL> |
---|
564 | </DL> |
---|
565 | </DD> |
---|
566 | </DL> |
---|
567 | <HR> |
---|
568 | |
---|
569 | <A NAME="getFields()"><!-- --></A><H3> |
---|
570 | getFields</H3> |
---|
571 | <PRE> |
---|
572 | public <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><<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="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>> <B>getFields</B>()</PRE> |
---|
573 | <DL> |
---|
574 | <DD>Provides direct access to the Map containing all explicit |
---|
575 | (ie: non-dynamic) fields in the index, keyed on field name. |
---|
576 | |
---|
577 | <p> |
---|
578 | Modifying this Map (or any item in it) will affect the real schema |
---|
579 | </p> |
---|
580 | |
---|
581 | <p> |
---|
582 | NOTE: this function is not thread safe. However, it is safe to use within the standard |
---|
583 | <code>inform( SolrCore core )</code> function for <code>SolrCoreAware</code> classes. |
---|
584 | Outside <code>inform</code>, this could potentially throw a ConcurrentModificationException |
---|
585 | </p> |
---|
586 | <P> |
---|
587 | <DD><DL> |
---|
588 | </DL> |
---|
589 | </DD> |
---|
590 | </DL> |
---|
591 | <HR> |
---|
592 | |
---|
593 | <A NAME="getFieldTypes()"><!-- --></A><H3> |
---|
594 | getFieldTypes</H3> |
---|
595 | <PRE> |
---|
596 | public <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><<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="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A>> <B>getFieldTypes</B>()</PRE> |
---|
597 | <DL> |
---|
598 | <DD>Provides direct access to the Map containing all Field Types |
---|
599 | in the index, keyed on field type name. |
---|
600 | |
---|
601 | <p> |
---|
602 | Modifying this Map (or any item in it) will affect the real schema. However if you |
---|
603 | make any modifications, be sure to call <A HREF="../../../../org/apache/solr/schema/IndexSchema.html#refreshAnalyzers()"><CODE>refreshAnalyzers()</CODE></A> to |
---|
604 | update the Analyzers for the registered fields. |
---|
605 | </p> |
---|
606 | |
---|
607 | <p> |
---|
608 | NOTE: this function is not thread safe. However, it is safe to use within the standard |
---|
609 | <code>inform( SolrCore core )</code> function for <code>SolrCoreAware</code> classes. |
---|
610 | Outside <code>inform</code>, this could potentially throw a ConcurrentModificationException |
---|
611 | </p> |
---|
612 | <P> |
---|
613 | <DD><DL> |
---|
614 | </DL> |
---|
615 | </DD> |
---|
616 | </DL> |
---|
617 | <HR> |
---|
618 | |
---|
619 | <A NAME="getFieldsWithDefaultValue()"><!-- --></A><H3> |
---|
620 | getFieldsWithDefaultValue</H3> |
---|
621 | <PRE> |
---|
622 | public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>> <B>getFieldsWithDefaultValue</B>()</PRE> |
---|
623 | <DL> |
---|
624 | <DD>Provides direct access to the List containing all fields with a default value |
---|
625 | <P> |
---|
626 | <DD><DL> |
---|
627 | </DL> |
---|
628 | </DD> |
---|
629 | </DL> |
---|
630 | <HR> |
---|
631 | |
---|
632 | <A NAME="getRequiredFields()"><!-- --></A><H3> |
---|
633 | getRequiredFields</H3> |
---|
634 | <PRE> |
---|
635 | public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>> <B>getRequiredFields</B>()</PRE> |
---|
636 | <DL> |
---|
637 | <DD>Provides direct access to the List containing all required fields. This |
---|
638 | list contains all fields with default values. |
---|
639 | <P> |
---|
640 | <DD><DL> |
---|
641 | </DL> |
---|
642 | </DD> |
---|
643 | </DL> |
---|
644 | <HR> |
---|
645 | |
---|
646 | <A NAME="getSimilarity()"><!-- --></A><H3> |
---|
647 | getSimilarity</H3> |
---|
648 | <PRE> |
---|
649 | public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/similarities/Similarity.html?is-external=true" title="class or interface in org.apache.lucene.search.similarities">Similarity</A> <B>getSimilarity</B>()</PRE> |
---|
650 | <DL> |
---|
651 | <DD>Returns the Similarity used for this index |
---|
652 | <P> |
---|
653 | <DD><DL> |
---|
654 | </DL> |
---|
655 | </DD> |
---|
656 | </DL> |
---|
657 | <HR> |
---|
658 | |
---|
659 | <A NAME="getAnalyzer()"><!-- --></A><H3> |
---|
660 | getAnalyzer</H3> |
---|
661 | <PRE> |
---|
662 | public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A> <B>getAnalyzer</B>()</PRE> |
---|
663 | <DL> |
---|
664 | <DD>Returns the Analyzer used when indexing documents for this index |
---|
665 | |
---|
666 | <p> |
---|
667 | This Analyzer is field (and dynamic field) name aware, and delegates to |
---|
668 | a field specific Analyzer based on the field type. |
---|
669 | </p> |
---|
670 | <P> |
---|
671 | <DD><DL> |
---|
672 | </DL> |
---|
673 | </DD> |
---|
674 | </DL> |
---|
675 | <HR> |
---|
676 | |
---|
677 | <A NAME="getQueryAnalyzer()"><!-- --></A><H3> |
---|
678 | getQueryAnalyzer</H3> |
---|
679 | <PRE> |
---|
680 | public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A> <B>getQueryAnalyzer</B>()</PRE> |
---|
681 | <DL> |
---|
682 | <DD>Returns the Analyzer used when searching this index |
---|
683 | |
---|
684 | <p> |
---|
685 | This Analyzer is field (and dynamic field) name aware, and delegates to |
---|
686 | a field specific Analyzer based on the field type. |
---|
687 | </p> |
---|
688 | <P> |
---|
689 | <DD><DL> |
---|
690 | </DL> |
---|
691 | </DD> |
---|
692 | </DL> |
---|
693 | <HR> |
---|
694 | |
---|
695 | <A NAME="getDefaultSearchFieldName()"><!-- --></A><H3> |
---|
696 | getDefaultSearchFieldName</H3> |
---|
697 | <PRE> |
---|
698 | 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>getDefaultSearchFieldName</B>()</PRE> |
---|
699 | <DL> |
---|
700 | <DD>Name of the default search field specified in the schema file. |
---|
701 | <br/><b>Note:</b>Avoid calling this, try to use this method so that the 'df' param is consulted as an override: |
---|
702 | <A HREF="../../../../org/apache/solr/search/QueryParsing.html#getDefaultField(org.apache.solr.schema.IndexSchema, java.lang.String)"><CODE>QueryParsing.getDefaultField(IndexSchema, String)</CODE></A> |
---|
703 | <P> |
---|
704 | <DD><DL> |
---|
705 | </DL> |
---|
706 | </DD> |
---|
707 | </DL> |
---|
708 | <HR> |
---|
709 | |
---|
710 | <A NAME="getQueryParserDefaultOperator()"><!-- --></A><H3> |
---|
711 | getQueryParserDefaultOperator</H3> |
---|
712 | <PRE> |
---|
713 | 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>getQueryParserDefaultOperator</B>()</PRE> |
---|
714 | <DL> |
---|
715 | <DD>default operator ("AND" or "OR") for QueryParser |
---|
716 | <P> |
---|
717 | <DD><DL> |
---|
718 | </DL> |
---|
719 | </DD> |
---|
720 | </DL> |
---|
721 | <HR> |
---|
722 | |
---|
723 | <A NAME="getUniqueKeyField()"><!-- --></A><H3> |
---|
724 | getUniqueKeyField</H3> |
---|
725 | <PRE> |
---|
726 | public <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A> <B>getUniqueKeyField</B>()</PRE> |
---|
727 | <DL> |
---|
728 | <DD>Unique Key field specified in the schema file |
---|
729 | <P> |
---|
730 | <DD><DL> |
---|
731 | |
---|
732 | <DT><B>Returns:</B><DD>null if this schema has no unique key field</DL> |
---|
733 | </DD> |
---|
734 | </DL> |
---|
735 | <HR> |
---|
736 | |
---|
737 | <A NAME="getUniqueKeyField(org.apache.lucene.document.Document)"><!-- --></A><H3> |
---|
738 | getUniqueKeyField</H3> |
---|
739 | <PRE> |
---|
740 | public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexableField.html?is-external=true" title="class or interface in org.apache.lucene.index">IndexableField</A> <B>getUniqueKeyField</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/document/Document.html?is-external=true" title="class or interface in org.apache.lucene.document">Document</A> doc)</PRE> |
---|
741 | <DL> |
---|
742 | <DD>The raw (field type encoded) value of the Unique Key field for |
---|
743 | the specified Document |
---|
744 | <P> |
---|
745 | <DD><DL> |
---|
746 | |
---|
747 | <DT><B>Returns:</B><DD>null if this schema has no unique key field<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#printableUniqueKey(org.apache.lucene.document.Document)"><CODE>printableUniqueKey(org.apache.lucene.document.Document)</CODE></A></DL> |
---|
748 | </DD> |
---|
749 | </DL> |
---|
750 | <HR> |
---|
751 | |
---|
752 | <A NAME="printableUniqueKey(org.apache.lucene.document.Document)"><!-- --></A><H3> |
---|
753 | printableUniqueKey</H3> |
---|
754 | <PRE> |
---|
755 | public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>printableUniqueKey</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/document/Document.html?is-external=true" title="class or interface in org.apache.lucene.document">Document</A> doc)</PRE> |
---|
756 | <DL> |
---|
757 | <DD>The printable value of the Unique Key field for |
---|
758 | the specified Document |
---|
759 | <P> |
---|
760 | <DD><DL> |
---|
761 | |
---|
762 | <DT><B>Returns:</B><DD>null if this schema has no unique key field</DL> |
---|
763 | </DD> |
---|
764 | </DL> |
---|
765 | <HR> |
---|
766 | |
---|
767 | <A NAME="refreshAnalyzers()"><!-- --></A><H3> |
---|
768 | refreshAnalyzers</H3> |
---|
769 | <PRE> |
---|
770 | public void <B>refreshAnalyzers</B>()</PRE> |
---|
771 | <DL> |
---|
772 | <DD>This will re-create the Analyzers. If you make any modifications to |
---|
773 | the Field map (<A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFields()"><CODE>getFields()</CODE></A>, this function is required |
---|
774 | to synch the internally cached field analyzers. |
---|
775 | <P> |
---|
776 | <DD><DL> |
---|
777 | <DT><B>Since:</B></DT> |
---|
778 | <DD>solr 1.3</DD> |
---|
779 | </DL> |
---|
780 | </DD> |
---|
781 | </DL> |
---|
782 | <HR> |
---|
783 | |
---|
784 | <A NAME="registerDynamicField(org.apache.solr.schema.SchemaField...)"><!-- --></A><H3> |
---|
785 | registerDynamicField</H3> |
---|
786 | <PRE> |
---|
787 | public void <B>registerDynamicField</B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>... f)</PRE> |
---|
788 | <DL> |
---|
789 | <DD>Register one or more new Dynamic Field with the Schema. |
---|
790 | <P> |
---|
791 | <DD><DL> |
---|
792 | <DT><B>Parameters:</B><DD><CODE>f</CODE> - The <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema"><CODE>SchemaField</CODE></A></DL> |
---|
793 | </DD> |
---|
794 | </DL> |
---|
795 | <HR> |
---|
796 | |
---|
797 | <A NAME="registerCopyField(java.lang.String, java.lang.String)"><!-- --></A><H3> |
---|
798 | registerCopyField</H3> |
---|
799 | <PRE> |
---|
800 | public void <B>registerCopyField</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> source, |
---|
801 | <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> dest)</PRE> |
---|
802 | <DL> |
---|
803 | <DD><DL> |
---|
804 | </DL> |
---|
805 | </DD> |
---|
806 | </DL> |
---|
807 | <HR> |
---|
808 | |
---|
809 | <A NAME="registerCopyField(java.lang.String, java.lang.String, int)"><!-- --></A><H3> |
---|
810 | registerCopyField</H3> |
---|
811 | <PRE> |
---|
812 | public void <B>registerCopyField</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> source, |
---|
813 | <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> dest, |
---|
814 | int maxChars)</PRE> |
---|
815 | <DL> |
---|
816 | <DD><p> |
---|
817 | NOTE: this function is not thread safe. However, it is safe to use within the standard |
---|
818 | <code>inform( SolrCore core )</code> function for <code>SolrCoreAware</code> classes. |
---|
819 | Outside <code>inform</code>, this could potentially throw a ConcurrentModificationException |
---|
820 | </p> |
---|
821 | <P> |
---|
822 | <DD><DL> |
---|
823 | <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/util/plugin/SolrCoreAware.html" title="interface in org.apache.solr.util.plugin"><CODE>SolrCoreAware</CODE></A></DL> |
---|
824 | </DD> |
---|
825 | </DL> |
---|
826 | <HR> |
---|
827 | |
---|
828 | <A NAME="getDynamicFieldPrototypes()"><!-- --></A><H3> |
---|
829 | getDynamicFieldPrototypes</H3> |
---|
830 | <PRE> |
---|
831 | public <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>[] <B>getDynamicFieldPrototypes</B>()</PRE> |
---|
832 | <DL> |
---|
833 | <DD><DL> |
---|
834 | </DL> |
---|
835 | </DD> |
---|
836 | </DL> |
---|
837 | <HR> |
---|
838 | |
---|
839 | <A NAME="getDynamicPattern(java.lang.String)"><!-- --></A><H3> |
---|
840 | getDynamicPattern</H3> |
---|
841 | <PRE> |
---|
842 | 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>getDynamicPattern</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</PRE> |
---|
843 | <DL> |
---|
844 | <DD><DL> |
---|
845 | </DL> |
---|
846 | </DD> |
---|
847 | </DL> |
---|
848 | <HR> |
---|
849 | |
---|
850 | <A NAME="hasExplicitField(java.lang.String)"><!-- --></A><H3> |
---|
851 | hasExplicitField</H3> |
---|
852 | <PRE> |
---|
853 | public boolean <B>hasExplicitField</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</PRE> |
---|
854 | <DL> |
---|
855 | <DD>Does the schema have the specified field defined explicitly, i.e. |
---|
856 | not as a result of a copyField declaration with a wildcard? We |
---|
857 | consider it explicitly defined if it matches a field or dynamicField |
---|
858 | declaration. |
---|
859 | <P> |
---|
860 | <DD><DL> |
---|
861 | <DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - |
---|
862 | <DT><B>Returns:</B><DD>true if explicitly declared in the schema.</DL> |
---|
863 | </DD> |
---|
864 | </DL> |
---|
865 | <HR> |
---|
866 | |
---|
867 | <A NAME="isDynamicField(java.lang.String)"><!-- --></A><H3> |
---|
868 | isDynamicField</H3> |
---|
869 | <PRE> |
---|
870 | public boolean <B>isDynamicField</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</PRE> |
---|
871 | <DL> |
---|
872 | <DD>Is the specified field dynamic or not. |
---|
873 | <P> |
---|
874 | <DD><DL> |
---|
875 | <DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - |
---|
876 | <DT><B>Returns:</B><DD>true if the specified field is dynamic</DL> |
---|
877 | </DD> |
---|
878 | </DL> |
---|
879 | <HR> |
---|
880 | |
---|
881 | <A NAME="getFieldOrNull(java.lang.String)"><!-- --></A><H3> |
---|
882 | getFieldOrNull</H3> |
---|
883 | <PRE> |
---|
884 | public <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A> <B>getFieldOrNull</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</PRE> |
---|
885 | <DL> |
---|
886 | <DD>Returns the SchemaField that should be used for the specified field name, or |
---|
887 | null if none exists. |
---|
888 | <P> |
---|
889 | <DD><DL> |
---|
890 | <DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - may be an explicitly defined field or a name that |
---|
891 | matches a dynamic field. |
---|
892 | <DT><B>Returns:</B><DD>The <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema"><CODE>SchemaField</CODE></A><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFieldType(java.lang.String)"><CODE>getFieldType(java.lang.String)</CODE></A>, |
---|
893 | <A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getField(java.lang.String)"><CODE>getField(String)</CODE></A></DL> |
---|
894 | </DD> |
---|
895 | </DL> |
---|
896 | <HR> |
---|
897 | |
---|
898 | <A NAME="getField(java.lang.String)"><!-- --></A><H3> |
---|
899 | getField</H3> |
---|
900 | <PRE> |
---|
901 | public <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A> <B>getField</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</PRE> |
---|
902 | <DL> |
---|
903 | <DD>Returns the SchemaField that should be used for the specified field name |
---|
904 | <P> |
---|
905 | <DD><DL> |
---|
906 | <DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - may be an explicitly defined field or a name that |
---|
907 | matches a dynamic field. |
---|
908 | <DT><B>Returns:</B><DD>The <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema"><CODE>SchemaField</CODE></A> |
---|
909 | <DT><B>Throws:</B> |
---|
910 | <DD><CODE><A HREF="../../../../org/apache/solr/common/SolrException.html" title="class in org.apache.solr.common">SolrException</A></CODE> - if no such field exists<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFieldType(java.lang.String)"><CODE>getFieldType(java.lang.String)</CODE></A>, |
---|
911 | <A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFieldOrNull(java.lang.String)"><CODE>getFieldOrNull(String)</CODE></A></DL> |
---|
912 | </DD> |
---|
913 | </DL> |
---|
914 | <HR> |
---|
915 | |
---|
916 | <A NAME="getFieldType(java.lang.String)"><!-- --></A><H3> |
---|
917 | getFieldType</H3> |
---|
918 | <PRE> |
---|
919 | public <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A> <B>getFieldType</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</PRE> |
---|
920 | <DL> |
---|
921 | <DD>Returns the FieldType for the specified field name. |
---|
922 | |
---|
923 | <p> |
---|
924 | This method exists because it can be more efficient then |
---|
925 | <A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getField(java.lang.String)"><CODE>getField(java.lang.String)</CODE></A> for dynamic fields if a full SchemaField isn't needed. |
---|
926 | </p> |
---|
927 | <P> |
---|
928 | <DD><DL> |
---|
929 | <DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - may be an explicitly created field, or a name that |
---|
930 | excercies a dynamic field. |
---|
931 | <DT><B>Throws:</B> |
---|
932 | <DD><CODE><A HREF="../../../../org/apache/solr/common/SolrException.html" title="class in org.apache.solr.common">SolrException</A></CODE> - if no such field exists<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getField(java.lang.String)"><CODE>getField(String)</CODE></A>, |
---|
933 | <A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFieldTypeNoEx(java.lang.String)"><CODE>getFieldTypeNoEx(java.lang.String)</CODE></A></DL> |
---|
934 | </DD> |
---|
935 | </DL> |
---|
936 | <HR> |
---|
937 | |
---|
938 | <A NAME="getFieldTypeByName(java.lang.String)"><!-- --></A><H3> |
---|
939 | getFieldTypeByName</H3> |
---|
940 | <PRE> |
---|
941 | public <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A> <B>getFieldTypeByName</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldTypeName)</PRE> |
---|
942 | <DL> |
---|
943 | <DD>Given the name of a <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema"><CODE>FieldType</CODE></A> (not to be confused with <A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFieldType(java.lang.String)"><CODE>getFieldType(String)</CODE></A> which |
---|
944 | takes in the name of a field), return the <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema"><CODE>FieldType</CODE></A>. |
---|
945 | <P> |
---|
946 | <DD><DL> |
---|
947 | <DT><B>Parameters:</B><DD><CODE>fieldTypeName</CODE> - The name of the <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema"><CODE>FieldType</CODE></A> |
---|
948 | <DT><B>Returns:</B><DD>The <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema"><CODE>FieldType</CODE></A> or null.</DL> |
---|
949 | </DD> |
---|
950 | </DL> |
---|
951 | <HR> |
---|
952 | |
---|
953 | <A NAME="getFieldTypeNoEx(java.lang.String)"><!-- --></A><H3> |
---|
954 | getFieldTypeNoEx</H3> |
---|
955 | <PRE> |
---|
956 | public <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A> <B>getFieldTypeNoEx</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</PRE> |
---|
957 | <DL> |
---|
958 | <DD>Returns the FieldType for the specified field name. |
---|
959 | |
---|
960 | <p> |
---|
961 | This method exists because it can be more efficient then |
---|
962 | <A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getField(java.lang.String)"><CODE>getField(java.lang.String)</CODE></A> for dynamic fields if a full SchemaField isn't needed. |
---|
963 | </p> |
---|
964 | <P> |
---|
965 | <DD><DL> |
---|
966 | <DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - may be an explicitly created field, or a name that |
---|
967 | excercies a dynamic field. |
---|
968 | <DT><B>Returns:</B><DD>null if field is not defined.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getField(java.lang.String)"><CODE>getField(String)</CODE></A>, |
---|
969 | <A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFieldTypeNoEx(java.lang.String)"><CODE>getFieldTypeNoEx(java.lang.String)</CODE></A></DL> |
---|
970 | </DD> |
---|
971 | </DL> |
---|
972 | <HR> |
---|
973 | |
---|
974 | <A NAME="getDynamicFieldType(java.lang.String)"><!-- --></A><H3> |
---|
975 | getDynamicFieldType</H3> |
---|
976 | <PRE> |
---|
977 | public <A HREF="../../../../org/apache/solr/schema/FieldType.html" title="class in org.apache.solr.schema">FieldType</A> <B>getDynamicFieldType</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fieldName)</PRE> |
---|
978 | <DL> |
---|
979 | <DD>Returns the FieldType of the best matching dynamic field for |
---|
980 | the specified field name |
---|
981 | <P> |
---|
982 | <DD><DL> |
---|
983 | <DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - may be an explicitly created field, or a name that |
---|
984 | excercies a dynamic field. |
---|
985 | <DT><B>Throws:</B> |
---|
986 | <DD><CODE><A HREF="../../../../org/apache/solr/common/SolrException.html" title="class in org.apache.solr.common">SolrException</A></CODE> - if no such field exists<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getField(java.lang.String)"><CODE>getField(String)</CODE></A>, |
---|
987 | <A HREF="../../../../org/apache/solr/schema/IndexSchema.html#getFieldTypeNoEx(java.lang.String)"><CODE>getFieldTypeNoEx(java.lang.String)</CODE></A></DL> |
---|
988 | </DD> |
---|
989 | </DL> |
---|
990 | <HR> |
---|
991 | |
---|
992 | <A NAME="getCopySources(java.lang.String)"><!-- --></A><H3> |
---|
993 | getCopySources</H3> |
---|
994 | <PRE> |
---|
995 | public <A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A>[] <B>getCopySources</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> destField)</PRE> |
---|
996 | <DL> |
---|
997 | <DD>Get all copy fields, both the static and the dynamic ones. |
---|
998 | <P> |
---|
999 | <DD><DL> |
---|
1000 | <DT><B>Parameters:</B><DD><CODE>destField</CODE> - |
---|
1001 | <DT><B>Returns:</B><DD>Array of fields copied into this field</DL> |
---|
1002 | </DD> |
---|
1003 | </DL> |
---|
1004 | <HR> |
---|
1005 | |
---|
1006 | <A NAME="getCopyFieldsList(java.lang.String)"><!-- --></A><H3> |
---|
1007 | getCopyFieldsList</H3> |
---|
1008 | <PRE> |
---|
1009 | public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../org/apache/solr/schema/CopyField.html" title="class in org.apache.solr.schema">CopyField</A>> <B>getCopyFieldsList</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> sourceField)</PRE> |
---|
1010 | <DL> |
---|
1011 | <DD>Get all copy fields for a specified source field, both static |
---|
1012 | and dynamic ones. |
---|
1013 | <P> |
---|
1014 | <DD><DL> |
---|
1015 | <DT><B>Parameters:</B><DD><CODE>sourceField</CODE> - |
---|
1016 | <DT><B>Returns:</B><DD>List of CopyFields to copy to.<DT><B>Since:</B></DT> |
---|
1017 | <DD>solr 1.4</DD> |
---|
1018 | </DL> |
---|
1019 | </DD> |
---|
1020 | </DL> |
---|
1021 | <HR> |
---|
1022 | |
---|
1023 | <A NAME="isCopyFieldTarget(org.apache.solr.schema.SchemaField)"><!-- --></A><H3> |
---|
1024 | isCopyFieldTarget</H3> |
---|
1025 | <PRE> |
---|
1026 | public boolean <B>isCopyFieldTarget</B>(<A HREF="../../../../org/apache/solr/schema/SchemaField.html" title="class in org.apache.solr.schema">SchemaField</A> f)</PRE> |
---|
1027 | <DL> |
---|
1028 | <DD>Check if a field is used as the destination of a copyField operation |
---|
1029 | <P> |
---|
1030 | <DD><DL> |
---|
1031 | <DT><B>Since:</B></DT> |
---|
1032 | <DD>solr 1.3</DD> |
---|
1033 | </DL> |
---|
1034 | </DD> |
---|
1035 | </DL> |
---|
1036 | <!-- ========= END OF CLASS DATA ========= --> |
---|
1037 | <HR> |
---|
1038 | |
---|
1039 | |
---|
1040 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
1041 | <A NAME="navbar_bottom"><!-- --></A> |
---|
1042 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
1043 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
1044 | <TR> |
---|
1045 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
1046 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
1047 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
1048 | <TR ALIGN="center" VALIGN="top"> |
---|
1049 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
1050 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
1051 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
1052 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IndexSchema.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
1053 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
1054 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
1055 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
1056 | </TR> |
---|
1057 | </TABLE> |
---|
1058 | </TD> |
---|
1059 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
1060 | </EM> |
---|
1061 | </TD> |
---|
1062 | </TR> |
---|
1063 | |
---|
1064 | <TR> |
---|
1065 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
1066 | <A HREF="../../../../org/apache/solr/schema/ICUCollationField.html" title="class in org.apache.solr.schema"><B>PREV CLASS</B></A> |
---|
1067 | <A HREF="../../../../org/apache/solr/schema/IntField.html" title="class in org.apache.solr.schema"><B>NEXT CLASS</B></A></FONT></TD> |
---|
1068 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
1069 | <A HREF="../../../../index.html?org/apache/solr/schema/IndexSchema.html" target="_top"><B>FRAMES</B></A> |
---|
1070 | <A HREF="IndexSchema.html" target="_top"><B>NO FRAMES</B></A> |
---|
1071 | <SCRIPT type="text/javascript"> |
---|
1072 | <!-- |
---|
1073 | if(window==top) { |
---|
1074 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
1075 | } |
---|
1076 | //--> |
---|
1077 | </SCRIPT> |
---|
1078 | <NOSCRIPT> |
---|
1079 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
1080 | </NOSCRIPT> |
---|
1081 | |
---|
1082 | |
---|
1083 | </FONT></TD> |
---|
1084 | </TR> |
---|
1085 | <TR> |
---|
1086 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
1087 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
1088 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
1089 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
1090 | </TR> |
---|
1091 | </TABLE> |
---|
1092 | <A NAME="skip-navbar_bottom"></A> |
---|
1093 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
1094 | |
---|
1095 | <HR> |
---|
1096 | |
---|
1097 | <address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address> |
---|
1098 | <script src='../../../../prettify.js' type='text/javascript'></script> |
---|
1099 | <script type='text/javascript'> |
---|
1100 | (function(){ |
---|
1101 | var oldonload = window.onload; |
---|
1102 | if (typeof oldonload != 'function') { |
---|
1103 | window.onload = prettyPrint; |
---|
1104 | } else { |
---|
1105 | window.onload = function() { |
---|
1106 | oldonload(); |
---|
1107 | prettyPrint(); |
---|
1108 | } |
---|
1109 | } |
---|
1110 | })(); |
---|
1111 | </script> |
---|
1112 | |
---|
1113 | </BODY> |
---|
1114 | </HTML> |
---|