Interface SBookSeries

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Object getAttribute​(java.lang.String name)
      Get the runtime custom attribute that stored in this book
      java.util.Map<java.lang.String,​java.lang.Object> getAttributes()
      Get the unmodifiable runtime attributes map
      SBook getBook​(java.lang.String name)
      Get the book by name;
      java.util.List<SBook> getBooks()
      Gets the books list
      java.util.concurrent.locks.ReadWriteLock getLock()
      Get the ReadWriteLock for synchronized when read-write model for current accessing.
      boolean isAutoFormulaCacheClean()  
      java.lang.Object setAttribute​(java.lang.String name, java.lang.Object value)
      Set the runtime custom attribute to stored in this book, the attribute is only use for developer to stored runtime data in the book, values will not stored to excel when exporting.
      void setAutoFormulaCacheClean​(boolean enable)  
    • Method Detail

      • getBook

        SBook getBook​(java.lang.String name)
        Get the book by name;
        Parameters:
        name - the book name
        Returns:
        the book or null if not found.
      • getBooks

        java.util.List<SBook> getBooks()
        Gets the books list
        Returns:
        the readonly books list
      • getLock

        java.util.concurrent.locks.ReadWriteLock getLock()
        Get the ReadWriteLock for synchronized when read-write model for current accessing.
        Returns:
      • getAttribute

        java.lang.Object getAttribute​(java.lang.String name)
        Get the runtime custom attribute that stored in this book
        Parameters:
        name - the attribute name
        Returns:
        the value, or null if not found
      • setAttribute

        java.lang.Object setAttribute​(java.lang.String name,
                                      java.lang.Object value)
        Set the runtime custom attribute to stored in this book, the attribute is only use for developer to stored runtime data in the book, values will not stored to excel when exporting.
        Parameters:
        name - name the attribute name
        value - the attribute value
      • getAttributes

        java.util.Map<java.lang.String,​java.lang.Object> getAttributes()
        Get the unmodifiable runtime attributes map
        Returns:
      • isAutoFormulaCacheClean

        boolean isAutoFormulaCacheClean()
        Returns:
        return the flag that indicate formula cache will be cleared automatically or not, default is FALSE.