Interface DocumentPageStorage

  • All Implemented Interfaces:
    io.scanbot.sdk.persistence.page.PageStorage

    
    public interface DocumentPageStorage
     implements PageStorage
                        

    Interface providing easy methods to work with Page image objects.

    • Constructor Detail

    • Method Detail

      • getPagesDirectory

         abstract File getPagesDirectory(String documentId)

        Provides directory which stores all pages for document.

        Parameters:
        documentId -
        • id of a parent document

      • getPageDir

         abstract File getPageDir(String pageId, String documentId)

        Provides directory to store image files for current Page.

        Parameters:
        pageId -
        • id of a page

        documentId -
        • id of a parent document

      • getOriginalImage

         abstract File getOriginalImage(String pageId, String documentId)

        Provides File of the original image.

        Parameters:
        pageId -
        • id of a page

        documentId -
        • id of a parent document

      • getOriginalImagePreview

         abstract File getOriginalImagePreview(String pageId, String documentId)

        Provides File of the original preview image.

        Parameters:
        pageId -
        • id of a page

        documentId -
        • id of a parent document

      • getDocumentImage

         abstract File getDocumentImage(String pageId, String documentId)

        Provides File of the document image.

        Parameters:
        pageId -
        • id of a page

        documentId -
        • id of a parent document

      • getDocumentImagePreview

         abstract File getDocumentImagePreview(String pageId, String documentId)

        Provides File of the document preview image.

        Parameters:
        pageId -
        • id of a page

        documentId -
        • id of a parent document

      • getStoredPages

         abstract List<String> getStoredPages(String documentId)

        Provides List with all pageIds for a given document.

        Parameters:
        documentId -
        • id of a parent document

      • getFilteredImagePreviews

         abstract List<File> getFilteredImagePreviews(String pageId, String documentId)

        Provides full list of Files containing page preview with applied filters for a given document.

        Parameters:
        pageId -
        • id of a page

        documentId -
        • id of a parent document