Interface AttributeReader

  • All Known Implementing Classes:
    JoiningAttributeReader

    public interface AttributeReader
    The low-level attribute reading API. An AttributeReader is responsible for reading a finite set of attributes from an underlying storage format. It provides meta-data regarding the data it can provide, and an iterative, row-based approach for accessing the data.
    Author:
    Ian Schneider
    See Also:
    AttributeAcceptor
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void close()
      Release any resources associated with this reader
      int getAttributeCount()
      The number of attributes this reader can read, i.e the length of a row.
      AttributeDescriptor getAttributeType​(int index)
      Retrieve the AttributeType at the given index.
      boolean hasNext()
      Does another set of attributes exist in this reader?
      void next()
      Advance the reader to the next set of attributes.
      Object read​(int index)
      Read the attribute at the given index.
    • Method Detail

      • getAttributeCount

        int getAttributeCount()
        The number of attributes this reader can read, i.e the length of a row.
        Returns:
        Number of attribtues this reader can read
      • getAttributeType

        AttributeDescriptor getAttributeType​(int index)
                                      throws ArrayIndexOutOfBoundsException
        Retrieve the AttributeType at the given index.
        Returns:
        AttributeType at given index
        Throws:
        ArrayIndexOutOfBoundsException
      • close

        void close()
            throws IOException
        Release any resources associated with this reader
        Throws:
        IOException
      • hasNext

        boolean hasNext()
                 throws IOException
        Does another set of attributes exist in this reader?
        Returns:
        true if additional content exists for AttributeReader
        Throws:
        IOException
      • next

        void next()
           throws IOException
        Advance the reader to the next set of attributes.
        Throws:
        IOException
      • read

        Object read​(int index)
             throws IOException,
                    ArrayIndexOutOfBoundsException
        Read the attribute at the given index.
        Returns:
        Object Attribute at given index
        Throws:
        IOException
        ArrayIndexOutOfBoundsException