MST.Imaging.Document

Class MSTDocument

java.lang.Object

MST.Imaging.Document.MSTDocument

All Implemented Interfaces:

IMSTFileFormat

Direct Known Subclasses:

MSTPdf

public class MSTDocument
extends java.lang.Object
implements IMSTFileFormat

Field Summary

Fields

Modifier and Type	Field and Description
java.io.ByteArrayInputStream	bin
static MST.Imaging.Document.MSTech.DocumentServiceProvider	DocEngine
java.awt.Image[]	imageArray

Fields inherited from interface MST.Imaging.FileFormats.IMSTFileFormat

FileName, FileStream, PageCount, Size, Uri

Constructor Summary

Constructors

Constructor and Description
MSTDocument() default constructor It initializes the MSTImage object and initialize the engine object.

Method Summary

Methods

Modifier and Type	Method and Description
FileFormat	Detect() Gives the file format for the corresponding IMSTFileFormat object.
boolean	DropDocument() All the reference of the corresponding document are made null.
boolean	Export(java.io.FileOutputStream fos, OutputType outputtype) Exports the file in specified output type.
boolean	Export(java.io.FileOutputStream fos, OutputType outputtype, java.lang.String Annotations, SAVEOPTION options) Exports the file in specified output type.
boolean	Export(java.lang.String DestFileName, OutputType outputtype) Exports the file in specified output type .
boolean	Export(java.lang.String DestFileName, OutputType outputtype, java.lang.String Annotations, SAVEOPTION options) Exports the file in specified output type.
int	getCompression() Gives the value of compression of loaded image.
java.lang.String	getFileName() Gives the name of the file loaded into the MSTImage object.
java.io.InputStream	getFileStream() Gives the Inputstream of the file.
java.lang.String	getMimeType(int fileType)
IMSTPage	GetPage(int pageNo) This method loads the page data into the IMSTPage object.
IMSTPage	GetPage(int PageNo, PageInfo pgInfo) This method loads the page data into the IMSTPage object with the given parameters in PageInfo.
int	getPageCount() Gives the number of pages in the file.
boolean	GetPageInfo(int[] pageNo, PageInfo[] pageInfo) Gives the information about the given array of pages .
boolean	GetPageInfo(int pageNo, PageInfo pageInfo) Gives the information about a specific page .
IMSTPage[]	GetPages(int fromPage, int toPage, java.util.List<PageInfo> listPageInfo) This method loads the page data into the IMSTPage object with the given parameters in PageInfo.
int	getSize() Gives the size of byte array of the loaded file.
boolean	Load(java.io.InputStream stream) This method loads the image data into the MSTImage object.
boolean	Load(java.lang.String FileName) This method loads the image data into the MSTImage object.
boolean	Load(java.net.URI uri) This method loads the image data into the MSTImage object.

Methods inherited from class java.lang.Object

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

Field Detail

imageArray

public java.awt.Image[] imageArray

bin

public java.io.ByteArrayInputStream bin

DocEngine

public static MST.Imaging.Document.MSTech.DocumentServiceProvider DocEngine

Constructor Detail

MSTDocument

public MSTDocument()
            throws java.lang.ClassNotFoundException,
                   java.lang.IllegalAccessException,
                   java.lang.InstantiationException,
                   java.lang.Exception

default constructor It initializes the MSTImage object and initialize the engine object.

Throws:

java.lang.Exception

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.ClassNotFoundException

Method Detail

DropDocument

public boolean DropDocument()

Description copied from interface: IMSTFileFormat

All the reference of the corresponding document are made null.

Specified by:

DropDocument in interface IMSTFileFormat

Returns:

Load

public boolean Load(java.lang.String FileName)
             throws MSTException

Description copied from interface: IMSTFileFormat

This method loads the image data into the MSTImage object.

Specified by:

Load in interface IMSTFileFormat

Parameters:

FileName - Either name or the path of file.

Returns:

Boolean true if image is loaded successfully otherwise false.

Throws:

MSTException

Load

public boolean Load(java.io.InputStream stream)
             throws MSTException

Description copied from interface: IMSTFileFormat

This method loads the image data into the MSTImage object.

Specified by:

Load in interface IMSTFileFormat

Parameters:

stream - InputStream object associated with the file that is to be loaded.

Returns:

Boolean true if image is loaded successfully otherwise false.

Throws:

MSTException

Load

public boolean Load(java.net.URI uri)
             throws MSTException

Description copied from interface: IMSTFileFormat

This method loads the image data into the MSTImage object.

Specified by:

Load in interface IMSTFileFormat

Parameters:

uri - URI path of the file.

Returns:

Boolean true if image is loaded successfully otherwise false.

Throws:

MSTException

GetPage

public IMSTPage GetPage(int pageNo)
                 throws MSTException

Description copied from interface: IMSTFileFormat

This method loads the page data into the IMSTPage object.

Specified by:

GetPage in interface IMSTFileFormat

Parameters:

pageNo - page no of which the page data is to be loaded.

Returns:

IMSTPage Contains the page data.

Throws:

MSTException

GetPage

public IMSTPage GetPage(int PageNo,
               PageInfo pgInfo)
                 throws MSTException

Description copied from interface: IMSTFileFormat

This method loads the page data into the IMSTPage object with the given parameters in PageInfo.

Specified by:

GetPage in interface IMSTFileFormat

pgInfo - PageInfo Object having parameters as rotate,scale to be applied.

Returns:

IMSTPage Contains the page data.

Throws:

MSTException

GetPages

public IMSTPage[] GetPages(int fromPage,
                  int toPage,
                  java.util.List<PageInfo> listPageInfo)
                    throws MSTException

Description copied from interface: IMSTFileFormat

This method loads the page data into the IMSTPage object with the given parameters in PageInfo.

Specified by:

GetPages in interface IMSTFileFormat

Parameters:

fromPage - Range of pages.

toPage - Range of pages.

listPageInfo - List having the PageInfo objects

Returns:

IMSTPage Contains the page data.

Throws:

MSTException

GetPageInfo

public boolean GetPageInfo(int pageNo,
                  PageInfo pageInfo)
                    throws MSTException

Description copied from interface: IMSTFileFormat

Gives the information about a specific page .

Specified by:

GetPageInfo in interface IMSTFileFormat

Parameters:

pageNo - page no. of which the information is to be filled into the referenced PageInfo object.

pageInfo - PageInfo object reference.

Returns:

Throws:

MSTException

GetPageInfo

public boolean GetPageInfo(int[] pageNo,
                  PageInfo[] pageInfo)
                    throws MSTException

Description copied from interface: IMSTFileFormat

Gives the information about the given array of pages .

Specified by:

GetPageInfo in interface IMSTFileFormat

Parameters:

pageNo - page no. of which the information is to be filled into the referenced PageInfo object.

pageInfo - PageInfo object reference.

Returns:

Throws:

MSTException

getFileName

public java.lang.String getFileName()

Description copied from interface: IMSTFileFormat

Gives the name of the file loaded into the MSTImage object.

Specified by:

getFileName in interface IMSTFileFormat

Returns:

filename.

getFileStream

public java.io.InputStream getFileStream()

Description copied from interface: IMSTFileFormat

Gives the Inputstream of the file.

Specified by:

getFileStream in interface IMSTFileFormat

Returns:

Inputstream.

getPageCount

public int getPageCount()

Description copied from interface: IMSTFileFormat

Gives the number of pages in the file.

Specified by:

getPageCount in interface IMSTFileFormat

Returns:

page count.

getSize

public int getSize()

Description copied from interface: IMSTFileFormat

Gives the size of byte array of the loaded file.

Specified by:

getSize in interface IMSTFileFormat

Returns:

filesize.

getMimeType

public java.lang.String getMimeType(int fileType)

Export

public boolean Export(java.lang.String DestFileName,
             OutputType outputtype)
               throws MSTException

Description copied from interface: IMSTFileFormat

Exports the file in specified output type .

Specified by:

Export in interface IMSTFileFormat

Parameters:

DestFileName - name of file in which the file is to be saved.

outputtype - MIME type of file which is to be saved.

Returns:

Throws:

MSTException

Export

public boolean Export(java.io.FileOutputStream fos,
             OutputType outputtype)
               throws MSTException

Description copied from interface: IMSTFileFormat

Exports the file in specified output type.

Specified by:

Export in interface IMSTFileFormat

Parameters:

fos - streaming file in which output image is saved.

outputtype - MIME type of file which is to be saved.

Returns:

Throws:

MSTException

Export

public boolean Export(java.lang.String DestFileName,
             OutputType outputtype,
             java.lang.String Annotations,
             SAVEOPTION options)
               throws MSTException

Description copied from interface: IMSTFileFormat

Exports the file in specified output type.

Specified by:

Export in interface IMSTFileFormat

Parameters:

DestFileName - name of file in which the file is to be saved.

outputtype - MIME type of file which is to be saved.

Annotations - string contains the data about annotation.

options - saving options with specified output type with scaling,bitdepth,rotation,compression,annotation,pageno.

Returns:

Throws:

MSTException

Export

public boolean Export(java.io.FileOutputStream fos,
             OutputType outputtype,
             java.lang.String Annotations,
             SAVEOPTION options)
               throws MSTException

Description copied from interface: IMSTFileFormat

Exports the file in specified output type.

Specified by:

Export in interface IMSTFileFormat

Parameters:

fos - streaming file in which output image is saved.

outputtype - MIME type of file which is to be saved.

Annotations - string contains the data about annotation.

options - saving options with specified output type with scaling,bitdepth,rotation,compression,annotation,pageno.

Returns:

Throws:

MSTException

Detect

public FileFormat Detect()
                  throws MSTException

Description copied from interface: IMSTFileFormat

Gives the file format for the corresponding IMSTFileFormat object.

Specified by:

Detect in interface IMSTFileFormat

Returns:

Throws:

MSTException

getCompression

public int getCompression()

Description copied from interface: IMSTFileFormat

Gives the value of compression of loaded image.

Specified by:

getCompression in interface IMSTFileFormat

Returns:

compression.