Package org.hcjf.layers.query

Class ResultSet<O>

  • All Implemented Interfaces:
    java.lang.Iterable<O>, java.util.Collection<O>
    public class ResultSet<O>
extends java.lang.Object
implements java.util.Collection<O>
    Collect all the information about query execution.

    • Constructor Summary

      Constructors 
      Constructor Description
      ResultSet​(java.lang.Long totalTime, java.lang.Long timeCollectingData, java.lang.Long timeEvaluatingConditions, java.lang.Long averageTimeEvaluatingConditionsByRow, java.lang.Long timeFormattingData, java.lang.Long averageTimeFormattingDataByRow, java.lang.Long timeAggregatingData, java.util.Collection<java.lang.String> presentFields, java.util.Collection<O> instance)  

    • Method Summary

      Modifier and Type Method Description
      boolean add​(O o)
      Ensures that this collection contains the specified element (optional operation).
      boolean addAll​(java.util.Collection<? extends O> c)
      Adds all of the elements in the specified collection to this collection (optional operation).
      void clear()
      Removes all of the elements from this collection (optional operation).
      boolean contains​(java.lang.Object o)
      Returns true if this collection contains the specified element.
      boolean containsAll​(java.util.Collection<?> c)
      Returns true if this collection contains all of the elements in the specified collection.
      boolean equals​(java.lang.Object o)
      Compares the specified object with this collection for equality.
      void forEach​(java.util.function.Consumer<? super O> action)
      Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception.
      java.lang.Long getAverageTimeEvaluatingConditionsByRow()
      Returns the average time that the execution take to evaluate each row.
      java.lang.Long getAverageTimeFormattingDataByRow()
      Returns the average time that the execution takes to format each row.
      java.util.Collection<java.lang.String> getPresentFields()
      Returns the set of fields presents into the result set.
      java.lang.Long getTimeAggregatingData()
      Returns the time that the execution takes to evaluate the set of aggregate functions
      java.lang.Long getTimeCollectingData()
      Returns the time that the execution takes to collect the data of the different data sources.
      java.lang.Long getTimeCompilingQuery()
      Time to compile the query.
      java.lang.Long getTimeEvaluatingConditions()
      Returns the time that the execution takes to evaluate the conditions.
      java.lang.Long getTimeFormattingData()
      Returns the time that the executions takes to format the data.
      java.lang.Long getTotalTime()
      Returns the total time of the query execution.
      int hashCode()
      Returns the hash code value for this collection.
      boolean isEmpty()
      Returns true if this collection contains no elements.
      java.util.Iterator<O> iterator()
      Returns an iterator over the elements in this collection.
      java.util.stream.Stream<O> parallelStream()
      Returns a possibly parallel Stream with this collection as its source.
      boolean remove​(java.lang.Object o)
      Removes a single instance of the specified element from this collection, if it is present (optional operation).
      boolean removeAll​(java.util.Collection<?> c)
      Removes all of this collection's elements that are also contained in the specified collection (optional operation).
      boolean removeIf​(java.util.function.Predicate<? super O> filter)
      Removes all of the elements of this collection that satisfy the given predicate.
      boolean retainAll​(java.util.Collection<?> c)
      Retains only the elements in this collection that are contained in the specified collection (optional operation).
      void setTimeCompilingQuery​(java.lang.Long timeCompilingQuery)
      Set the time to take the engine to compile a query.
      int size()
      Returns the number of elements in this collection.
      java.util.Spliterator<O> spliterator()
      Creates a Spliterator over the elements in this collection.
      java.util.stream.Stream<O> stream()
      Returns a sequential Stream with this collection as its source.
      java.lang.Object[] toArray()
      Returns an array containing all of the elements in this collection.
      <T> T[] toArray​(java.util.function.IntFunction<T[]> generator)
      Returns an array containing all of the elements in this collection, using the provided generator function to allocate the returned array.
      <T> T[] toArray​(T[] a)
      Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ResultSet

        public ResultSet​(java.lang.Long totalTime,
                 java.lang.Long timeCollectingData,
                 java.lang.Long timeEvaluatingConditions,
                 java.lang.Long averageTimeEvaluatingConditionsByRow,
                 java.lang.Long timeFormattingData,
                 java.lang.Long averageTimeFormattingDataByRow,
                 java.lang.Long timeAggregatingData,
                 java.util.Collection<java.lang.String> presentFields,
                 java.util.Collection<O> instance)

    • Method Detail

      • getTotalTime

        public java.lang.Long getTotalTime()
        Returns the total time of the query execution.
        Returns:
        Total time of the query execution.

      • getTimeCompilingQuery

        public java.lang.Long getTimeCompilingQuery()
        Time to compile the query.
        Returns:
        Time compiling the query.

      • setTimeCompilingQuery

        public void setTimeCompilingQuery​(java.lang.Long timeCompilingQuery)
        Set the time to take the engine to compile a query.
        Parameters:
        timeCompilingQuery - Time compiling query.

      • getTimeCollectingData

        public java.lang.Long getTimeCollectingData()
        Returns the time that the execution takes to collect the data of the different data sources.
        Returns:
        Time collection data.

      • getTimeEvaluatingConditions

        public java.lang.Long getTimeEvaluatingConditions()
        Returns the time that the execution takes to evaluate the conditions.
        Returns:
        Time evaluating conditions.

      • getAverageTimeEvaluatingConditionsByRow

        public java.lang.Long getAverageTimeEvaluatingConditionsByRow()
        Returns the average time that the execution take to evaluate each row.
        Returns:
        Average time evaluating conditions by row.

      • getTimeFormattingData

        public java.lang.Long getTimeFormattingData()
        Returns the time that the executions takes to format the data.
        Returns:
        Time formatting data.

      • getTimeAggregatingData

        public java.lang.Long getTimeAggregatingData()
        Returns the time that the execution takes to evaluate the set of aggregate functions
        Returns:
        Time aggregating data.

      • getAverageTimeFormattingDataByRow

        public java.lang.Long getAverageTimeFormattingDataByRow()
        Returns the average time that the execution takes to format each row.
        Returns:
        Average time formatting row.

      • getPresentFields

        public java.util.Collection<java.lang.String> getPresentFields()
        Returns the set of fields presents into the result set.
        Returns:
        Fields present set.

      • size

        public int size()
        Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
        Specified by:
        size in interface java.util.Collection<O>
        Returns:
        the number of elements in this collection

      • isEmpty

        public boolean isEmpty()
        Returns true if this collection contains no elements.
        Specified by:
        isEmpty in interface java.util.Collection<O>
        Returns:
        true if this collection contains no elements

      • contains

        public boolean contains​(java.lang.Object o)
        Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that Objects.equals(o, e).
        Specified by:
        contains in interface java.util.Collection<O>
        Parameters:
        o - element whose presence in this collection is to be tested
        Returns:
        true if this collection contains the specified element
        Throws:
        java.lang.ClassCastException - if the type of the specified element is incompatible with this collection (optional)
        java.lang.NullPointerException - if the specified element is null and this collection does not permit null elements (optional)

      • iterator

        public java.util.Iterator<O> iterator()
        Returns an iterator over the elements in this collection. There are no guarantees concerning the order in which the elements are returned (unless this collection is an instance of some class that provides a guarantee).
        Specified by:
        iterator in interface java.util.Collection<O>
        Specified by:
        iterator in interface java.lang.Iterable<O>
        Returns:
        an Iterator over the elements in this collection

      • toArray

        public java.lang.Object[] toArray()
        Returns an array containing all of the elements in this collection. If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array's runtime component type is Object.

        The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.

        Specified by:
        toArray in interface java.util.Collection<O>
        Returns:
        an array, whose runtime component type is Object, containing all of the elements in this collection

      • toArray

        public <T> T[] toArray​(T[] a)
        Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection.

        If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is set to null. (This is useful in determining the length of this collection only if the caller knows that this collection does not contain any null elements.)

        If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

        Specified by:
        toArray in interface java.util.Collection<O>
        Parameters:
        a - the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
        Returns:
        an array containing all of the elements in this collection
        Throws:
        java.lang.ArrayStoreException - if the runtime type of any element in this collection is not assignable to the runtime component type of the specified array
        java.lang.NullPointerException - if the specified array is null

      • toArray

        public <T> T[] toArray​(java.util.function.IntFunction<T[]> generator)
        Returns an array containing all of the elements in this collection, using the provided generator function to allocate the returned array.

        If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

        Specified by:
        toArray in interface java.util.Collection<O>
        Parameters:
        generator - a function which produces a new array of the desired type and the provided length
        Returns:
        an array containing all of the elements in this collection
        Throws:
        java.lang.ArrayStoreException - if the runtime type of any element in this collection is not assignable to the runtime component type of the generated array
        java.lang.NullPointerException - if the generator function is null
        Since:
        11

      • add

        public boolean add​(O o)
        Ensures that this collection contains the specified element (optional operation). Returns true if this collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.)

        Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.

        If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

        Specified by:
        add in interface java.util.Collection<O>
        Parameters:
        o - element whose presence in this collection is to be ensured
        Returns:
        true if this collection changed as a result of the call
        Throws:
        java.lang.UnsupportedOperationException - if the add operation is not supported by this collection
        java.lang.ClassCastException - if the class of the specified element prevents it from being added to this collection
        java.lang.NullPointerException - if the specified element is null and this collection does not permit null elements
        java.lang.IllegalArgumentException - if some property of the element prevents it from being added to this collection
        java.lang.IllegalStateException - if the element cannot be added at this time due to insertion restrictions

      • remove

        public boolean remove​(java.lang.Object o)
        Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).
        Specified by:
        remove in interface java.util.Collection<O>
        Parameters:
        o - element to be removed from this collection, if present
        Returns:
        true if an element was removed as a result of this call
        Throws:
        java.lang.ClassCastException - if the type of the specified element is incompatible with this collection (optional)
        java.lang.NullPointerException - if the specified element is null and this collection does not permit null elements (optional)
        java.lang.UnsupportedOperationException - if the remove operation is not supported by this collection

      • containsAll

        public boolean containsAll​(java.util.Collection<?> c)
        Returns true if this collection contains all of the elements in the specified collection.
        Specified by:
        containsAll in interface java.util.Collection<O>
        Parameters:
        c - collection to be checked for containment in this collection
        Returns:
        true if this collection contains all of the elements in the specified collection
        Throws:
        java.lang.ClassCastException - if the types of one or more elements in the specified collection are incompatible with this collection (optional)
        java.lang.NullPointerException - if the specified collection contains one or more null elements and this collection does not permit null elements (optional), or if the specified collection is null.
        See Also:
        contains(Object)

      • addAll

        public boolean addAll​(java.util.Collection<? extends O> c)
        Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)
        Specified by:
        addAll in interface java.util.Collection<O>
        Parameters:
        c - collection containing elements to be added to this collection
        Returns:
        true if this collection changed as a result of the call
        Throws:
        java.lang.UnsupportedOperationException - if the addAll operation is not supported by this collection
        java.lang.ClassCastException - if the class of an element of the specified collection prevents it from being added to this collection
        java.lang.NullPointerException - if the specified collection contains a null element and this collection does not permit null elements, or if the specified collection is null
        java.lang.IllegalArgumentException - if some property of an element of the specified collection prevents it from being added to this collection
        java.lang.IllegalStateException - if not all the elements can be added at this time due to insertion restrictions
        See Also:
        add(Object)

      • removeAll

        public boolean removeAll​(java.util.Collection<?> c)
        Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.
        Specified by:
        removeAll in interface java.util.Collection<O>
        Parameters:
        c - collection containing elements to be removed from this collection
        Returns:
        true if this collection changed as a result of the call
        Throws:
        java.lang.UnsupportedOperationException - if the removeAll method is not supported by this collection
        java.lang.ClassCastException - if the types of one or more elements in this collection are incompatible with the specified collection (optional)
        java.lang.NullPointerException - if this collection contains one or more null elements and the specified collection does not support null elements (optional), or if the specified collection is null
        See Also:
        remove(Object), contains(Object)

      • removeIf

        public boolean removeIf​(java.util.function.Predicate<? super O> filter)
        Removes all of the elements of this collection that satisfy the given predicate. Errors or runtime exceptions thrown during iteration or by the predicate are relayed to the caller.
        Specified by:
        removeIf in interface java.util.Collection<O>
        Parameters:
        filter - a predicate which returns true for elements to be removed
        Returns:
        true if any elements were removed
        Throws:
        java.lang.NullPointerException - if the specified filter is null
        java.lang.UnsupportedOperationException - if elements cannot be removed from this collection. Implementations may throw this exception if a matching element cannot be removed or if, in general, removal is not supported.
        Since:
        1.8

      • retainAll

        public boolean retainAll​(java.util.Collection<?> c)
        Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.
        Specified by:
        retainAll in interface java.util.Collection<O>
        Parameters:
        c - collection containing elements to be retained in this collection
        Returns:
        true if this collection changed as a result of the call
        Throws:
        java.lang.UnsupportedOperationException - if the retainAll operation is not supported by this collection
        java.lang.ClassCastException - if the types of one or more elements in this collection are incompatible with the specified collection (optional)
        java.lang.NullPointerException - if this collection contains one or more null elements and the specified collection does not permit null elements (optional), or if the specified collection is null
        See Also:
        remove(Object), contains(Object)

      • clear

        public void clear()
        Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.
        Specified by:
        clear in interface java.util.Collection<O>
        Throws:
        java.lang.UnsupportedOperationException - if the clear operation is not supported by this collection

      • equals

        public boolean equals​(java.lang.Object o)
        Compares the specified object with this collection for equality.

        While the Collection interface adds no stipulations to the general contract for the Object.equals, programmers who implement the Collection interface "directly" (in other words, create a class that is a Collection but is not a Set or a List) must exercise care if they choose to override the Object.equals. It is not necessary to do so, and the simplest course of action is to rely on Object's implementation, but the implementor may wish to implement a "value comparison" in place of the default "reference comparison." (The List and Set interfaces mandate such value comparisons.)

        The general contract for the Object.equals method states that equals must be symmetric (in other words, a.equals(b) if and only if b.equals(a)). The contracts for List.equals and Set.equals state that lists are only equal to other lists, and sets to other sets. Thus, a custom equals method for a collection class that implements neither the List nor Set interface must return false when this collection is compared to any list or set. (By the same logic, it is not possible to write a class that correctly implements both the Set and List interfaces.)

        Specified by:
        equals in interface java.util.Collection<O>
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - object to be compared for equality with this collection
        Returns:
        true if the specified object is equal to this collection
        See Also:
        Object.equals(Object), Set#equals(Object), List#equals(Object)

      • hashCode

        public int hashCode()
        Returns the hash code value for this collection. While the Collection interface adds no stipulations to the general contract for the Object.hashCode method, programmers should take note that any class that overrides the Object.equals method must also override the Object.hashCode method in order to satisfy the general contract for the Object.hashCode method. In particular, c1.equals(c2) implies that c1.hashCode()==c2.hashCode().
        Specified by:
        hashCode in interface java.util.Collection<O>
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        the hash code value for this collection
        See Also:
        Object.hashCode(), Object.equals(Object)

      • spliterator

        public java.util.Spliterator<O> spliterator()
        Creates a Spliterator over the elements in this collection. Implementations should document characteristic values reported by the spliterator. Such characteristic values are not required to be reported if the spliterator reports Spliterator.SIZED and this collection contains no elements.

        The default implementation should be overridden by subclasses that can return a more efficient spliterator. In order to preserve expected laziness behavior for the stream() and parallelStream() methods, spliterators should either have the characteristic of IMMUTABLE or CONCURRENT, or be late-binding. If none of these is practical, the overriding class should describe the spliterator's documented policy of binding and structural interference, and should override the stream() and parallelStream() methods to create streams using a Supplier of the spliterator, as in: 

        
     Stream<E> s = StreamSupport.stream(() -> spliterator(), spliteratorCharacteristics)

        These requirements ensure that streams produced by the stream() and parallelStream() methods will reflect the contents of the collection as of initiation of the terminal stream operation.

        Specified by:
        spliterator in interface java.util.Collection<O>
        Specified by:
        spliterator in interface java.lang.Iterable<O>
        Returns:
        a Spliterator over the elements in this collection
        Since:
        1.8

      • stream

        public java.util.stream.Stream<O> stream()
        Returns a sequential Stream with this collection as its source.

        This method should be overridden when the spliterator() method cannot return a spliterator that is IMMUTABLE, CONCURRENT, or late-binding. (See spliterator() for details.)

        Specified by:
        stream in interface java.util.Collection<O>
        Returns:
        a sequential Stream over the elements in this collection
        Since:
        1.8

      • parallelStream

        public java.util.stream.Stream<O> parallelStream()
        Returns a possibly parallel Stream with this collection as its source. It is allowable for this method to return a sequential stream.

        This method should be overridden when the spliterator() method cannot return a spliterator that is IMMUTABLE, CONCURRENT, or late-binding. (See spliterator() for details.)

        Specified by:
        parallelStream in interface java.util.Collection<O>
        Returns:
        a possibly parallel Stream over the elements in this collection
        Since:
        1.8

      • forEach

        public void forEach​(java.util.function.Consumer<? super O> action)
        Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller.

        The behavior of this method is unspecified if the action performs side-effects that modify the underlying source of elements, unless an overriding class has specified a concurrent modification policy.

        Specified by:
        forEach in interface java.lang.Iterable<O>
        Parameters:
        action - The action to be performed for each element
        Throws:
        java.lang.NullPointerException - if the specified action is null
        Since:
        1.8