Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Annotate
Revision Log

CSVConfig.html @ 7588

Revision 7588, 33.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:24 EDT 2012 -->
6	<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7	<TITLE>
8	CSVConfig (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="CSVConfig (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/CSVConfig.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	PREV CLASS
59	<A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfigGuesser.html" title="class in org.apache.solr.internal.csv.writer"><B>NEXT CLASS</B></A></FONT></TD>
60	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61	<A HREF="../../../../../../index.html?org/apache/solr/internal/csv/writer/CSVConfig.html" target="_top"><B>FRAMES</B></A>
62	<A HREF="CSVConfig.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.internal.csv.writer</FONT>
92	<BR>
93	Class CSVConfig</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.internal.csv.writer.CSVConfig</B>
97	</PRE>
98	<HR>
99	<DL>
100	<DT><PRE>public class <B>CSVConfig</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	The CSVConfig is used to configure the CSV writer
105	<P>
106
107	<P>
108	<HR>
109
110	<P>
111	<!-- =========== FIELD SUMMARY =========== -->
112
113	<A NAME="field_summary"><!-- --></A>
114	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
115	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
116	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
117	<B>Field Summary</B></FONT></TH>
118	</TR>
119	<TR BGCOLOR="white" CLASS="TableRowColor">
120	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
121	<CODE>static int</CODE></FONT></TD>
122	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#FILLLEFT">FILLLEFT</A></B></CODE>
123
124	<BR>
125	Fill content the the left.</TD>
126	</TR>
127	<TR BGCOLOR="white" CLASS="TableRowColor">
128	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129	<CODE>static int</CODE></FONT></TD>
130	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#FILLNONE">FILLNONE</A></B></CODE>
131
132	<BR>
133	Do no do any filling</TD>
134	</TR>
135	<TR BGCOLOR="white" CLASS="TableRowColor">
136	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137	<CODE>static int</CODE></FONT></TD>
138	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#FILLRIGHT">FILLRIGHT</A></B></CODE>
139
140	<BR>
141	Fill content to the right.</TD>
142	</TR>
143	</TABLE>
144
145	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
146
147	<A NAME="constructor_summary"><!-- --></A>
148	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
149	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
150	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
151	<B>Constructor Summary</B></FONT></TH>
152	</TR>
153	<TR BGCOLOR="white" CLASS="TableRowColor">
154	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#CSVConfig()">CSVConfig</A></B>()</CODE>
155
156	<BR>
157	</TD>
158	</TR>
159	</TABLE>
160
161	<!-- ========== METHOD SUMMARY =========== -->
162
163	<A NAME="method_summary"><!-- --></A>
164	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
165	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
166	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
167	<B>Method Summary</B></FONT></TH>
168	</TR>
169	<TR BGCOLOR="white" CLASS="TableRowColor">
170	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171	<CODE> void</CODE></FONT></TD>
172	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#addField(org.apache.solr.internal.csv.writer.CSVField)">addField</A></B>(<A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVField.html" title="class in org.apache.solr.internal.csv.writer">CSVField</A> field)</CODE>
173
174	<BR>
175	</TD>
176	</TR>
177	<TR BGCOLOR="white" CLASS="TableRowColor">
178	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179	<CODE> boolean</CODE></FONT></TD>
180	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#equals(java.lang.Object)">equals</A></B>(<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> obj)</CODE>
181
182	<BR>
183	TODO..</TD>
184	</TR>
185	<TR BGCOLOR="white" CLASS="TableRowColor">
186	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187	<CODE> char</CODE></FONT></TD>
188	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#getDelimiter()">getDelimiter</A></B>()</CODE>
189
190	<BR>
191	</TD>
192	</TR>
193	<TR BGCOLOR="white" CLASS="TableRowColor">
194	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
195	<CODE> <A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVField.html" title="class in org.apache.solr.internal.csv.writer">CSVField</A></CODE></FONT></TD>
196	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.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> name)</CODE>
197
198	<BR>
199	</TD>
200	</TR>
201	<TR BGCOLOR="white" CLASS="TableRowColor">
202	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
203	<CODE> <A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVField.html" title="class in org.apache.solr.internal.csv.writer">CSVField</A>[]</CODE></FONT></TD>
204	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#getFields()">getFields</A></B>()</CODE>
205
206	<BR>
207	</TD>
208	</TR>
209	<TR BGCOLOR="white" CLASS="TableRowColor">
210	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
211	<CODE> int</CODE></FONT></TD>
212	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#getFill()">getFill</A></B>()</CODE>
213
214	<BR>
215	</TD>
216	</TR>
217	<TR BGCOLOR="white" CLASS="TableRowColor">
218	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
219	<CODE> char</CODE></FONT></TD>
220	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#getFillChar()">getFillChar</A></B>()</CODE>
221
222	<BR>
223	</TD>
224	</TR>
225	<TR BGCOLOR="white" CLASS="TableRowColor">
226	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227	<CODE> char</CODE></FONT></TD>
228	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#getValueDelimiter()">getValueDelimiter</A></B>()</CODE>
229
230	<BR>
231	</TD>
232	</TR>
233	<TR BGCOLOR="white" CLASS="TableRowColor">
234	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235	<CODE>static <A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html" title="class in org.apache.solr.internal.csv.writer">CSVConfig</A></CODE></FONT></TD>
236	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#guessConfig(java.io.InputStream)">guessConfig</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> inputStream)</CODE>
237
238	<BR>
239	Creates a config based on a stream.</TD>
240	</TR>
241	<TR BGCOLOR="white" CLASS="TableRowColor">
242	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
243	<CODE> boolean</CODE></FONT></TD>
244	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#isDelimiterIgnored()">isDelimiterIgnored</A></B>()</CODE>
245
246	<BR>
247	</TD>
248	</TR>
249	<TR BGCOLOR="white" CLASS="TableRowColor">
250	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
251	<CODE> boolean</CODE></FONT></TD>
252	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#isEndTrimmed()">isEndTrimmed</A></B>()</CODE>
253
254	<BR>
255	</TD>
256	</TR>
257	<TR BGCOLOR="white" CLASS="TableRowColor">
258	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
259	<CODE> boolean</CODE></FONT></TD>
260	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#isFieldHeader()">isFieldHeader</A></B>()</CODE>
261
262	<BR>
263	</TD>
264	</TR>
265	<TR BGCOLOR="white" CLASS="TableRowColor">
266	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
267	<CODE> boolean</CODE></FONT></TD>
268	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#isFixedWidth()">isFixedWidth</A></B>()</CODE>
269
270	<BR>
271	</TD>
272	</TR>
273	<TR BGCOLOR="white" CLASS="TableRowColor">
274	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
275	<CODE> boolean</CODE></FONT></TD>
276	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#isValueDelimiterIgnored()">isValueDelimiterIgnored</A></B>()</CODE>
277
278	<BR>
279	</TD>
280	</TR>
281	<TR BGCOLOR="white" CLASS="TableRowColor">
282	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
283	<CODE> void</CODE></FONT></TD>
284	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#setDelimiter(char)">setDelimiter</A></B>(char delimiter)</CODE>
285
286	<BR>
287	Set the delimiter to use</TD>
288	</TR>
289	<TR BGCOLOR="white" CLASS="TableRowColor">
290	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
291	<CODE> void</CODE></FONT></TD>
292	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#setEndTrimmed(boolean)">setEndTrimmed</A></B>(boolean endTrimmed)</CODE>
293
294	<BR>
295	Specify if the end of the line needs to be trimmed.</TD>
296	</TR>
297	<TR BGCOLOR="white" CLASS="TableRowColor">
298	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
299	<CODE> void</CODE></FONT></TD>
300	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#setFieldHeader(boolean)">setFieldHeader</A></B>(boolean fieldHeader)</CODE>
301
302	<BR>
303	Specify if you want to use a field header.</TD>
304	</TR>
305	<TR BGCOLOR="white" CLASS="TableRowColor">
306	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
307	<CODE> void</CODE></FONT></TD>
308	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#setFields(java.util.Collection)">setFields</A></B>(<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> csvField)</CODE>
309
310	<BR>
311	Set the fields that should be used by the writer</TD>
312	</TR>
313	<TR BGCOLOR="white" CLASS="TableRowColor">
314	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
315	<CODE> void</CODE></FONT></TD>
316	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#setFields(org.apache.solr.internal.csv.writer.CSVField[])">setFields</A></B>(<A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVField.html" title="class in org.apache.solr.internal.csv.writer">CSVField</A>[] csvFields)</CODE>
317
318	<BR>
319	Set the fields that should be used by the writer.</TD>
320	</TR>
321	<TR BGCOLOR="white" CLASS="TableRowColor">
322	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
323	<CODE> void</CODE></FONT></TD>
324	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#setFill(int)">setFill</A></B>(int fill)</CODE>
325
326	<BR>
327	Set the fill pattern.</TD>
328	</TR>
329	<TR BGCOLOR="white" CLASS="TableRowColor">
330	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
331	<CODE> void</CODE></FONT></TD>
332	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#setFillChar(char)">setFillChar</A></B>(char fillChar)</CODE>
333
334	<BR>
335	Set the fill char</TD>
336	</TR>
337	<TR BGCOLOR="white" CLASS="TableRowColor">
338	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
339	<CODE> void</CODE></FONT></TD>
340	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#setFixedWidth(boolean)">setFixedWidth</A></B>(boolean fixedWidth)</CODE>
341
342	<BR>
343	Specify if the CSV file is fixed width.</TD>
344	</TR>
345	<TR BGCOLOR="white" CLASS="TableRowColor">
346	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
347	<CODE> void</CODE></FONT></TD>
348	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#setIgnoreDelimiter(boolean)">setIgnoreDelimiter</A></B>(boolean ignoreDelimiter)</CODE>
349
350	<BR>
351	Specify if the writer should ignore the delimiter.</TD>
352	</TR>
353	<TR BGCOLOR="white" CLASS="TableRowColor">
354	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
355	<CODE> void</CODE></FONT></TD>
356	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#setIgnoreValueDelimiter(boolean)">setIgnoreValueDelimiter</A></B>(boolean ignoreValueDelimiter)</CODE>
357
358	<BR>
359	Specify if the writer should ignore the value delimiter.</TD>
360	</TR>
361	<TR BGCOLOR="white" CLASS="TableRowColor">
362	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
363	<CODE> void</CODE></FONT></TD>
364	<TD><CODE><B><A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#setValueDelimiter(char)">setValueDelimiter</A></B>(char valueDelimiter)</CODE>
365
366	<BR>
367	Set the value delimiter to use</TD>
368	</TR>
369	</TABLE>
370	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
371	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
372	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
373	<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>
374	</TR>
375	<TR BGCOLOR="white" CLASS="TableRowColor">
376	<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#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>
377	</TR>
378	</TABLE>
379
380	<P>
381
382	<!-- ============ FIELD DETAIL =========== -->
383
384	<A NAME="field_detail"><!-- --></A>
385	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
386	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
387	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
388	<B>Field Detail</B></FONT></TH>
389	</TR>
390	</TABLE>
391
392	<A NAME="FILLNONE"><!-- --></A><H3>
393	FILLNONE</H3>
394	<PRE>
395	public static final int <B>FILLNONE</B></PRE>
396	<DL>
397	<DD>Do no do any filling
398	<P>
399	<DL>
400	<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.solr.internal.csv.writer.CSVConfig.FILLNONE">Constant Field Values</A></DL>
401	</DL>
402	<HR>
403
404	<A NAME="FILLLEFT"><!-- --></A><H3>
405	FILLLEFT</H3>
406	<PRE>
407	public static final int <B>FILLLEFT</B></PRE>
408	<DL>
409	<DD>Fill content the the left. Mainly usable together with fixedWidth
410	<P>
411	<DL>
412	<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.solr.internal.csv.writer.CSVConfig.FILLLEFT">Constant Field Values</A></DL>
413	</DL>
414	<HR>
415
416	<A NAME="FILLRIGHT"><!-- --></A><H3>
417	FILLRIGHT</H3>
418	<PRE>
419	public static final int <B>FILLRIGHT</B></PRE>
420	<DL>
421	<DD>Fill content to the right. Mainly usable together with fixedWidth
422	<P>
423	<DL>
424	<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.solr.internal.csv.writer.CSVConfig.FILLRIGHT">Constant Field Values</A></DL>
425	</DL>
426
427	<!-- ========= CONSTRUCTOR DETAIL ======== -->
428
429	<A NAME="constructor_detail"><!-- --></A>
430	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
431	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
432	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
433	<B>Constructor Detail</B></FONT></TH>
434	</TR>
435	</TABLE>
436
437	<A NAME="CSVConfig()"><!-- --></A><H3>
438	CSVConfig</H3>
439	<PRE>
440	public <B>CSVConfig</B>()</PRE>
441	<DL>
442	</DL>
443
444	<!-- ============ METHOD DETAIL ========== -->
445
446	<A NAME="method_detail"><!-- --></A>
447	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
448	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
449	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
450	<B>Method Detail</B></FONT></TH>
451	</TR>
452	</TABLE>
453
454	<A NAME="isFixedWidth()"><!-- --></A><H3>
455	isFixedWidth</H3>
456	<PRE>
457	public boolean <B>isFixedWidth</B>()</PRE>
458	<DL>
459	<DD><DL>
460
461	<DT><B>Returns:</B><DD>if the CSV file is fixedWidth</DL>
462	</DD>
463	</DL>
464	<HR>
465
466	<A NAME="setFixedWidth(boolean)"><!-- --></A><H3>
467	setFixedWidth</H3>
468	<PRE>
469	public void <B>setFixedWidth</B>(boolean fixedWidth)</PRE>
470	<DL>
471	<DD>Specify if the CSV file is fixed width.
472	Defaults to false
473	<P>
474	<DD><DL>
475	<DT><B>Parameters:</B><DD><CODE>fixedWidth</CODE> - the fixedwidth</DL>
476	</DD>
477	</DL>
478	<HR>
479
480	<A NAME="addField(org.apache.solr.internal.csv.writer.CSVField)"><!-- --></A><H3>
481	addField</H3>
482	<PRE>
483	public void <B>addField</B>(<A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVField.html" title="class in org.apache.solr.internal.csv.writer">CSVField</A> field)</PRE>
484	<DL>
485	<DD><DL>
486	</DL>
487	</DD>
488	</DL>
489	<HR>
490
491	<A NAME="setFields(org.apache.solr.internal.csv.writer.CSVField[])"><!-- --></A><H3>
492	setFields</H3>
493	<PRE>
494	public void <B>setFields</B>(<A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVField.html" title="class in org.apache.solr.internal.csv.writer">CSVField</A>[] csvFields)</PRE>
495	<DL>
496	<DD>Set the fields that should be used by the writer.
497	This will overwrite currently added fields completely!
498	<P>
499	<DD><DL>
500	<DT><B>Parameters:</B><DD><CODE>csvFields</CODE> - the csvfields array. If null it will do nothing</DL>
501	</DD>
502	</DL>
503	<HR>
504
505	<A NAME="setFields(java.util.Collection)"><!-- --></A><H3>
506	setFields</H3>
507	<PRE>
508	public void <B>setFields</B>(<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> csvField)</PRE>
509	<DL>
510	<DD>Set the fields that should be used by the writer
511	<P>
512	<DD><DL>
513	<DT><B>Parameters:</B><DD><CODE>csvField</CODE> - a collection with fields. If null it will do nothing</DL>
514	</DD>
515	</DL>
516	<HR>
517
518	<A NAME="getFields()"><!-- --></A><H3>
519	getFields</H3>
520	<PRE>
521	public <A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVField.html" title="class in org.apache.solr.internal.csv.writer">CSVField</A>[] <B>getFields</B>()</PRE>
522	<DL>
523	<DD><DL>
524
525	<DT><B>Returns:</B><DD>an array with the known fields (even if no fields are specified)</DL>
526	</DD>
527	</DL>
528	<HR>
529
530	<A NAME="getField(java.lang.String)"><!-- --></A><H3>
531	getField</H3>
532	<PRE>
533	public <A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVField.html" title="class in org.apache.solr.internal.csv.writer">CSVField</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> name)</PRE>
534	<DL>
535	<DD><DL>
536	</DL>
537	</DD>
538	</DL>
539	<HR>
540
541	<A NAME="getFill()"><!-- --></A><H3>
542	getFill</H3>
543	<PRE>
544	public int <B>getFill</B>()</PRE>
545	<DL>
546	<DD><DL>
547
548	<DT><B>Returns:</B><DD>the fill pattern.</DL>
549	</DD>
550	</DL>
551	<HR>
552
553	<A NAME="setFill(int)"><!-- --></A><H3>
554	setFill</H3>
555	<PRE>
556	public void <B>setFill</B>(int fill)</PRE>
557	<DL>
558	<DD>Set the fill pattern. Defaults to <A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#FILLNONE"><CODE>FILLNONE</CODE></A>
559	<br/>Other options are : <A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#FILLLEFT"><CODE>FILLLEFT</CODE></A> and <A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html#FILLRIGHT"><CODE>FILLRIGHT</CODE></A>
560	<P>
561	<DD><DL>
562	<DT><B>Parameters:</B><DD><CODE>fill</CODE> - the fill pattern.</DL>
563	</DD>
564	</DL>
565	<HR>
566
567	<A NAME="getFillChar()"><!-- --></A><H3>
568	getFillChar</H3>
569	<PRE>
570	public char <B>getFillChar</B>()</PRE>
571	<DL>
572	<DD><DL>
573
574	<DT><B>Returns:</B><DD>the fillchar. Defaults to a space.</DL>
575	</DD>
576	</DL>
577	<HR>
578
579	<A NAME="setFillChar(char)"><!-- --></A><H3>
580	setFillChar</H3>
581	<PRE>
582	public void <B>setFillChar</B>(char fillChar)</PRE>
583	<DL>
584	<DD>Set the fill char
585	<P>
586	<DD><DL>
587	<DT><B>Parameters:</B><DD><CODE>fillChar</CODE> - the fill char</DL>
588	</DD>
589	</DL>
590	<HR>
591
592	<A NAME="getDelimiter()"><!-- --></A><H3>
593	getDelimiter</H3>
594	<PRE>
595	public char <B>getDelimiter</B>()</PRE>
596	<DL>
597	<DD><DL>
598
599	<DT><B>Returns:</B><DD>the delimeter used.</DL>
600	</DD>
601	</DL>
602	<HR>
603
604	<A NAME="setDelimiter(char)"><!-- --></A><H3>
605	setDelimiter</H3>
606	<PRE>
607	public void <B>setDelimiter</B>(char delimiter)</PRE>
608	<DL>
609	<DD>Set the delimiter to use
610	<P>
611	<DD><DL>
612	<DT><B>Parameters:</B><DD><CODE>delimiter</CODE> - the delimiter character.</DL>
613	</DD>
614	</DL>
615	<HR>
616
617	<A NAME="isDelimiterIgnored()"><!-- --></A><H3>
618	isDelimiterIgnored</H3>
619	<PRE>
620	public boolean <B>isDelimiterIgnored</B>()</PRE>
621	<DL>
622	<DD><DL>
623
624	<DT><B>Returns:</B><DD>if the writer should ignore the delimiter character.</DL>
625	</DD>
626	</DL>
627	<HR>
628
629	<A NAME="setIgnoreDelimiter(boolean)"><!-- --></A><H3>
630	setIgnoreDelimiter</H3>
631	<PRE>
632	public void <B>setIgnoreDelimiter</B>(boolean ignoreDelimiter)</PRE>
633	<DL>
634	<DD>Specify if the writer should ignore the delimiter.
635	<P>
636	<DD><DL>
637	<DT><B>Parameters:</B><DD><CODE>ignoreDelimiter</CODE> - defaults to false.</DL>
638	</DD>
639	</DL>
640	<HR>
641
642	<A NAME="getValueDelimiter()"><!-- --></A><H3>
643	getValueDelimiter</H3>
644	<PRE>
645	public char <B>getValueDelimiter</B>()</PRE>
646	<DL>
647	<DD><DL>
648
649	<DT><B>Returns:</B><DD>the value delimeter used. Defaults to "</DL>
650	</DD>
651	</DL>
652	<HR>
653
654	<A NAME="setValueDelimiter(char)"><!-- --></A><H3>
655	setValueDelimiter</H3>
656	<PRE>
657	public void <B>setValueDelimiter</B>(char valueDelimiter)</PRE>
658	<DL>
659	<DD>Set the value delimiter to use
660	<P>
661	<DD><DL>
662	<DT><B>Parameters:</B><DD><CODE>valueDelimiter</CODE> - the value delimiter character.</DL>
663	</DD>
664	</DL>
665	<HR>
666
667	<A NAME="isValueDelimiterIgnored()"><!-- --></A><H3>
668	isValueDelimiterIgnored</H3>
669	<PRE>
670	public boolean <B>isValueDelimiterIgnored</B>()</PRE>
671	<DL>
672	<DD><DL>
673
674	<DT><B>Returns:</B><DD>if the writer should ignore the value delimiter character.
675	Defaults to true.</DL>
676	</DD>
677	</DL>
678	<HR>
679
680	<A NAME="setIgnoreValueDelimiter(boolean)"><!-- --></A><H3>
681	setIgnoreValueDelimiter</H3>
682	<PRE>
683	public void <B>setIgnoreValueDelimiter</B>(boolean ignoreValueDelimiter)</PRE>
684	<DL>
685	<DD>Specify if the writer should ignore the value delimiter.
686	<P>
687	<DD><DL>
688	<DT><B>Parameters:</B><DD><CODE>ignoreValueDelimiter</CODE> - defaults to false.</DL>
689	</DD>
690	</DL>
691	<HR>
692
693	<A NAME="isFieldHeader()"><!-- --></A><H3>
694	isFieldHeader</H3>
695	<PRE>
696	public boolean <B>isFieldHeader</B>()</PRE>
697	<DL>
698	<DD><DL>
699
700	<DT><B>Returns:</B><DD>if a field header is used. Defaults to false</DL>
701	</DD>
702	</DL>
703	<HR>
704
705	<A NAME="setFieldHeader(boolean)"><!-- --></A><H3>
706	setFieldHeader</H3>
707	<PRE>
708	public void <B>setFieldHeader</B>(boolean fieldHeader)</PRE>
709	<DL>
710	<DD>Specify if you want to use a field header.
711	<P>
712	<DD><DL>
713	<DT><B>Parameters:</B><DD><CODE>fieldHeader</CODE> - true or false.</DL>
714	</DD>
715	</DL>
716	<HR>
717
718	<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
719	equals</H3>
720	<PRE>
721	public boolean <B>equals</B>(<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> obj)</PRE>
722	<DL>
723	<DD>TODO..
724	<P>
725	<DD><DL>
726	<DT><B>Overrides:</B><DD><CODE><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></CODE> in class <CODE><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></CODE></DL>
727	</DD>
728	<DD><DL>
729	<DT><B>See Also:</B><DD><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"><CODE>Object.equals(java.lang.Object)</CODE></A></DL>
730	</DD>
731	</DL>
732	<HR>
733
734	<A NAME="guessConfig(java.io.InputStream)"><!-- --></A><H3>
735	guessConfig</H3>
736	<PRE>
737	public static <A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfig.html" title="class in org.apache.solr.internal.csv.writer">CSVConfig</A> <B>guessConfig</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> inputStream)</PRE>
738	<DL>
739	<DD>Creates a config based on a stream. It tries to guess<br/>
740	NOTE : The stream will be closed.
741	<P>
742	<DD><DL>
743	<DT><B>Parameters:</B><DD><CODE>inputStream</CODE> - the inputstream.
744	<DT><B>Returns:</B><DD>the guessed config.</DL>
745	</DD>
746	</DL>
747	<HR>
748
749	<A NAME="isEndTrimmed()"><!-- --></A><H3>
750	isEndTrimmed</H3>
751	<PRE>
752	public boolean <B>isEndTrimmed</B>()</PRE>
753	<DL>
754	<DD><DL>
755
756	<DT><B>Returns:</B><DD>if the end of the line should be trimmed. Default is false.</DL>
757	</DD>
758	</DL>
759	<HR>
760
761	<A NAME="setEndTrimmed(boolean)"><!-- --></A><H3>
762	setEndTrimmed</H3>
763	<PRE>
764	public void <B>setEndTrimmed</B>(boolean endTrimmed)</PRE>
765	<DL>
766	<DD>Specify if the end of the line needs to be trimmed. Defaults to false.
767	<P>
768	<DD><DL>
769	<DT><B>Parameters:</B><DD><CODE>endTrimmed</CODE> - </DL>
770	</DD>
771	</DL>
772	<!-- ========= END OF CLASS DATA ========= -->
773	<HR>
774
775
776	<!-- ======= START OF BOTTOM NAVBAR ====== -->
777	<A NAME="navbar_bottom"><!-- --></A>
778	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
779	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
780	<TR>
781	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
782	<A NAME="navbar_bottom_firstrow"><!-- --></A>
783	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
784	<TR ALIGN="center" VALIGN="top">
785	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
786	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
787	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
788	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CSVConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
789	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
790	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
791	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
792	</TR>
793	</TABLE>
794	</TD>
795	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
796	</EM>
797	</TD>
798	</TR>
799
800	<TR>
801	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
802	PREV CLASS
803	<A HREF="../../../../../../org/apache/solr/internal/csv/writer/CSVConfigGuesser.html" title="class in org.apache.solr.internal.csv.writer"><B>NEXT CLASS</B></A></FONT></TD>
804	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
805	<A HREF="../../../../../../index.html?org/apache/solr/internal/csv/writer/CSVConfig.html" target="_top"><B>FRAMES</B></A>
806	<A HREF="CSVConfig.html" target="_top"><B>NO FRAMES</B></A>
807	<SCRIPT type="text/javascript">
808	<!--
809	if(window==top) {
810	document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
811	}
812	//-->
813	</SCRIPT>
814	<NOSCRIPT>
815	<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
816	</NOSCRIPT>
817
818
819	</FONT></TD>
820	</TR>
821	<TR>
822	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
823	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
824	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
825	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
826	</TR>
827	</TABLE>
828	<A NAME="skip-navbar_bottom"></A>
829	<!-- ======== END OF BOTTOM NAVBAR ======= -->
830
831	<HR>
832
833	<address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address>
834	<script src='../../../../../../prettify.js' type='text/javascript'></script>
835	<script type='text/javascript'>
836	(function(){
837	var oldonload = window.onload;
838	if (typeof oldonload != 'function') {
839	window.onload = prettyPrint;
840	} else {
841	window.onload = function() {
842	oldonload();
843	prettyPrint();
844	}
845	}
846	})();
847	</script>
848
849	</BODY>
850	</HTML>

Note: See TracBrowser for help on using the repository browser.

Context Navigation

source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/internal/csv/writer/CSVConfig.html @ 7588

Download in other formats: