Package org.openxava.web.editors

Interface ITreeViewReader

  • All Known Implementing Classes:
    TreeViewReaderImpl
    public interface ITreeViewReader
    Defines the contract for tree view readers.
    Author:
    Federico Alcantara

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void close()
      Ends the process of reading
      java.lang.Object getObjectAt​(int rowIndex)
      Returns the object representing the column
      void initialize​(java.lang.String parentModelName, java.util.Map parentKey, java.lang.String collectionModelName, java.util.Map[] allKeys)
      Initializes the reader

    • Method Detail

      • initialize

        void initialize​(java.lang.String parentModelName,
                java.util.Map parentKey,
                java.lang.String collectionModelName,
                java.util.Map[] allKeys)
         throws java.lang.Exception
        Initializes the reader
        Parameters:
        parentModelName - name of the parent model of the collection
        parentKey - key for the parent object
        collectionModelName - name of the collection model
        allKeys - all the keys to be read from the collection
        columnNames - name of the columns in their column order.
        Throws:
        java.lang.Exception

      • close

        void close()
    throws java.lang.Exception
        Ends the process of reading
        Throws:
        java.lang.Exception

      • getObjectAt

        java.lang.Object getObjectAt​(int rowIndex)
                      throws java.lang.Exception
        Returns the object representing the column
        Parameters:
        rowIndex - index of the row to read
        Returns:
        Throws:
        java.lang.Exception