-
Notifications
You must be signed in to change notification settings - Fork 35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Discard Stream cache and expose StreamSupplier #342
Merged
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
3bd9115
Discard Stream cache and expose StreamSupplier
julgus cca9a31
Fix typo in Javadoc
julgus 824f9c7
Make StreamSupplier extend AutoCloseable
julgus 2c3352e
Remove StreamSupplier cache
julgus a72c594
Merge branch 'stream-supplier' of github.com:speedment/jpa-streamer i…
julgus 67007e4
Fix typo in Javadoc
julgus ae168f2
Remove unused import
julgus 156834a
Only print close warning once
julgus 603ba9a
Remove 'throws exception'
julgus 75fd605
Update documentation for StreamSupplier
julgus 98f85f9
Remove method cached()
julgus d433a19
Add dependency on application
julgus File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
141 changes: 141 additions & 0 deletions
141
application/src/main/java/com/speedment/jpastreamer/application/StreamSupplier.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| package com.speedment.jpastreamer.application; | ||
|
|
||
| import com.speedment.jpastreamer.streamconfiguration.StreamConfiguration; | ||
|
|
||
| import java.util.stream.Stream; | ||
|
|
||
| /** | ||
| * A Stream Supplier is responsible for creating Streams from a data source | ||
| * An entity source can be RDBMSes, files or other data sources. | ||
| * | ||
| * A Stream Supplier must be thread safe and be able to handle several reading and | ||
| * writing threads at the same time. | ||
| * | ||
| * @author Per Minborg, Julia Gustafsson | ||
| * @since 3.0.1 | ||
| */ | ||
| public interface StreamSupplier<T> extends AutoCloseable { | ||
|
|
||
| /** | ||
| * Creates and returns a new {@link Stream} over all entities in the | ||
| * underlying data source (e.g database) according to the {@code streamConfiguration} associated with this Streamer. | ||
| * <p> | ||
| * The order in which elements are returned when the stream is eventually | ||
| * consumed <em>is unspecified</em>. The order may even change from one | ||
| * invocation to another. Thus, it is an error to assume any particular | ||
| * element order even though is might appear, for some stream sources, that | ||
| * there is a de-facto order. | ||
| * <p> | ||
| * If a deterministic order is required, then make sure to invoke the | ||
| * {@link Stream#sorted(java.util.Comparator)} method on the {@link Stream} | ||
| * returned. | ||
| * <p> | ||
| * Mutable elements are not reused within the stream. More formally, there | ||
| * are no pair of mutable stream elements <code>e1</code> and | ||
| * <code>e2</code> such that <code>e1 == e2</code>. | ||
| * <p> | ||
| * The Stream will never contain <code>null</code> elements. | ||
| * <p> | ||
| * This is <em>an inexpensive O(1) operation</em> that will complete in | ||
| * constant time regardless of the number of entities in the underlying | ||
| * database. | ||
| * <p> | ||
| * The returned stream is aware of its own pipeline and will optionally | ||
| * <em>optimize its own pipeline</em> whenever it encounters a <em>Terminal | ||
| * Operation</em> so that it will only iterate over a minimum set of | ||
| * matching entities. | ||
| * <p> | ||
| * When a Terminal Operation is eventually called on the {@link Stream}, | ||
| * that execution time of the Terminal Operation will depend on the | ||
| * optimized pipeline and the entities in the underlying database. | ||
| * <p> | ||
| * The Stream will be automatically | ||
| * {@link Stream#onClose(java.lang.Runnable) closed} after the Terminal | ||
| * Operation is completed or if an Exception is thrown during the Terminal | ||
| * Operation. | ||
| * <p> | ||
| * | ||
| * Some of the <em>Terminal Operations</em> are: | ||
| * <ul> | ||
| * <li>{@link Stream#forEach(java.util.function.Consumer) forEach(Consumer)} | ||
| * <li>{@link Stream#forEachOrdered(java.util.function.Consumer) forEachOrdered(Consumer)} | ||
| * <li>{@link Stream#toArray() toArray()} | ||
| * <li>{@link Stream#toArray(java.util.function.IntFunction) toArray(IntFunction)} | ||
| * <li>{@link Stream#reduce(java.util.function.BinaryOperator) reduce(BinaryOperation} | ||
| * <li>{@link Stream#reduce(java.lang.Object, java.util.function.BinaryOperator) reduce(Object, BinaryOperator)} | ||
| * <li>{@link Stream#reduce(java.lang.Object, java.util.function.BiFunction, java.util.function.BinaryOperator) reduce(Object, BiFunction, BinaryOperator)} | ||
| * <li>{@link Stream#collect(java.util.stream.Collector) collect(Collector)} | ||
| * <li>{@link Stream#collect(java.util.function.Supplier, java.util.function.BiConsumer, java.util.function.BiConsumer) collect(Supplier, BiConsumer, BiConsumer)} | ||
| * <li>{@link Stream#min(java.util.Comparator) min(Comparator)} | ||
| * <li>{@link Stream#max(java.util.Comparator) min(Comparator)} | ||
| * <li>{@link Stream#count() count()} | ||
| * <li>{@link Stream#anyMatch(java.util.function.Predicate) anyMatch(Predicate)} | ||
| * <li>{@link Stream#noneMatch(java.util.function.Predicate) noneMatch(Predicate)} | ||
| * <li>{@link Stream#findFirst() findFirst()} | ||
| * <li>{@link Stream#findAny() findAny()} | ||
| * <li>{@link Stream#iterator() iterator()} | ||
| * </ul> | ||
| * <p> | ||
| * Any Terminating Operation may throw an Exception if the | ||
| * underlying database throws an Exception (e.g. an SqlException) | ||
| * <p> | ||
| * Because the Stream may short-circuit operations in the Stream pipeline, | ||
| * methods having side-effects (like | ||
| * {@link Stream#peek(java.util.function.Consumer) peek(Consumer)} will | ||
| * potentially be affected by the optimization. | ||
| * <p> | ||
| * Here are some examples of how the stream optimization might work: | ||
| * <ul> | ||
| * <li> | ||
| * <pre>{@code stream(Film.class) | ||
| * .filter(Film$.name.equal("Casablanca")) | ||
| * .collect(toList());}</pre> | ||
| * <pre>{@code -> select * from film where name='Casablanca'}</pre> | ||
| * </li> | ||
| * <li> | ||
| * <pre>{@code stream.count();}</pre> | ||
| * <pre>{@code -> select count(*) from film}</pre> | ||
| * </li> | ||
| * <li> | ||
| * <pre>{@code stream(Film.class) | ||
| * .filter(Film$.name.startsWith("A")) | ||
| * .count();}</pre> | ||
| * <pre>{@code -> select count(*) from hares where | ||
| * name LIKE 'A%'}</pre> | ||
| * <p> | ||
| * </li> | ||
| * <li> | ||
| * <pre>{@code stream.stream(Film.class) | ||
| * .filter(Film$.rating.equal("G") | ||
| * .filter(Film$.length.greaterThan(100) | ||
| * .count();}</pre> | ||
| * <pre>{@code -> select count(*) from hares where | ||
| * rating ='G' | ||
| * and | ||
| * length > 100}</pre> | ||
| * </li> | ||
| * </ul> | ||
| * | ||
| * @return a new stream over all entities in this table in unspecified order | ||
| * | ||
| * @throws RuntimeException if an error occurs during a Terminal Operation | ||
| * (e.g. an SqlException is thrown by the underlying database) | ||
| * | ||
| * @see java.util.stream | ||
| * @see Stream | ||
| */ | ||
| Stream<T> stream(); | ||
|
|
||
| /** | ||
| * Closes this Stream Supplier and releases any resources potentially held, such as the underlying Entity Manager. | ||
| */ | ||
| void close(); | ||
|
|
||
| /** | ||
| * Returns the {@link StreamConfiguration} that describes the stream source of the Streams generated by this Supplier. | ||
| * | ||
| * @return the configuration of the Streams generated by this Supplier | ||
| */ | ||
| StreamConfiguration<T> configuration(); | ||
|
|
||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think using Try-With-Resources would be better here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could I provide both examples? I just think this way is clearer, but I totally get that TWR is a better practice.