Package com.saperion.intf

Interface SaDocInfo.ElementInfo

  • All Superinterfaces:
    java.io.Serializable
    Enclosing interface:
    SaDocInfo
    public static interface SaDocInfo.ElementInfo
extends java.io.Serializable
    Represents an element of a document's structure.

    • Method Detail

      • getNumber

        int getNumber()
        Returns:
        Number of the element

      • getFileName

        @Deprecated
java.lang.String getFileName()
        Deprecated.
        Since 7.1 SP1 use getName() or getFullName() instead
        Returns:
        Element filename

      • getFullName

        java.lang.String getFullName()
        Returns the full name of the element as it was stored in the archive (with page-numbers for multi-page-tiffs but without path).
        Returns:
        full name of the element

      • getName

        java.lang.String getName()
        Returns only the name of the element. For multi-page tiffs, the page number will be removed.
        Returns:
        Element name

      • isSelected

        boolean isSelected()
        Returns:
        True, if selected

      • getVariableData

        java.util.Properties getVariableData()
        Returns:
        element variable data

      • getSize

        long getSize()
        Returns:
        element's size

      • withVariables

        SaDocInfo.ElementInfo withVariables​(java.util.Properties variables)
        This method creates a new ElementInfo with the same values except for the variables which are the ones given.
        Parameters:
        variables - the new variables
        Returns:
        a new ElementInfo with the same values except for the variables which are the ones given

      • getPageCount

        int getPageCount()
        Returns:
        the number of pages

      • getFrameCount

        int getFrameCount()
        Returns:
        the number of frames

      • getDocUid

        java.lang.String getDocUid()
        Returns:
        the uid of the document

      • getLinkUid

        java.lang.String getLinkUid()
        Returns:
        the uid of the linked document if the document is a link.

      • getStructureLevel

        int getStructureLevel()
        Returns:
        the element's level in the structure hierarchy. 0 indicates unstructured document.