Package com.saperion.ngc.model.document.intf

Interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo

All Superinterfaces:
Serializable
All Known Implementing Classes:
ClassicConnectorPageArchiveMetaInfo
Enclosing interface:
DocumentArchiveMetaInfo
public static interface DocumentArchiveMetaInfo.ElementArchiveMetaInfo extends Serializable
Holds the meta information about a page of a document that is stored in the archive.
Author:
jsc

  • Field Details

    • MULTIPAGE_TIFF_INDICATOR

      static final String MULTIPAGE_TIFF_INDICATOR
      Multipage tiff files contain @<page#> in full-name.
      See Also:

  • Method Details

    • getNumber

      int getNumber()
      Returns:
      Number of element

    • getFullName

      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

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

    • getType

      com.saperion.intf.SaDocInfo.ElementType getType()
      Returns:
      Element type

    • isSelected

      boolean isSelected()
      Returns:
      True, if selected

    • getVariableData

      Properties getVariableData()
      Returns:
      element variable data

    • getSize

      long getSize()
      Returns:
      element's size

    • getPageCount

      int getPageCount()
      Returns:
      the number of pages (for files with several pages)

    • getFrameCount

      int getFrameCount()
      Returns:
      the number of frames

    • getDocUid

      String getDocUid()
      Returns:
      the uid of the page

    • getLinkUid

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

    • getStructureDocUid

      String getStructureDocUid()
      Returns:
      the uid of structure which contains the document / page

    • getStructureLevel

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

    • isMultipageTiff

      boolean isMultipageTiff()
      Multipage tiff files contain @<page#> in full-name.
      Returns:
      True if the Element is a multipage tiff. False else.

    • isMergedMultipageDocument

      boolean isMergedMultipageDocument()
      Returns true if this element is a multipage document (TIFF or scanned pages) which was merged to one document by the core server.
      Returns:
      true if merged document

    • isVisible

      boolean isVisible()
      Checks if this element should be visible in structure-views or not. Note: Currently, this is only used by the SAP-Viewer to hide sapfile.txt files.