Package com.im.df.api.util

Class EntityDataIterator

  • All Implemented Interfaces:
    java.util.Iterator
    public class EntityDataIterator
extends java.lang.Object
implements java.util.Iterator
    Allows to iterate over large sets of data.

    TODO P2 - this class might be removed from API

    Author:
    Tim Dudgeon

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.util.List<? extends java.lang.Comparable<?>> getIds()  
      boolean hasNext()  
      EntityDataIterator.Entry next()  
      void remove()  
      int size()  
      protected java.util.List<? extends java.lang.Comparable<?>> subList​(java.util.List<? extends java.lang.Comparable<?>> list, int start)  

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.util.Iterator

        forEachRemaining

    • Constructor Detail

      • EntityDataIterator

        public EntityDataIterator​(DFEntityDataProvider edp,
                          DFTermExpression query,
                          java.util.Set<? extends DFField> fields,
                          int chunkSize,
                          com.im.commons.progress.DFEnvironmentRO env)
        Creates a new instance of EntityDataIterator.
        Parameters:
        edp - The data provider for the entity whose data we want
        query - A query to filter the data. Can be null.
        fields - Interested fields.
        chunkSize - The number of data items that are retrieved in one go. When all items in the chunk have been iterated through the next chunk will be retrieved.
        env - The DFEnvironmentRO
        Since:
        15.6.22

    • Method Detail

      • size

        public int size()

      • hasNext

        public boolean hasNext()
        Specified by:
        hasNext in interface java.util.Iterator

      • remove

        public void remove()
        Specified by:
        remove in interface java.util.Iterator

      • getIds

        protected java.util.List<? extends java.lang.Comparable<?>> getIds()

      • subList

        protected java.util.List<? extends java.lang.Comparable<?>> subList​(java.util.List<? extends java.lang.Comparable<?>> list,
                                                                    int start)