Package org.apache.pivot.sql

Class ResultList

  • All Implemented Interfaces:
    java.lang.Iterable<Map<java.lang.String,​java.lang.Object>>, Collection<Map<java.lang.String,​java.lang.Object>>, List<Map<java.lang.String,​java.lang.Object>>, Sequence<Map<java.lang.String,​java.lang.Object>>
    public class ResultList
extends java.lang.Object
implements List<Map<java.lang.String,​java.lang.Object>>
    Implementation of the List interface that is backed by a instance of ResultSet.

    Note that this list is not suitable for random access and can only be navigated via an iterator.

    • Constructor Summary

      Constructors 
      Constructor Description
      ResultList​(java.sql.ResultSet resultSet)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int add​(Map<java.lang.String,​java.lang.Object> item)
      Adds an item to the list.
      void clear()
      Removes all elements from the collection.
      Map<java.lang.String,​java.lang.Object> get​(int index)
      Retrieves the item at the given index.
      java.util.Comparator<Map<java.lang.String,​java.lang.Object>> getComparator()
      Returns the collection's sort order.
      Sequence<ResultList.Field> getFields()  
      boolean getIncludeNullValues()  
      int getLength()
      Returns the length of the list.
      ListenerList<ListListener<Map<java.lang.String,​java.lang.Object>>> getListListeners()
      Returns the list listener list.
      java.sql.ResultSet getResultSet()  
      int indexOf​(Map<java.lang.String,​java.lang.Object> item)
      Returns the index of an item in the sequence.
      void insert​(Map<java.lang.String,​java.lang.Object> item, int index)
      Inserts an item into the list.
      boolean isEmpty()
      Tests the emptiness of the collection.
      java.util.Iterator<Map<java.lang.String,​java.lang.Object>> iterator()  
      Sequence<Map<java.lang.String,​java.lang.Object>> remove​(int index, int count)
      Removes one or more items from the sequence.
      int remove​(Map<java.lang.String,​java.lang.Object> item)
      Removes the first occurrence of the given item from the sequence.
      void setComparator​(java.util.Comparator<Map<java.lang.String,​java.lang.Object>> comparator)
      Sets the collection's sort order, re-ordering the collection's contents and ensuring that new entries preserve the sort order.
      void setFields​(Sequence<ResultList.Field> fields)  
      void setFields​(ResultList.Field... fields)  
      void setIncludeNullValues​(boolean includeNullValues)  
      Map<java.lang.String,​java.lang.Object> update​(int index, Map<java.lang.String,​java.lang.Object> item)
      Updates the item at the given index.

      • 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

      • ResultList

        public ResultList​(java.sql.ResultSet resultSet)

    • Method Detail

      • getResultSet

        public java.sql.ResultSet getResultSet()

      • getIncludeNullValues

        public boolean getIncludeNullValues()

      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)

      • add

        @UnsupportedOperation
public int add​(Map<java.lang.String,​java.lang.Object> item)
        Description copied from interface: List
        Adds an item to the list. If the list is unsorted, the item is appended to the end of the list. Otherwise, it is inserted at the appropriate index.
        Specified by:
        add in interface List<Map<java.lang.String,​java.lang.Object>>
        Specified by:
        add in interface Sequence<Map<java.lang.String,​java.lang.Object>>
        Parameters:
        item - The item to be added to the sequence.
        Returns:
        The index at which the item was added.
        See Also:
        ListListener.itemInserted(List, int)

      • insert

        @UnsupportedOperation
public void insert​(Map<java.lang.String,​java.lang.Object> item,
                   int index)
        Description copied from interface: List
        Inserts an item into the list.
        Specified by:
        insert in interface List<Map<java.lang.String,​java.lang.Object>>
        Specified by:
        insert in interface Sequence<Map<java.lang.String,​java.lang.Object>>
        Parameters:
        item - The item to be added to the list.
        index - The index at which the item should be inserted. Must be a value between 0 and getLength().
        See Also:
        ListListener.itemInserted(List, int)

      • update

        @UnsupportedOperation
public Map<java.lang.String,​java.lang.Object> update​(int index,
                                                           Map<java.lang.String,​java.lang.Object> item)
        Description copied from interface: List
        Updates the item at the given index.
        Specified by:
        update in interface List<Map<java.lang.String,​java.lang.Object>>
        Specified by:
        update in interface Sequence<Map<java.lang.String,​java.lang.Object>>
        Parameters:
        index - The index of the item to update.
        item - The item that will replace any existing value at the given index.
        Returns:
        The item that was previously stored at the given index.
        See Also:
        ListListener.itemUpdated(List, int, Object)

      • remove

        @UnsupportedOperation
public int remove​(Map<java.lang.String,​java.lang.Object> item)
        Description copied from interface: Sequence
        Removes the first occurrence of the given item from the sequence.
        Specified by:
        remove in interface Sequence<Map<java.lang.String,​java.lang.Object>>
        Parameters:
        item - The item to remove.
        Returns:
        The index of the item that was removed, or -1 if the item could not be found.
        See Also:
        Sequence.remove(int, int)

      • remove

        @UnsupportedOperation
public Sequence<Map<java.lang.String,​java.lang.Object>> remove​(int index,
                                                                     int count)
        Description copied from interface: Sequence
        Removes one or more items from the sequence.
        Specified by:
        remove in interface List<Map<java.lang.String,​java.lang.Object>>
        Specified by:
        remove in interface Sequence<Map<java.lang.String,​java.lang.Object>>
        Parameters:
        index - The starting index to remove.
        count - The number of items to remove, beginning with index.
        Returns:
        A sequence containing the items that were removed.
        See Also:
        ListListener.itemsRemoved(List, int, Sequence)

      • get

        @UnsupportedOperation
public Map<java.lang.String,​java.lang.Object> get​(int index)
        Description copied from interface: Sequence
        Retrieves the item at the given index.
        Specified by:
        get in interface Sequence<Map<java.lang.String,​java.lang.Object>>
        Parameters:
        index - The index of the item to retrieve.
        Returns:
        The item at this index in the sequence.

      • indexOf

        @UnsupportedOperation
public int indexOf​(Map<java.lang.String,​java.lang.Object> item)
        Description copied from interface: Sequence
        Returns the index of an item in the sequence.
        Specified by:
        indexOf in interface Sequence<Map<java.lang.String,​java.lang.Object>>
        Parameters:
        item - The item to locate.
        Returns:
        The index of first occurrence of the item if it exists in the sequence; -1, otherwise.

      • isEmpty

        @UnsupportedOperation
public boolean isEmpty()
        Description copied from interface: Collection
        Tests the emptiness of the collection.
        Specified by:
        isEmpty in interface Collection<Map<java.lang.String,​java.lang.Object>>
        Returns:
        true if the collection contains no elements; false, otherwise.

      • getLength

        public int getLength()
        Description copied from interface: List
        Returns the length of the list.
        Specified by:
        getLength in interface List<Map<java.lang.String,​java.lang.Object>>
        Specified by:
        getLength in interface Sequence<Map<java.lang.String,​java.lang.Object>>
        Returns:
        The number of items in the list, or -1 if the list's length is not known. In this case, the iterator must be used to retrieve the contents of the list.

      • getComparator

        public java.util.Comparator<Map<java.lang.String,​java.lang.Object>> getComparator()
        Description copied from interface: Collection
        Returns the collection's sort order.
        Specified by:
        getComparator in interface Collection<Map<java.lang.String,​java.lang.Object>>
        Returns:
        The comparator used to order elements in the collection, or null if the sort order is undefined.
        See Also:
        Collection.setComparator(Comparator)

      • setComparator

        @UnsupportedOperation
public void setComparator​(java.util.Comparator<Map<java.lang.String,​java.lang.Object>> comparator)
        Description copied from interface: Collection
        Sets the collection's sort order, re-ordering the collection's contents and ensuring that new entries preserve the sort order.

        Calling this method more than once with the same comparator will re-sort the collection.

        Specified by:
        setComparator in interface Collection<Map<java.lang.String,​java.lang.Object>>
        Specified by:
        setComparator in interface List<Map<java.lang.String,​java.lang.Object>>
        Parameters:
        comparator - The comparator used to order elements in the collection, or null if the collection is unsorted.
        See Also:
        ListListener.comparatorChanged(List, Comparator)

      • iterator

        public java.util.Iterator<Map<java.lang.String,​java.lang.Object>> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<Map<java.lang.String,​java.lang.Object>>

      • getListListeners

        public ListenerList<ListListener<Map<java.lang.String,​java.lang.Object>>> getListListeners()
        Description copied from interface: List
        Returns the list listener list.
        Specified by:
        getListListeners in interface List<Map<java.lang.String,​java.lang.Object>>
        Returns:
        The list of listeners for this list.