com.gnostice.documents.image

Class Image

java.lang.Object

com.gnostice.documents.image.Image

All Implemented Interfaces:

IDocument

public class Image
extends Object
implements IDocument

Constructor Summary

Constructors

Constructor and Description
Image()

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 inputDoc, PageRangeSettings pagesToCopySettings)
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 imageEncoderSettings)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Image

public Image()

Method Detail

getSupportedFileExtensions

public String[] getSupportedFileExtensions()

Specified by:

getSupportedFileExtensions in interface IDocument

getSupportedMIMETypes

public String[] getSupportedMIMETypes()

Specified by:

getSupportedMIMETypes in interface IDocument

getMIMEType

public String getMIMEType()

Specified by:

getMIMEType in interface IDocument

getFileExtensionsForMIMEType

public String[] getFileExtensionsForMIMEType(String MIMEType)

Specified by:

getFileExtensionsForMIMEType in interface IDocument

getMIMETypesForFileExtension

public String[] getMIMETypesForFileExtension(String fileExtension)

Specified by:

getMIMETypesForFileExtension in interface IDocument

check

public boolean check(String filePath)
              throws IOException

Specified by:

check in interface IDocument

Throws:

IOException

check

public boolean check(InputStream inStream)
              throws IOException

Specified by:

check in interface IDocument

Throws:

IOException

getPageCount

public int getPageCount()

Deprecated. Instead use getCurrentPageCount().

Specified by:

getPageCount in interface IDocument

getCurrentPageCount

public CurrentPageCount getCurrentPageCount()

Specified by:

getCurrentPageCount in interface IDocument

getPage

public IPage getPage(int pageIndex)
              throws XDocException,
                     IOException

Specified by:

getPage in interface IDocument

Throws:

XDocException

IOException

getPage

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

Specified by:

getPage in interface IDocument

Throws:

InterruptedException

XDocException

IOException

getFileName

public String getFileName()

Specified by:

getFileName in interface IDocument

getDocumentInfo

public DocumentInfo getDocumentInfo()

Specified by:

getDocumentInfo in interface IDocument

addDocumentListener

public void addDocumentListener(DocumentListener documentListener)

Specified by:

addDocumentListener in interface IDocument

removeDocumentListener

public DocumentListener removeDocumentListener(DocumentListener documentListener)

Specified by:

removeDocumentListener in interface IDocument

getDocumentListeners

public DocumentListener[] getDocumentListeners()

Specified by:

getDocumentListeners in interface IDocument

loadDocumentAsync

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

Specified by:

loadDocumentAsync in interface IDocument

Throws:

FormatNotSupportedException

IncorrectPasswordException

XDocException

IOException

loadDocumentAsync

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

Specified by:

loadDocumentAsync in interface IDocument

Throws:

FormatNotSupportedException

IncorrectPasswordException

XDocException

IOException

loadDocument

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

Specified by:

loadDocument in interface IDocument

Throws:

FormatNotSupportedException

InsufficientPermissionsException

XDocException

IOException

loadDocument

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

Specified by:

loadDocument in interface IDocument

Throws:

FormatNotSupportedException

InsufficientPermissionsException

XDocException

IOException

closeDocument

public void closeDocument()
                   throws IOException

Specified by:

closeDocument in interface IDocument

Throws:

IOException

getPreferences

public Preferences getPreferences()

Specified by:

getPreferences in interface IDocument

getFormatKind

public FormatKind getFormatKind()

Specified by:

getFormatKind in interface IDocument

copyFrom

public void copyFrom(IDocument inputDoc,
                     PageRangeSettings pagesToCopySettings)
              throws XDocException,
                     IOException

Specified by:

copyFrom in interface IDocument

Throws:

XDocException

IOException

copyFrom

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

Specified by:

copyFrom in interface IDocument

Throws:

XDocException

IOException

save

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

Specified by:

save in interface IDocument

Throws:

IOException

XDocException

save

public void save(OutputStream outputStream)
          throws XDocException,
                 IOException

Specified by:

save in interface IDocument

Throws:

XDocException

IOException

getEncoderSettings

public EncoderSettings getEncoderSettings()

Specified by:

getEncoderSettings in interface IDocument

setEncoderSettings

public void setEncoderSettings(EncoderSettings imageEncoderSettings)
                        throws XDocException

Specified by:

setEncoderSettings in interface IDocument

Throws:

XDocException

isLoaded

public boolean isLoaded()

Specified by:

isLoaded in interface IDocument

getFileInfo

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

Specified by:

getFileInfo in interface IDocument

Throws:

XDocException

IOException

getFileInfo

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

Specified by:

getFileInfo in interface IDocument

Throws:

XDocException

IOException