net.doo.snap.persistence

Class DocumentStoreStrategy

net.doo.snap.persistence.DocumentStoreStrategy

public class DocumentStoreStrategy

Provides java.io.File directories for saving net.doo.snap.entity.Document

The structure of the document folder is the following: {documents_directory}/document UUID -------{document_name}.pdf -------{thumbnail}

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TEMPORARY_FILE_PREFIX
static java.lang.String	THUMBNAIL_FILE_NAME

Constructor Summary

Constructors

Constructor and Description
DocumentStoreStrategy()

Method Summary

Modifier and Type	Method and Description
boolean	ensureDocumentDir()
void	ensureDocumentDirectory() Creates directory for net.doo.snap.entity.Document if not exists.
void	eraseDocument() Deletes Document directory and all its pages from file system Use from BG thread only
java.io.File	getDocumentDir()
java.io.File	getDocumentDirForSharing()
java.io.File	getDocumentFile()
java.io.File	getDocumentFileForSharing()
java.io.File	getDocumentsDir()
java.io.File	getDocumentsDirForSharing()
java.io.File	getDocumentsExternalDir()
java.util.List<java.io.File>	getDocumentsFiles()
java.lang.String	getPageImagePath()
java.io.File	getTemporaryDocumentFile()
java.io.File	getThumbnailFile()
java.lang.String	getUniqueName() Recursively trying to find unique name for pdf document in pdf files directory
void	migrateDocuments() Migrates all pdf files to directory specified in preferences net.doo.snap.PreferencesConstants#EXTERNAL_DIR or default directory net.doo.snap.Constants#DEFAULT_EXTERNAL_DIR_NAME or from external directory to internal application document directories. Use from BG thread only.
boolean	renameDocument() Renames document. Use from BG thread only

Field Detail

THUMBNAIL_FILE_NAME

public static java.lang.String THUMBNAIL_FILE_NAME

TEMPORARY_FILE_PREFIX

public static java.lang.String TEMPORARY_FILE_PREFIX

Constructor Detail

DocumentStoreStrategy

public DocumentStoreStrategy()

Method Detail

ensureDocumentDir

public boolean ensureDocumentDir()

Returns:

true if the given docDir has a correct structure (pdf document and it's thumbnail), false otherwise

getDocumentsDir

public java.io.File getDocumentsDir()

Returns:

java.io.File directory where documents will be stored or null if not possible to create

Throws:

IOException - if directory can't be opened

getDocumentsExternalDir

public java.io.File getDocumentsExternalDir()

Returns:

java.io.File external directory where pdf files will be stored or null if not possible to create

Throws:

IOException - if directory can't be opened

getDocumentsDirForSharing

public java.io.File getDocumentsDirForSharing()

Returns:

java.io.File directory where shared documents will be temporarily stored or null if not possible to create

Throws:

IOException - if directory can't be opened

getDocumentDirForSharing

public java.io.File getDocumentDirForSharing()

Returns:

java.io.File directory where shared document will be temporarily stored or null if it does not exist or is not accessible

Throws:

IOException - if directory can't be opened

getDocumentDir

public java.io.File getDocumentDir()

Returns:

directory for the given docId or null if it does not exist or is not accessible

Throws:

IOException - if directory can't be opened

ensureDocumentDirectory

public void ensureDocumentDirectory()

Creates directory for net.doo.snap.entity.Document if not exists.

Throws:

- in case if directory creation failed

getDocumentFile

public java.io.File getDocumentFile()

Returns:

java.io.File which represents PDF file of the net.doo.snap.entity.Document or null if there were problems accessing FS

Throws:

IOException - if java.io.File can't be opened

getDocumentsFiles

public java.util.List<java.io.File> getDocumentsFiles()

Returns:

List of java.io.File which represents all PDF files or null if there were problems accessing FS

Throws:

IOException - if java.io.File can't be opened

getThumbnailFile

public java.io.File getThumbnailFile()

Returns:

java.io.File which represents thumbnail file of the document or null if there were problems accessing FS

Throws:

IOException - if java.io.File can't be opened

getTemporaryDocumentFile

public java.io.File getTemporaryDocumentFile()

Returns:

temporary file for document which might be used for editing of original document file

Throws:

- if java.io.File can't be opened

getDocumentFileForSharing

public java.io.File getDocumentFileForSharing()

Returns:

temporary copy file for document which might be shared

Throws:

- if java.io.File can't be opened

eraseDocument

public void eraseDocument()

Deletes Document directory and all its pages from file system Use from BG thread only

renameDocument

public boolean renameDocument()

Renames document. Use from BG thread only

Returns:

true if file was successfully renamed, false - otherwise

getUniqueName

public java.lang.String getUniqueName()

Recursively trying to find unique name for pdf document in pdf files directory

Returns:

unique file name

getPageImagePath

public java.lang.String getPageImagePath()

Returns:

logical path of image file at given page position. This might be either path to file or identifier of pdf page.

migrateDocuments

public void migrateDocuments()

Migrates all pdf files to directory specified in preferences net.doo.snap.PreferencesConstants#EXTERNAL_DIR or default directory net.doo.snap.Constants#DEFAULT_EXTERNAL_DIR_NAME or from external directory to internal application document directories.

Use from BG thread only.