org.apache.nifi.serialization

Class AbstractRecordSetWriter

java.lang.Object

org.apache.nifi.serialization.AbstractRecordSetWriter

All Implemented Interfaces:

Closeable, AutoCloseable, RecordSetWriter, RecordWriter

public abstract class AbstractRecordSetWriter
extends Object
implements RecordSetWriter

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	activeRecordSet
private OutputStream	out
private int	recordCount

Constructor Summary

Constructors

Constructor and Description
AbstractRecordSetWriter(OutputStream out)

Method Summary

Modifier and Type	Method and Description
void	beginRecordSet() Begins a new RecordSet
void	close()
WriteResult	finishRecordSet() Finishes the currently active RecordSet and returns a WriteResult that includes information about what was written
void	flush() Flushes any buffered data to the underlying stream
protected OutputStream	getOutputStream()
protected int	getRecordCount()
protected int	incrementRecordCount()
protected boolean	isActiveRecordSet()
protected void	onBeginRecordSet() Method that is called as a result of beginRecordSet() being called.
protected Map<String,String>	onFinishRecordSet() Method that is called by finishRecordSet() when a RecordSet is finished.
WriteResult	write(Record record) Writes the given record to the underlying stream
WriteResult	write(RecordSet recordSet) Writes the given result set to the given output stream
protected abstract Map<String,String>	writeRecord(Record record)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.serialization.RecordWriter

getMimeType

Field Detail

out

private final OutputStream out

recordCount

private int recordCount

activeRecordSet

private boolean activeRecordSet

Constructor Detail

AbstractRecordSetWriter

public AbstractRecordSetWriter(OutputStream out)

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

flush

public void flush()
           throws IOException

Description copied from interface: RecordWriter

Flushes any buffered data to the underlying stream

Specified by:

flush in interface RecordWriter

Throws:

IOException - if unable to write to the underlying stream

write

public WriteResult write(RecordSet recordSet)
                  throws IOException

Description copied from interface: RecordSetWriter

Writes the given result set to the given output stream

Specified by:

write in interface RecordSetWriter

Parameters:

recordSet - the record set to serialize

Returns:

the results of writing the data

Throws:

IOException - if unable to write to the given OutputStream

write

public final WriteResult write(Record record)
                        throws IOException

Description copied from interface: RecordWriter

Writes the given record to the underlying stream

Specified by:

write in interface RecordWriter

Parameters:

record - the record to write

Returns:

the results of writing the data

Throws:

IOException - if unable to write to the underlying stream

getOutputStream

protected OutputStream getOutputStream()

getRecordCount

protected final int getRecordCount()

isActiveRecordSet

protected final boolean isActiveRecordSet()

beginRecordSet

public final void beginRecordSet()
                          throws IOException

Description copied from interface: RecordSetWriter

Begins a new RecordSet

Specified by:

beginRecordSet in interface RecordSetWriter

Throws:

IOException - if unable to write to the underlying OutputStream

finishRecordSet

public final WriteResult finishRecordSet()
                                  throws IOException

Description copied from interface: RecordSetWriter

Finishes the currently active RecordSet and returns a WriteResult that includes information about what was written

Specified by:

finishRecordSet in interface RecordSetWriter

Returns:

the results of writing the data

Throws:

IOException - if unable to write to the given OutputStream

incrementRecordCount

protected int incrementRecordCount()

onBeginRecordSet

protected void onBeginRecordSet()
                         throws IOException

Method that is called as a result of beginRecordSet() being called. This gives subclasses the chance to react to a new RecordSet beginning but prevents the subclass from changing how this implementation maintains its internal state. By default, this method does nothing.

Throws:

IOException - if unable to write the necessary data for a new RecordSet

onFinishRecordSet

protected Map<String,String> onFinishRecordSet()
                                        throws IOException

Method that is called by finishRecordSet() when a RecordSet is finished. This gives subclasses the chance to react to a RecordSet being completed but prevents the subclass from changing how this implementation maintains its internal state.

Returns:

a Map of key/value pairs that should be added to the FlowFile as attributes

Throws:

IOException

writeRecord

protected abstract Map<String,String> writeRecord(Record record)
                                           throws IOException

Throws:

IOException