io.scanbot.sdk.persistence

Interface PageStorage

public PageStorage

Interface providing easy methods to work with Page image objects

Method Summary

Modifier and Type	Method and Description
java.io.File	getDocumentImage(java.lang.String pageId) Provides File containing document image
java.io.File	getDocumentImagePreview(java.lang.String pageId) Provides File containing document image preview
java.io.File	getOriginalImage(java.lang.String pageId) Provides File containing original image
java.io.File	getOriginalImagePreview(java.lang.String pageId) Provides File containing original image preview
java.io.File	getPageDir(java.lang.String pageId) Provides directory to save image files for current Page
java.io.File	getPagesDirectory() Provides directory which store all pages
java.util.List<java.lang.String>	getStoredPages() Provides List with all pageIds

Method Detail

getPagesDirectory

java.io.File getPagesDirectory()

Provides directory which store all pages

Returns:

File directory, which will contain images for current page

Throws:

getPageDir

java.io.File getPageDir(java.lang.String pageId)

Provides directory to save image files for current Page

Parameters:

pageId -

• id of a page

Returns:

File directory, which will contain images for current page

Throws:

getOriginalImage

java.io.File getOriginalImage(java.lang.String pageId)

Provides File containing original image

Parameters:

pageId -

• id of a page

Returns:

File with image

Throws:

See Also:

File

getOriginalImagePreview

java.io.File getOriginalImagePreview(java.lang.String pageId)

Provides File containing original image preview

Parameters:

pageId -

• id of a page

Returns:

File with image

Throws:

See Also:

File

getDocumentImage

java.io.File getDocumentImage(java.lang.String pageId)

Provides File containing document image

Parameters:

pageId -

• id of a page

Returns:

File with image

Throws:

See Also:

File

getDocumentImagePreview

java.io.File getDocumentImagePreview(java.lang.String pageId)

Provides File containing document image preview

Parameters:

pageId -

• id of a page

Returns:

File with image

Throws:

See Also:

File

getStoredPages

java.util.List<java.lang.String> getStoredPages()

Provides List with all pageIds

Returns:

List with currently presented files ids

Throws:

See Also:

List