com.gnostice.documents

Interface IDocument

All Known Implementing Classes:

DOCX, Image, PDF, TXT

public interface IDocument

Method Summary

Modifier and Type	Method and Description
void	addDocumentListener(DocumentListener documentListener)
boolean	check(InputStream inStream)
boolean	check(String filePath)
void	closeDocument()
void	copyFrom(IDocument sourceDocument, PageRangeSettings pageRangeSettings)
void	copyFrom(IDocument sourceDocument, PageRangeSettings pageRangeSettings, DigitizerSettings digitizerSettings)
CurrentPageCount	getCurrentPageCount()
DocumentInfo	getDocumentInfo()
DocumentListener[]	getDocumentListeners()
EncoderSettings	getEncoderSettings()
String[]	getFileExtensionsForMIMEType(String MIMEType)
FileInfo	getFileInfo(InputStream inStream, String password)
FileInfo	getFileInfo(String fileName, String password)
String	getFileName()
FormatKind	getFormatKind()
String	getMIMEType()
String[]	getMIMETypesForFileExtension(String fileExtension)
IPage	getPage(int pageIndex)
IPage	getPage(int pageIndex, long timeoutInMS)
int	getPageCount() Deprecated. Instead use getCurrentPageCount().
Preferences	getPreferences()
String[]	getSupportedFileExtensions()
String[]	getSupportedMIMETypes()
boolean	isLoaded()
void	loadDocument(InputStream inStream, String password)
void	loadDocument(String fileName, String password)
LoadDocumentFutureTask	loadDocumentAsync(InputStream inStream, String password)
LoadDocumentFutureTask	loadDocumentAsync(String fileName, String password)
DocumentListener	removeDocumentListener(DocumentListener documentListener)
void	save(OutputStream outputStream)
void	save(String outputDir, String baseFileName)
void	setEncoderSettings(EncoderSettings encoderSettings)

Method Detail

check

boolean check(String filePath)
       throws IOException

Throws:

IOException

check

boolean check(InputStream inStream)
       throws IOException

Throws:

IOException

getPageCount

int getPageCount()

Deprecated. Instead use getCurrentPageCount().

getCurrentPageCount

CurrentPageCount getCurrentPageCount()

getPage

IPage getPage(int pageIndex)
       throws XDocException,
              IOException

Throws:

XDocException

IOException

getPage

IPage getPage(int pageIndex,
              long timeoutInMS)
       throws XDocException,
              InterruptedException,
              IOException

Throws:

XDocException

InterruptedException

IOException

getFileName

String getFileName()

getFileInfo

FileInfo getFileInfo(String fileName,
                     String password)
              throws FileCorruptException,
                     XDocException,
                     IOException

Throws:

FileCorruptException

XDocException

IOException

getFileInfo

FileInfo getFileInfo(InputStream inStream,
                     String password)
              throws FileCorruptException,
                     XDocException,
                     IOException

Throws:

FileCorruptException

XDocException

IOException

getDocumentInfo

DocumentInfo getDocumentInfo()

getPreferences

Preferences getPreferences()

getEncoderSettings

EncoderSettings getEncoderSettings()

setEncoderSettings

void setEncoderSettings(EncoderSettings encoderSettings)
                 throws XDocException

Throws:

XDocException

getFormatKind

FormatKind getFormatKind()

getSupportedFileExtensions

String[] getSupportedFileExtensions()

getSupportedMIMETypes

String[] getSupportedMIMETypes()

getMIMEType

String getMIMEType()

getFileExtensionsForMIMEType

String[] getFileExtensionsForMIMEType(String MIMEType)

getMIMETypesForFileExtension

String[] getMIMETypesForFileExtension(String fileExtension)

addDocumentListener

void addDocumentListener(DocumentListener documentListener)

removeDocumentListener

DocumentListener removeDocumentListener(DocumentListener documentListener)

getDocumentListeners

DocumentListener[] getDocumentListeners()

loadDocument

void loadDocument(InputStream inStream,
                  String password)
           throws FormatNotSupportedException,
                  IncorrectPasswordException,
                  XDocException,
                  IOException

Throws:

FormatNotSupportedException

IncorrectPasswordException

XDocException

IOException

loadDocument

void loadDocument(String fileName,
                  String password)
           throws FormatNotSupportedException,
                  IncorrectPasswordException,
                  XDocException,
                  IOException

Throws:

FormatNotSupportedException

IncorrectPasswordException

XDocException

IOException

loadDocumentAsync

LoadDocumentFutureTask loadDocumentAsync(String fileName,
                                         String password)
                                  throws FormatNotSupportedException,
                                         IncorrectPasswordException,
                                         XDocException,
                                         IOException

Throws:

FormatNotSupportedException

IncorrectPasswordException

XDocException

IOException

loadDocumentAsync

LoadDocumentFutureTask loadDocumentAsync(InputStream inStream,
                                         String password)
                                  throws FormatNotSupportedException,
                                         IncorrectPasswordException,
                                         XDocException,
                                         IOException

Throws:

FormatNotSupportedException

IncorrectPasswordException

XDocException

IOException

closeDocument

void closeDocument()
            throws IOException

Throws:

IOException

copyFrom

void copyFrom(IDocument sourceDocument,
              PageRangeSettings pageRangeSettings)
       throws XDocException,
              IOException

Throws:

XDocException

IOException

copyFrom

void copyFrom(IDocument sourceDocument,
              PageRangeSettings pageRangeSettings,
              DigitizerSettings digitizerSettings)
       throws XDocException,
              IOException

Throws:

XDocException

IOException

save

void save(String outputDir,
          String baseFileName)
   throws XDocException,
          IOException

Throws:

XDocException

IOException

save

void save(OutputStream outputStream)
   throws XDocException,
          IOException

Throws:

XDocException

IOException

isLoaded

boolean isLoaded()