Package com.terracottatech.store.stream

Interface MutableRecordStream<K extends Comparable<K>>

All Superinterfaces:

AutoCloseable, BaseStream<Record<K>,Stream<Record<K>>>, RecordStream<K>, Stream<Record<K>>

public interface MutableRecordStream<K extends Comparable<K>>
extends RecordStream<K>

A Stream of Record instances through which the Records may be mutated.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.stream.Stream

Stream.Builder<T extends Object>

Method Summary

Modifier and Type	Method	Description
MutableRecordStream<K>	batch(int sizeHint)	Returns an equivalent stream that uses the given batch size hint.
void	delete()	Deletes every Record in the stream.
Stream<Record<K>>	deleteThen()	Deletes every Record in the stream.
MutableRecordStream<K>	distinct()
MutableRecordStream<K>	explain(Consumer<Object> consumer)	Observes the stream pipeline and provides the pre-execution analysis information for this stream pipeline.
MutableRecordStream<K>	filter(Predicate<? super Record<K>> predicate)
MutableRecordStream<K>	inline()	Returns an equivalent stream where any client side operations are performed inline with the server side.
MutableRecordStream<K>	limit(long maxSize)
void	mutate(UpdateOperation<? super K> transform)	Performs an update transformation against the Records in the stream.
Stream<Tuple<Record<K>,Record<K>>>	mutateThen(UpdateOperation<? super K> transform)	Performs an update transformation against the Records in the stream.
MutableRecordStream<K>	onClose(Runnable closeHandler)
MutableRecordStream<K>	parallel()
MutableRecordStream<K>	peek(Consumer<? super Record<K>> action)
MutableRecordStream<K>	sequential()
MutableRecordStream<K>	skip(long n)
RecordStream<K>	sorted()	This method will throw a java.lang.UnsupportedOperationException since records are not Comparable.
RecordStream<K>	sorted(Comparator<? super Record<K>> comparator)	Returns a RecordStream<K> consisting of the elements of this stream, sorted according to the provided Comparator.
MutableRecordStream<K>	unordered()

Methods inherited from interface java.util.stream.BaseStream

close, isParallel, iterator, spliterator

Methods inherited from interface java.util.stream.Stream

allMatch, anyMatch, collect, collect, count, dropWhile, findAny, findFirst, flatMap, flatMapToDouble, flatMapToInt, flatMapToLong, forEach, forEachOrdered, map, mapMulti, mapMultiToDouble, mapMultiToInt, mapMultiToLong, mapToDouble, mapToInt, mapToLong, max, min, noneMatch, reduce, reduce, reduce, takeWhile, toArray, toArray, toList

Method Details

mutate

void mutate(UpdateOperation<? super K> transform)

Performs an update transformation against the Records in the stream.

This is a terminal operation.

Parameters:

transform - the transformation to perform

mutateThen

Stream<Tuple<Record<K>,Record<K>>> mutateThen(UpdateOperation<? super K> transform)

Performs an update transformation against the Records in the stream.

This is an intermediate operation.

Parameters:

transform - the transformation to perform

Returns:

a Stream of new Tuples holding before and after Record instances

delete

void delete()

Deletes every Record in the stream.

This is a terminal operation.

deleteThen

Stream<Record<K>> deleteThen()

Deletes every Record in the stream.

This is an intermediate operation.

Returns:

a Stream of the deleted Records

filter

MutableRecordStream<K> filter(Predicate<? super Record<K>> predicate)

Specified by:

filter in interface RecordStream<K extends Comparable<K>>

Specified by:

filter in interface Stream<K extends Comparable<K>>

distinct

MutableRecordStream<K> distinct()

Description copied from interface: RecordStream

Record streams are distinct by definition since they represent the records found within a dataset. Implementations may therefore choose to elide distinct operations from the pipeline.

Specified by:

distinct in interface RecordStream<K extends Comparable<K>>

Specified by:

distinct in interface Stream<K extends Comparable<K>>

Returns:

a distinct stream (possibly the same stream)

sorted

RecordStream<K> sorted()

This method will throw a java.lang.UnsupportedOperationException since records are not Comparable.

Sorting a MutableRecordStream returns a non-mutable RecordStream.

Specified by:

sorted in interface RecordStream<K extends Comparable<K>>

Specified by:

sorted in interface Stream<K extends Comparable<K>>

Returns:

a new, non-mutable RecordStream

See Also:

• RecordStream.sorted(Comparator)

sorted

RecordStream<K> sorted(Comparator<? super Record<K>> comparator)

Returns a RecordStream<K> consisting of the elements of this stream, sorted according to the provided Comparator.

Following are the ways to get a RecordStream<K> with records sorted by the key or sorted by the value of a cell.

 RecordStream<String> keySortedRecordStream = recordStream.sorted(Record.<K>keyFunction().asComparator());
 RecordStream<String> cellSortedRecordStream = recordStream.sorted(NAME.valueOr("").asComparator());
 

Sorting a MutableRecordStream returns a non-mutable RecordStream.

Specified by:

sorted in interface RecordStream<K extends Comparable<K>>

Specified by:

sorted in interface Stream<K extends Comparable<K>>

Parameters:

comparator - used to compare Records in the stream

Returns:

a new, non-mutable RecordStream

peek

MutableRecordStream<K> peek(Consumer<? super Record<K>> action)

Specified by:

peek in interface RecordStream<K extends Comparable<K>>

Specified by:

peek in interface Stream<K extends Comparable<K>>

limit

MutableRecordStream<K> limit(long maxSize)

Specified by:

limit in interface RecordStream<K extends Comparable<K>>

Specified by:

limit in interface Stream<K extends Comparable<K>>

skip

MutableRecordStream<K> skip(long n)

Specified by:

skip in interface RecordStream<K extends Comparable<K>>

Specified by:

skip in interface Stream<K extends Comparable<K>>

sequential

MutableRecordStream<K> sequential()

Specified by:

sequential in interface BaseStream<Record<K extends Comparable<K>>,Stream<Record<K extends Comparable<K>>>>

Specified by:

sequential in interface RecordStream<K extends Comparable<K>>

parallel

MutableRecordStream<K> parallel()

Specified by:

parallel in interface BaseStream<Record<K extends Comparable<K>>,Stream<Record<K extends Comparable<K>>>>

Specified by:

parallel in interface RecordStream<K extends Comparable<K>>

unordered

MutableRecordStream<K> unordered()

Specified by:

unordered in interface BaseStream<Record<K extends Comparable<K>>,Stream<Record<K extends Comparable<K>>>>

Specified by:

unordered in interface RecordStream<K extends Comparable<K>>

onClose

MutableRecordStream<K> onClose(Runnable closeHandler)

Specified by:

onClose in interface BaseStream<Record<K extends Comparable<K>>,Stream<Record<K extends Comparable<K>>>>

Specified by:

onClose in interface RecordStream<K extends Comparable<K>>

explain

MutableRecordStream<K> explain(Consumer<Object> consumer)

Description copied from interface: RecordStream

Observes the stream pipeline and provides the pre-execution analysis information for this stream pipeline.

A typical sample usage is given below.

 try (RecordStream<String> testStream = dataset.records()) {
   long count = testStream.explain(System.out::println).filter(...).count();
 }
 

Implementations may not call the consumer until after the stream has closed. Care must therefore be taken to avoid deadlocking stream processing by blocking the stream on waiting for the consumer to be called.

Specified by:

explain in interface RecordStream<K extends Comparable<K>>

Parameters:

consumer - Consumer that is passed an explanation of the stream execution plan

Returns:

this RecordStream<K>

batch

MutableRecordStream<K> batch(int sizeHint)

Description copied from interface: RecordStream

Returns an equivalent stream that uses the given batch size hint.

Stream executions will attempt (when possible) to optimize execution by transferring multiple elements over the network at one time. The size hint provided here will be used as a hint to the batch sizes to use when transferring elements.

Specified by:

batch in interface RecordStream<K extends Comparable<K>>

Returns:

this RecordStream<K>

inline

MutableRecordStream<K> inline()

Description copied from interface: RecordStream

Returns an equivalent stream where any client side operations are performed inline with the server side.

Inline execution runs the client side portion of a pipeline synchronously during the server side processing. This means that until the client side portion of the stream pipeline has finished executing the server stream will not advance to process the next element.

Unlike RecordStream.batch(int) this operation is an edict and not a hint. This means marking a stream as inline overrides any previous or future batching instruction.

Specified by:

inline in interface RecordStream<K extends Comparable<K>>

Returns:

this RecordStream<K>

See Also:

• RecordStream.batch(int)