Class AddressIndexPrimaryKeyIterator

  • All Implemented Interfaces:
    DBFieldIterator

    public class AddressIndexPrimaryKeyIterator
    extends java.lang.Object
    implements DBFieldIterator
    Long iterator over indexed addresses. The longs are primary keys returned ordered and restrained by the address field they contain
    • Constructor Detail

      • AddressIndexPrimaryKeyIterator

        public AddressIndexPrimaryKeyIterator()
        Empty iterator constructor
      • AddressIndexPrimaryKeyIterator

        public AddressIndexPrimaryKeyIterator​(Table table,
                                              int indexCol,
                                              AddressMap addrMap,
                                              boolean atStart)
                                       throws java.io.IOException
        Constructs a new AddressIndexPrimaryKeyIterator. Memory addresses encoded as Absolute are not included.
        Parameters:
        table - the database table containing indexed addresses.
        indexCol - the column that contains indexed addresses.
        addrMap - the address map
        atStart - if true, iterates forward, otherwise iterates backwards.
        Throws:
        java.io.IOException - if a database io error occurs.
      • AddressIndexPrimaryKeyIterator

        public AddressIndexPrimaryKeyIterator​(Table table,
                                              int indexCol,
                                              AddressMap addrMap,
                                              Address minAddr,
                                              Address maxAddr,
                                              boolean atStart)
                                       throws java.io.IOException
        Constructs a new AddressIndexPrimaryKeyIterator for a range of addresses. Memory addresses encoded as Absolute are not included.
        Parameters:
        table - the database table containing indexed addresses.
        indexCol - the column that contains indexed addresses.
        addrMap - the address map
        minAddr - the first address in the range to iterate over.
        maxAddr - the last address in the range to iterator over.
        atStart - if true, iterates forward, otherwise iterates backwards.
        Throws:
        java.io.IOException - if a database io error occurs.
      • AddressIndexPrimaryKeyIterator

        public AddressIndexPrimaryKeyIterator​(Table table,
                                              int indexCol,
                                              AddressMap addrMap,
                                              AddressSetView set,
                                              boolean atStart)
                                       throws java.io.IOException
        Constructs a new AddressIndexPrimaryKeyIterator for a set of addresses. Memory addresses encoded as Absolute are not included.
        Parameters:
        table - the database table containing indexed addresses.
        indexCol - the column that contains indexed addresses.
        addrMap - the address map
        set - the set of addresses to iterator over.
        atStart - if true, iterates forward, otherwise iterates backwards.
        Throws:
        java.io.IOException - if a database io error occurs.
      • AddressIndexPrimaryKeyIterator

        public AddressIndexPrimaryKeyIterator​(Table table,
                                              int indexCol,
                                              AddressMap addrMap,
                                              Address start,
                                              boolean before)
                                       throws java.io.IOException
        Constructs a new AddressIndexPrimaryKeyIterator starting at a given address. Memory addresses encoded as Absolute are not included.
        Parameters:
        table - the database table containing indexed addresses.
        indexCol - the column that contains indexed addresses.
        addrMap - the address map
        start - the starting address for the iterator.
        before - if true, positions the iterator before start, otherwise positions it after start.
        Throws:
        java.io.IOException - if a database io error occurs.
    • Method Detail

      • hasNext

        public boolean hasNext()
                        throws java.io.IOException
        Description copied from interface: DBFieldIterator
        Return true if a Field is available in the forward direction.
        Specified by:
        hasNext in interface DBFieldIterator
        Throws:
        java.io.IOException - thrown if an IO error occurs
      • hasPrevious

        public boolean hasPrevious()
                            throws java.io.IOException
        Description copied from interface: DBFieldIterator
        Return true if a Field is available in the reverse direction
        Specified by:
        hasPrevious in interface DBFieldIterator
        Throws:
        java.io.IOException - thrown if an IO error occurs
      • next

        public Field next()
                   throws java.io.IOException
        Description copied from interface: DBFieldIterator
        Return the next Field value or null if one is not available.
        Specified by:
        next in interface DBFieldIterator
        Throws:
        java.io.IOException - thrown if an IO error occurs
      • previous

        public Field previous()
                       throws java.io.IOException
        Description copied from interface: DBFieldIterator
        Return the previous Field value or null if one is not available.
        Specified by:
        previous in interface DBFieldIterator
        Throws:
        java.io.IOException - thrown if an IO error occurs
      • delete

        public boolean delete()
                       throws java.io.IOException
        Description copied from interface: DBFieldIterator
        Delete the last record(s) associated with the last Field value read via the next or previous methods.
        Specified by:
        delete in interface DBFieldIterator
        Returns:
        true if record(s) was successfully deleted.
        Throws:
        java.io.IOException - thrown if an IO error occurs.