source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/uima/processor/UIMAToSolrMapper.html @ 7588

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

Ticket #000 - Adicionando a integracao de buscas com Solr na base a ser isnerida na comunidade
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_24) on Mon Jun 25 15:26:26 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8UIMAToSolrMapper (Solr 4.0.0-ALPHA API)
9</TITLE>
10
11<META NAME="date" CONTENT="2012-06-25">
12
13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
14
15<SCRIPT type="text/javascript">
16function windowTitle()
17{
18    if (location.href.indexOf('is-external=true') == -1) {
19        parent.document.title="UIMAToSolrMapper (Solr 4.0.0-ALPHA API)";
20    }
21}
22</SCRIPT>
23<NOSCRIPT>
24</NOSCRIPT>
25
26</HEAD>
27
28<BODY BGCOLOR="white" onload="windowTitle();">
29<HR>
30
31
32<!-- ========= START OF TOP NAVBAR ======= -->
33<A NAME="navbar_top"><!-- --></A>
34<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36<TR>
37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38<A NAME="navbar_top_firstrow"><!-- --></A>
39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40  <TR ALIGN="center" VALIGN="top">
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
43  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/UIMAToSolrMapper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52</EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;<A HREF="../../../../../org/apache/solr/uima/processor/SolrUIMAConfigurationReader.html" title="class in org.apache.solr.uima.processor"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/uima/processor/UIMAUpdateRequestProcessor.html" title="class in org.apache.solr.uima.processor"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/solr/uima/processor/UIMAToSolrMapper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="UIMAToSolrMapper.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77<TR>
78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82</TR>
83</TABLE>
84<A NAME="skip-navbar_top"></A>
85<!-- ========= END OF TOP NAVBAR ========= -->
86
87<HR>
88<!-- ======== START OF CLASS DATA ======== -->
89<H2>
90<FONT SIZE="-1">
91org.apache.solr.uima.processor</FONT>
92<BR>
93Class UIMAToSolrMapper</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.uima.processor.UIMAToSolrMapper</B>
97</PRE>
98<HR>
99<DL>
100<DT><PRE>public class <B>UIMAToSolrMapper</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>
104Map UIMA types and features over fields of a Solr document
105<P>
106
107<P>
108<HR>
109
110<P>
111
112<!-- ======== CONSTRUCTOR SUMMARY ======== -->
113
114<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
119</TR>
120<TR BGCOLOR="white" CLASS="TableRowColor">
121<TD><CODE><B><A HREF="../../../../../org/apache/solr/uima/processor/UIMAToSolrMapper.html#UIMAToSolrMapper(org.apache.solr.common.SolrInputDocument, org.apache.uima.jcas.JCas)">UIMAToSolrMapper</A></B>(<A HREF="../../../../../org/apache/solr/common/SolrInputDocument.html" title="class in org.apache.solr.common">SolrInputDocument</A>&nbsp;document,
122                 org.apache.uima.jcas.JCas&nbsp;cas)</CODE>
123
124<BR>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
126</TR>
127</TABLE>
128&nbsp;
129<!-- ========== METHOD SUMMARY =========== -->
130
131<A NAME="method_summary"><!-- --></A>
132<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
133<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
134<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
135<B>Method Summary</B></FONT></TH>
136</TR>
137<TR BGCOLOR="white" CLASS="TableRowColor">
138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139<CODE>&nbsp;void</CODE></FONT></TD>
140<TD><CODE><B><A HREF="../../../../../org/apache/solr/uima/processor/UIMAToSolrMapper.html#map(java.lang.String, java.util.Map)">map</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>&nbsp;typeName,
141    <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,org.apache.solr.uima.processor.SolrUIMAConfiguration.MapField&gt;&nbsp;featureFieldsmapping)</CODE>
142
143<BR>
144&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;map features of a certain UIMA type to corresponding Solr fields based on the mapping</TD>
145</TR>
146</TABLE>
147&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
148<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
149<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
150<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>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<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>
154</TR>
155</TABLE>
156&nbsp;
157<P>
158
159<!-- ========= CONSTRUCTOR DETAIL ======== -->
160
161<A NAME="constructor_detail"><!-- --></A>
162<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
163<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
164<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
165<B>Constructor Detail</B></FONT></TH>
166</TR>
167</TABLE>
168
169<A NAME="UIMAToSolrMapper(org.apache.solr.common.SolrInputDocument, org.apache.uima.jcas.JCas)"><!-- --></A><H3>
170UIMAToSolrMapper</H3>
171<PRE>
172public <B>UIMAToSolrMapper</B>(<A HREF="../../../../../org/apache/solr/common/SolrInputDocument.html" title="class in org.apache.solr.common">SolrInputDocument</A>&nbsp;document,
173                        org.apache.uima.jcas.JCas&nbsp;cas)</PRE>
174<DL>
175</DL>
176
177<!-- ============ METHOD DETAIL ========== -->
178
179<A NAME="method_detail"><!-- --></A>
180<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
181<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
182<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
183<B>Method Detail</B></FONT></TH>
184</TR>
185</TABLE>
186
187<A NAME="map(java.lang.String, java.util.Map)"><!-- --></A><H3>
188map</H3>
189<PRE>
190public void <B>map</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>&nbsp;typeName,
191                <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,org.apache.solr.uima.processor.SolrUIMAConfiguration.MapField&gt;&nbsp;featureFieldsmapping)
192         throws <A HREF="../../../../../org/apache/solr/uima/processor/exception/FieldMappingException.html" title="class in org.apache.solr.uima.processor.exception">FieldMappingException</A></PRE>
193<DL>
194<DD>map features of a certain UIMA type to corresponding Solr fields based on the mapping
195<P>
196<DD><DL>
197<DT><B>Parameters:</B><DD><CODE>typeName</CODE> - name of UIMA type to map<DD><CODE>featureFieldsmapping</CODE> -
198<DT><B>Throws:</B>
199<DD><CODE><A HREF="../../../../../org/apache/solr/uima/processor/exception/FieldMappingException.html" title="class in org.apache.solr.uima.processor.exception">FieldMappingException</A></CODE></DL>
200</DD>
201</DL>
202<!-- ========= END OF CLASS DATA ========= -->
203<HR>
204
205
206<!-- ======= START OF BOTTOM NAVBAR ====== -->
207<A NAME="navbar_bottom"><!-- --></A>
208<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
209<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
210<TR>
211<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
212<A NAME="navbar_bottom_firstrow"><!-- --></A>
213<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
214  <TR ALIGN="center" VALIGN="top">
215  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
216  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
217  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
218  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/UIMAToSolrMapper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
219  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
220  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
221  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
222  </TR>
223</TABLE>
224</TD>
225<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
226</EM>
227</TD>
228</TR>
229
230<TR>
231<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
232&nbsp;<A HREF="../../../../../org/apache/solr/uima/processor/SolrUIMAConfigurationReader.html" title="class in org.apache.solr.uima.processor"><B>PREV CLASS</B></A>&nbsp;
233&nbsp;<A HREF="../../../../../org/apache/solr/uima/processor/UIMAUpdateRequestProcessor.html" title="class in org.apache.solr.uima.processor"><B>NEXT CLASS</B></A></FONT></TD>
234<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
235  <A HREF="../../../../../index.html?org/apache/solr/uima/processor/UIMAToSolrMapper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
236&nbsp;<A HREF="UIMAToSolrMapper.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
237&nbsp;<SCRIPT type="text/javascript">
238  <!--
239  if(window==top) {
240    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
241  }
242  //-->
243</SCRIPT>
244<NOSCRIPT>
245  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
246</NOSCRIPT>
247
248
249</FONT></TD>
250</TR>
251<TR>
252<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
253  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
254<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
255DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
256</TR>
257</TABLE>
258<A NAME="skip-navbar_bottom"></A>
259<!-- ======== END OF BOTTOM NAVBAR ======= -->
260
261<HR>
262
263          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
264          <script src='../../../../../prettify.js' type='text/javascript'></script>
265          <script type='text/javascript'>
266            (function(){
267              var oldonload = window.onload;
268              if (typeof oldonload != 'function') {
269                window.onload = prettyPrint;
270              } else {
271                window.onload = function() {
272                  oldonload();
273                  prettyPrint();
274                }
275              }
276            })();
277          </script>
278       
279</BODY>
280</HTML>
Note: See TracBrowser for help on using the repository browser.