source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/handler/dataimport/TemplateString.html @ 7588

Revision 7588, 15.6 KB checked in by adir, 12 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>
8TemplateString (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="TemplateString (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/TemplateString.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/handler/dataimport/SqlEntityProcessor.html" title="class in org.apache.solr.handler.dataimport"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/handler/dataimport/TemplateTransformer.html" title="class in org.apache.solr.handler.dataimport"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/solr/handler/dataimport/TemplateString.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="TemplateString.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.handler.dataimport</FONT>
92<BR>
93Class TemplateString</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.handler.dataimport.TemplateString</B>
97</PRE>
98<HR>
99<DL>
100<DT><PRE>public class <B>TemplateString</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<p>
105 Provides functionality for replacing variables in a templatized string. It
106 can also be used to get the place-holders (variables) in a templatized
107 string.
108 </p>
109 <p/>
110 <b>This API is experimental and may change in the future.</b>
111<P>
112
113<P>
114<DL>
115<DT><B>Since:</B></DT>
116  <DD>solr 1.3</DD>
117</DL>
118<HR>
119
120<P>
121
122<!-- ======== CONSTRUCTOR SUMMARY ======== -->
123
124<A NAME="constructor_summary"><!-- --></A>
125<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
126<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
127<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
128<B>Constructor Summary</B></FONT></TH>
129</TR>
130<TR BGCOLOR="white" CLASS="TableRowColor">
131<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/TemplateString.html#TemplateString()">TemplateString</A></B>()</CODE>
132
133<BR>
134&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
135</TR>
136</TABLE>
137&nbsp;
138<!-- ========== METHOD SUMMARY =========== -->
139
140<A NAME="method_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>Method Summary</B></FONT></TH>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148<CODE>static&nbsp;<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>&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>&gt;</CODE></FONT></TD>
149<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/TemplateString.html#getVariables(java.lang.String)">getVariables</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;s)</CODE>
150
151<BR>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the variables in the given string.</TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
157<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/dataimport/TemplateString.html#replaceTokens(java.lang.String, org.apache.solr.handler.dataimport.VariableResolver)">replaceTokens</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;string,
158              <A HREF="../../../../../org/apache/solr/handler/dataimport/VariableResolver.html" title="class in org.apache.solr.handler.dataimport">VariableResolver</A>&nbsp;resolver)</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a string with all variables replaced by the known values.</TD>
162</TR>
163</TABLE>
164&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
165<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
166<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
167<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>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<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>
171</TR>
172</TABLE>
173&nbsp;
174<P>
175
176<!-- ========= CONSTRUCTOR DETAIL ======== -->
177
178<A NAME="constructor_detail"><!-- --></A>
179<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
180<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
181<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
182<B>Constructor Detail</B></FONT></TH>
183</TR>
184</TABLE>
185
186<A NAME="TemplateString()"><!-- --></A><H3>
187TemplateString</H3>
188<PRE>
189public <B>TemplateString</B>()</PRE>
190<DL>
191</DL>
192
193<!-- ============ METHOD DETAIL ========== -->
194
195<A NAME="method_detail"><!-- --></A>
196<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
197<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
198<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
199<B>Method Detail</B></FONT></TH>
200</TR>
201</TABLE>
202
203<A NAME="replaceTokens(java.lang.String, org.apache.solr.handler.dataimport.VariableResolver)"><!-- --></A><H3>
204replaceTokens</H3>
205<PRE>
206public <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>replaceTokens</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;string,
207                            <A HREF="../../../../../org/apache/solr/handler/dataimport/VariableResolver.html" title="class in org.apache.solr.handler.dataimport">VariableResolver</A>&nbsp;resolver)</PRE>
208<DL>
209<DD>Returns a string with all variables replaced by the known values. An
210 unknown variable is replaced by an empty string.
211<P>
212<DD><DL>
213<DT><B>Parameters:</B><DD><CODE>string</CODE> - the String to be resolved<DD><CODE>resolver</CODE> - the VariableResolver instance to be used for evaluation
214<DT><B>Returns:</B><DD>the string with all variables replaced</DL>
215</DD>
216</DL>
217<HR>
218
219<A NAME="getVariables(java.lang.String)"><!-- --></A><H3>
220getVariables</H3>
221<PRE>
222public static <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>&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>&gt; <B>getVariables</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;s)</PRE>
223<DL>
224<DD>Returns the variables in the given string.
225<P>
226<DD><DL>
227<DT><B>Parameters:</B><DD><CODE>s</CODE> - the templatized string
228<DT><B>Returns:</B><DD>the list of variables (strings) in the given templatized string.</DL>
229</DD>
230</DL>
231<!-- ========= END OF CLASS DATA ========= -->
232<HR>
233
234
235<!-- ======= START OF BOTTOM NAVBAR ====== -->
236<A NAME="navbar_bottom"><!-- --></A>
237<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
238<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
239<TR>
240<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
241<A NAME="navbar_bottom_firstrow"><!-- --></A>
242<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
243  <TR ALIGN="center" VALIGN="top">
244  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
245  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
246  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
247  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TemplateString.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
248  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
249  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
250  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
251  </TR>
252</TABLE>
253</TD>
254<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
255</EM>
256</TD>
257</TR>
258
259<TR>
260<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
261&nbsp;<A HREF="../../../../../org/apache/solr/handler/dataimport/SqlEntityProcessor.html" title="class in org.apache.solr.handler.dataimport"><B>PREV CLASS</B></A>&nbsp;
262&nbsp;<A HREF="../../../../../org/apache/solr/handler/dataimport/TemplateTransformer.html" title="class in org.apache.solr.handler.dataimport"><B>NEXT CLASS</B></A></FONT></TD>
263<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
264  <A HREF="../../../../../index.html?org/apache/solr/handler/dataimport/TemplateString.html" target="_top"><B>FRAMES</B></A>  &nbsp;
265&nbsp;<A HREF="TemplateString.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
266&nbsp;<SCRIPT type="text/javascript">
267  <!--
268  if(window==top) {
269    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
270  }
271  //-->
272</SCRIPT>
273<NOSCRIPT>
274  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
275</NOSCRIPT>
276
277
278</FONT></TD>
279</TR>
280<TR>
281<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
282  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
283<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
284DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
285</TR>
286</TABLE>
287<A NAME="skip-navbar_bottom"></A>
288<!-- ======== END OF BOTTOM NAVBAR ======= -->
289
290<HR>
291
292          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
293          <script src='../../../../../prettify.js' type='text/javascript'></script>
294          <script type='text/javascript'>
295            (function(){
296              var oldonload = window.onload;
297              if (typeof oldonload != 'function') {
298                window.onload = prettyPrint;
299              } else {
300                window.onload = function() {
301                  oldonload();
302                  prettyPrint();
303                }
304              }
305            })();
306          </script>
307       
308</BODY>
309</HTML>
Note: See TracBrowser for help on using the repository browser.