Package net.solarnetwork.central.support

Class AbstractFilteredResultsProcessor<R>

java.lang.Object

net.solarnetwork.central.support.AbstractFilteredResultsProcessor<R>

Type Parameters:

R - the result item type

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, FilteredResultsProcessor<R>

Direct Known Subclasses:

CsvFilteredResultsProcessor, ObjectMapperFilteredResultsProcessor

public abstract class AbstractFilteredResultsProcessor<R>
extends Object
implements FilteredResultsProcessor<R>

Abstract convenience implementation of FilteredResultsProcessor.

Constructor Summary

Constructors

Constructor	Description
AbstractFilteredResultsProcessor()

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
org.springframework.util.MimeType	getMimeType()	Get the MIME type generated by this processor.
void	start(Long totalResultCount, Integer startingOffset, Integer expectedResultCount, Map<String,?> attributes)	Called at the start of the export process, to initialize any necessary resources or write any header information.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.solarnetwork.central.support.FilteredResultsProcessor

handleResultItem

Constructor Details

AbstractFilteredResultsProcessor

public AbstractFilteredResultsProcessor()

Method Details

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getMimeType

public org.springframework.util.MimeType getMimeType()

Description copied from interface: FilteredResultsProcessor

Get the MIME type generated by this processor.

Specified by:

getMimeType in interface FilteredResultsProcessor<R>

Returns:

the media type

start

public void start(Long totalResultCount,
 Integer startingOffset,
 Integer expectedResultCount,
 Map<String,?> attributes)
           throws IOException

Description copied from interface: FilteredResultsProcessor

Called at the start of the export process, to initialize any necessary resources or write any header information.

Specified by:

start in interface FilteredResultsProcessor<R>

Parameters:

totalResultCount - the total number of results that match the given query, or null if the count is not known

startingOffset - a starting offset within the total result count, or null if not known

expectedResultCount - the expected number of results to be returned to FilteredResultsProcessor.handleResultItem(Object)

attributes - optional implementation-specific attributes to pass to the processor

Throws:

IOException - if an IO error occurs