Package org.ktorm.entity
Provides entity sequence APIs.
Types
Name | Summary |
---|---|
interface Entity<E : Entity<E>> : Serializable The super interface of all entity classes in Ktorm. This interface injects many useful functions into entities. | |
class EntityExtensionsApi Entity extension APIs. | |
Wraps an EntitySequence with a keySelector function, which can be applied to each record to get its key, | |
Represents a sequence of entity objects. As the name implies, the style and use pattern of Ktorm’s entity sequence |
Functions
Name | Summary |
---|---|
Insert the given entity into this sequence and return the affected record number. | |
fun <E : Any, K : Any, R> EntityGrouping<E, *, K>.aggregate( Groups elements from the source sequence by key and applies operation to the elements of each group sequentially, | |
fun <E : Any, T : BaseTable<E>, K : Any, C : Any> EntityGrouping<E, T, K>.aggregateColumns( Group elements from the source sequence by key and perform the given aggregation for elements in each group, fun <E : Any, T : BaseTable<E>, C : Any> EntitySequence<E, T>.aggregateColumns( Perform an aggregation given by aggregationSelector for all elements in the sequence, | |
fun <E : Any, T : BaseTable<E>, K : Any, C : Any, M : MutableMap<in K?, in C?>> EntityGrouping<E, T, K>.aggregateColumnsTo( Group elements from the source sequence by key and perform the given aggregation for elements in each group, | |
fun <E : Any, K : Any, R, M : MutableMap<in K?, R>> EntityGrouping<E, *, K>.aggregateTo( Groups elements from the source sequence by key and applies operation to the elements of each group sequentially, | |
fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.all( Return | |
Return fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.any( Return | |
Return a Map containing key-value pairs provided by transform function applied to elements of the given sequence. | |
Return a Map containing the elements from the given sequence indexed by the key returned from keySelector fun <E : Any, K, V> EntitySequence<E, *>.associateBy( Return a Map containing the values provided by valueTransform and indexed by keySelector functions | |
fun <E : Any, K, M : MutableMap<in K, in E>> EntitySequence<E, *>.associateByTo( Populate and return the destination mutable map with key-value pairs, where key is provided by the keySelector fun <E : Any, K, V, M : MutableMap<in K, in V>> EntitySequence<E, *>.associateByTo( Populate and return the destination mutable map with key-value pairs, where key is provided by the keySelector | |
fun <E : Any, K, V, M : MutableMap<in K, in V>> EntitySequence<E, *>.associateTo( Populate and return the destination mutable map with key-value pairs provided by transform function applied | |
Return a Map where keys are elements from the given sequence and values are produced by the valueSelector | |
fun <K : Entity<K>, V, M : MutableMap<in K, in V>> EntitySequence<K, *>.associateWithTo( Populate and return the destination mutable map with key-value pairs for each element of the given sequence, | |
fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.averageBy( Return the average value of the column given by selector in this sequence. | |
Remove all the elements of this sequence. The sequence will be empty after this function returns. | |
Return the number of elements in this sequence. fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.count( Return the number of elements matching the given predicate. | |
fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.drop( Returns a sequence containing all elements except first n elements. | |
fun <E : Any, T : BaseTable<E>, K : Any> EntityGrouping<E, T, K>.eachAverageBy( Group elements from the source sequence by key and average the columns or expressions provided by the | |
fun <E : Any, T : BaseTable<E>, K : Any, M : MutableMap<in K?, in Double?>> EntityGrouping<E, T, K>.eachAverageByTo( Group elements from the source sequence by key and average the columns or expressions provided by the | |
Group elements from the source sequence by key and count elements in each group. | |
fun <E : Any, T : BaseTable<E>, K : Any, M : MutableMap<in K?, Int>> EntityGrouping<E, T, K>.eachCountTo( Group elements from the source sequence by key and count elements in each group, | |
fun <E : Any, T : BaseTable<E>, K : Any, C : Comparable<C>> EntityGrouping<E, T, K>.eachMaxBy( Group elements from the source sequence by key and get the max value of the columns or expressions provided by the | |
fun <E : Any, T : BaseTable<E>, K : Any, C : Comparable<C>, M : MutableMap<in K?, in C?>> EntityGrouping<E, T, K>.eachMaxByTo( Group elements from the source sequence by key and get the max value of the columns or expressions provided by the | |
fun <E : Any, T : BaseTable<E>, K : Any, C : Comparable<C>> EntityGrouping<E, T, K>.eachMinBy( Group elements from the source sequence by key and get the min value of the columns or expressions provided by the | |
fun <E : Any, T : BaseTable<E>, K : Any, C : Comparable<C>, M : MutableMap<in K?, in C?>> EntityGrouping<E, T, K>.eachMinByTo( Group elements from the source sequence by key and get the min value of the columns or expressions provided by the | |
fun <E : Any, T : BaseTable<E>, K : Any, C : Number> EntityGrouping<E, T, K>.eachSumBy( Group elements from the source sequence by key and sum the columns or expressions provided by the columnSelector | |
fun <E : Any, T : BaseTable<E>, K : Any, C : Number, M : MutableMap<in K?, in C?>> EntityGrouping<E, T, K>.eachSumByTo( Group elements from the source sequence by key and sum the columns or expressions provided by the columnSelector | |
Return an element at the given index or throws an IndexOutOfBoundsException if the index is out of bounds | |
fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.elementAtOrElse( Return an element at the given index or the result of calling the defaultValue function if the index is out | |
Return an element at the given index or | |
fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.filter( Return a sequence containing only elements matching the given predicate. | |
fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.filterColumns( Return a sequence customizing the selected columns of the internal query. | |
fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.filterNot( Return a sequence containing only elements not matching the given predicate. | |
fun <E : Any, T : BaseTable<E>, C : MutableCollection<in E>> EntitySequence<E, T>.filterNotTo( Append all elements not matching the given predicate to the given destination. | |
fun <E : Any, T : BaseTable<E>, C : MutableCollection<in E>> EntitySequence<E, T>.filterTo( Append all elements matching the given predicate to the given destination. | |
fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.find( Return the first element matching the given predicate, or | |
fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.findLast( Return the last element matching the given predicate, or | |
Return the first element, or throws NoSuchElementException if the sequence is empty. fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.first( Return the first element matching the given predicate, or throws NoSuchElementException if element was not found. | |
Return the first element, or fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.firstOrNull( Return the first element matching the given predicate, or | |
Return a single list of all elements yielded from results of transform function being invoked | |
fun <E : Any, R> EntitySequence<E, *>.flatMapIndexed( Return a single list of all elements yielded from results of transform function being invoked | |
fun <E : Any, R, C : MutableCollection<in R>> EntitySequence<E, *>.flatMapIndexedTo( Append all elements yielded from results of transform function being invoked on each element | |
fun <E : Any, R, C : MutableCollection<in R>> EntitySequence<E, *>.flatMapTo( Append all elements yielded from results of transform function being invoked on each element | |
fun <E : Any, K : Any, R> EntityGrouping<E, *, K>.fold( Groups elements from the source sequence by key and applies operation to the elements of each group sequentially, fun <E : Any, K : Any, R> EntityGrouping<E, *, K>.fold( Groups elements from the source sequence by key and applies operation to the elements of each group sequentially, Accumulate value starting with initial value and applying operation from left to right to current accumulator | |
fun <E : Any, R> EntitySequence<E, *>.foldIndexed( Accumulate value starting with initial value and applying operation from left to right to current accumulator | |
fun <E : Any, K : Any, R, M : MutableMap<in K?, R>> EntityGrouping<E, *, K>.foldTo( Groups elements from the source sequence by key and applies operation to the elements of each group sequentially, fun <E : Any, K : Any, R, M : MutableMap<in K?, R>> EntityGrouping<E, *, K>.foldTo( Groups elements from the source sequence by key and applies operation to the elements of each group sequentially, | |
Perform the given action on each element. | |
Perform the given action on each element, providing sequential index with the element. | |
Group elements of the original sequence by the key returned by the given keySelector function applied to each fun <E : Any, K, V> EntitySequence<E, *>.groupBy( Group values returned by the valueTransform function applied to each element of the original sequence by the key | |
fun <E : Any, K, M : MutableMap<in K, MutableList<E>>> EntitySequence<E, *>.groupByTo( Group elements of the original sequence by the key returned by the given keySelector function applied to each fun <E : Any, K, V, M : MutableMap<in K, MutableList<V>>> EntitySequence<E, *>.groupByTo( Group values returned by the valueTransform function applied to each element of the original sequence by the key | |
fun <E : Any, T : BaseTable<E>, K : Any> EntitySequence<E, T>.groupingBy( Create an EntityGrouping from the sequence to be used later with one of group-and-fold operations. | |
Return | |
Return | |
fun <E : Any, A : Appendable> EntitySequence<E, *>.joinTo( Append the string from all the elements separated using separator and using the given prefix and postfix. | |
fun <E : Any> EntitySequence<E, *>.joinToString( Create a string from all the elements separated using separator and using the given prefix and postfix. | |
fun <E : Any> EntitySequence<E, *>.last(): E Return the last element, or throws NoSuchElementException if the sequence is empty. fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.last( Return the last element matching the given predicate, or throws NoSuchElementException if no such element found. | |
fun <E : Any> EntitySequence<E, *>.lastOrNull(): E? Return the last element, or fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.lastOrNull( Return the last element matching the given predicate, or | |
Return a List containing the results of applying the given transform function | |
fun <E : Any, T : BaseTable<E>, C : Any> EntitySequence<E, T>.mapColumns( Customize the selected columns of the internal query by the given columnSelector function, and return a List | |
fun <E : Any, T : BaseTable<E>, C : Any> EntitySequence<E, T>.mapColumnsNotNull( Customize the selected columns of the internal query by the given columnSelector function, and return a List | |
fun <E : Any, T : BaseTable<E>, C : Any, R : MutableCollection<in C>> EntitySequence<E, T>.mapColumnsNotNullTo( Customize the selected columns of the internal query by the given columnSelector function, and append non-null | |
fun <E : Any, T : BaseTable<E>, C : Any, R : MutableCollection<in C?>> EntitySequence<E, T>.mapColumnsTo( Customize the selected columns of the internal query by the given columnSelector function, and append the query | |
Return a List containing the results of applying the given transform function | |
fun <E : Any, R : Any> EntitySequence<E, *>.mapIndexedNotNull( Return a List containing only the non-null results of applying the given transform function | |
fun <E : Any, R : Any, C : MutableCollection<in R>> EntitySequence<E, *>.mapIndexedNotNullTo( Apply the given transform function to each element and its index in the original sequence | |
fun <E : Any, R, C : MutableCollection<in R>> EntitySequence<E, *>.mapIndexedTo( Apply the given transform function to each element and its index in the original sequence | |
Return a List containing only the non-null results of applying the given transform function | |
fun <E : Any, R : Any, C : MutableCollection<in R>> EntitySequence<E, *>.mapNotNullTo( Apply the given transform function to each element in the original sequence | |
fun <E : Any, R, C : MutableCollection<in R>> EntitySequence<E, *>.mapTo( Apply the given transform function to each element of the original sequence | |
fun <E : Any, T : BaseTable<E>, C : Comparable<C>> EntitySequence<E, T>.maxBy( Return the max value of the column given by selector in this sequence. | |
fun <E : Any, T : BaseTable<E>, C : Comparable<C>> EntitySequence<E, T>.minBy( Return the min value of the column given by selector in this sequence. | |
Return fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.none( Return | |
fun <E : Any, K : Any> EntityGrouping<E, *, K>.reduce( Groups elements from the source sequence by key and applies the reducing operation to the elements of each group Accumulate value starting with the first element and applying operation from left to right to current accumulator | |
Accumulate value starting with the first element and applying operation from left to right to current accumulator | |
fun <E : Any> EntitySequence<E, *>.reduceIndexedOrNull( Accumulate value starting with the first element and applying operation from left to right to current accumulator | |
Accumulate value starting with the first element and applying operation from left to right to current accumulator | |
fun <E : Any, K : Any, M : MutableMap<in K?, E>> EntityGrouping<E, *, K>.reduceTo( Groups elements from the source sequence by key and applies the reducing operation to the elements of each group | |
fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.removeIf( Remove all the elements of this sequence that satisfy the given predicate. | |
fun <E : Any, T : BaseTable<E>> Database.sequenceOf( Create an EntitySequence from the specific table. | |
Return the single element, or throws an exception if the sequence is empty or has more than one element. fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.single( Return the single element matching the given predicate, or throws exception if there is no or more than one | |
Return single element, or fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.singleOrNull( Return the single element matching the given predicate, or | |
fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.sortedBy( Return a sequence sorting elements by multiple columns, in ascending or descending order. For example, fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.sortedBy( Return a sequence sorting elements by a column, in ascending or descending order. For example, fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.sortedBy( Return a sequence sorting elements by the specific column in ascending order. | |
fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.sortedByDescending( Return a sequence sorting elements by the specific column in descending order. | |
fun <E : Any, T : BaseTable<E>, C : Number> EntitySequence<E, T>.sumBy( Return the sum of the column given by selector in this sequence. | |
fun <E : Any, T : BaseTable<E>> EntitySequence<E, T>.take( Returns a sequence containing first n elements. | |
fun <E : Any, C : MutableCollection<in E>> EntitySequence<E, *>.toCollection( Append all elements to the given destination collection. | |
fun <E : Any> EntitySequence<E, *>.toHashSet(): HashSet<E> Return a HashSet containing all the elements of this sequence. | |
fun <E : Any> EntitySequence<E, *>.toList(): List<E> Return a List containing all the elements of this sequence. | |
fun <E : Any> EntitySequence<E, *>.toMutableList(): MutableList<E> Return a MutableList containing all the elements of this sequence. | |
fun <E : Any> EntitySequence<E, *>.toMutableSet(): MutableSet<E> Return a MutableSet containing all the elements of this sequence. | |
fun <E : Any> EntitySequence<E, *>.toSet(): Set<E> Return a Set containing all the elements of this sequence. | |
fun <E> EntitySequence<E, *>.toSortedSet(): SortedSet<E> where E : Any, E : Comparable<E> fun <E> EntitySequence<E, *>.toSortedSet( Return a SortedSet containing all the elements of this sequence. | |
Update properties of the given entity to the database and return the affected record number. | |
fun <E : Any> EntitySequence<E, *>.withIndex(): Sequence<IndexedValue<E>> Return a lazy Sequence that wraps each element of the original sequence into an IndexedValue containing |