org.apache.arrow.flight.example

Class Stream

java.lang.Object

org.apache.arrow.flight.example.Stream

All Implemented Interfaces:

AutoCloseable, Iterable<ArrowRecordBatch>

public class Stream
extends Object
implements AutoCloseable, Iterable<ArrowRecordBatch>

A collection of Arrow record batches.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stream.StreamCreator Provides the functionality to create a new stream by adding batches serially.

Constructor Summary

Constructors

Constructor and Description
Stream(Schema schema, DictionaryProvider dictionaryProvider, List<ArrowRecordBatch> batches, long recordCount) Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	close()
long	getRecordCount()
Schema	getSchema()
String	getUuid()
Iterator<ArrowRecordBatch>	iterator()
void	sendTo(BufferAllocator allocator, FlightProducer.ServerStreamListener listener) Sends that data from this object to the given listener.
void	verify(ExampleTicket ticket) Throws an IllegalStateException if the given ticket doesn't correspond to this stream.

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

Stream

public Stream(Schema schema,
              DictionaryProvider dictionaryProvider,
              List<ArrowRecordBatch> batches,
              long recordCount)

Create a new instance.

Parameters:

schema - The schema for the record batches.

batches - The data associated with the stream.

recordCount - The total record count across all batches.

Method Detail

getSchema

public Schema getSchema()

iterator

public Iterator<ArrowRecordBatch> iterator()

Specified by:

iterator in interface Iterable<ArrowRecordBatch>

getRecordCount

public long getRecordCount()

getUuid

public String getUuid()

sendTo

public void sendTo(BufferAllocator allocator,
                   FlightProducer.ServerStreamListener listener)

Sends that data from this object to the given listener.

verify

public void verify(ExampleTicket ticket)

Throws an IllegalStateException if the given ticket doesn't correspond to this stream.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception