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.
-
-
Method Summary
Modifier and Type Method Description abstract File
getPagesDirectory(String documentId)
Provides directory which stores all pages for document. abstract File
getPageDir(String pageId, String documentId)
Provides directory to store image files for current Page. abstract File
getOriginalImage(String pageId, String documentId)
Provides File of the original image. abstract File
getOriginalImagePreview(String pageId, String documentId)
Provides File of the original preview image. abstract File
getDocumentImage(String pageId, String documentId)
Provides File of the document image. abstract File
getUnfilteredDocumentImage(String pageId, String documentId)
Provides File of the unfiltered document image. abstract File
getDocumentImagePreview(String pageId, String documentId)
Provides File of the document preview image. abstract File
getUnfilteredDocumentImagePreview(String pageId, String documentId)
Provides File of the unfiltered document preview image. abstract List<String>
getStoredPages(String documentId)
Provides List with all pageIds for a given document. abstract File
getFilteredImagePreview(String pageId, String documentId, ParametricFilter parametricFilter)
Provides File containing page preview with applied ParametricFilter for a given document. abstract List<File>
getFilteredImagePreviews(String pageId, String documentId)
Provides full list of Files containing page preview with applied filters for a given document. -
-
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
-
getUnfilteredDocumentImage
abstract File getUnfilteredDocumentImage(String pageId, String documentId)
Provides File of the unfiltered 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
-
getUnfilteredDocumentImagePreview
abstract File getUnfilteredDocumentImagePreview(String pageId, String documentId)
Provides File of the unfiltered 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
-
getFilteredImagePreview
abstract File getFilteredImagePreview(String pageId, String documentId, ParametricFilter parametricFilter)
Provides File containing page preview with applied ParametricFilter for a given document.
- Parameters:
pageId
-id of a page
documentId
-id of a parent document
parametricFilter
-filter type
-
-
-
-