com.splunk

Class ResultsReaderCsv

java.lang.Object

com.splunk.ResultsReader

com.splunk.ResultsReaderCsv

All Implemented Interfaces:

SearchResults, Iterable<Event>

public class ResultsReaderCsv
extends ResultsReader

The ResultsReaderCsv class represents a streaming CSV reader for Splunk search results. This class requires the opencsv-2.3.jar file in your build path.

Field Summary

Fields inherited from class com.splunk.ResultsReader

inputStream

Constructor Summary

Constructors

Constructor and Description
ResultsReaderCsv(InputStream inputStream) Class constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the reader and returns resources.
Collection<String>	getFields() Returns a collection of field names from the results.
boolean	isPreview() This method is not supported.

Methods inherited from class com.splunk.ResultsReader

getNextEvent, iterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ResultsReaderCsv

public ResultsReaderCsv(InputStream inputStream)
                 throws IOException

Class constructor. Constructs a streaming CSV reader for the event stream. You should only attempt to parse a CSV stream with this reader. If you attempt to parse a different type of stream, unpredictable results may occur.

Parameters:

inputStream - The CSV stream to parse.

Throws:

IOException - The IOException instance

Method Detail

close

public void close()
           throws IOException

Closes the reader and returns resources.

Overrides:

close in class ResultsReader

Throws:

IOException - On IO exception.

isPreview

public boolean isPreview()

This method is not supported.

Returns:

Not applicable.

getFields

public Collection<String> getFields()

Returns a collection of field names from the results.

Returns:

A collection of field names.

Note that any given result will contain a subset of these fields.