MST.Imaging.FileFormats

Interface IMSTFileFormat

All Known Implementing Classes:

MSTDocument, MSTImage, MSTPdf

public interface IMSTFileFormat

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FileName
static java.io.InputStream	FileStream
static int	PageCount
static int	Size
static java.net.URI	Uri

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.
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[] nPageNo, PageInfo[] pageInfo) Gives the information about the given array of pages .
boolean	GetPageInfo(int nPageNo, PageInfo pageInfo) Gives the information about a specific page .
IMSTPage[]	GetPages(int FromPage, int ToPage, java.util.List<PageInfo> lstPageInfo) 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.

Field Detail

FileName

static final java.lang.String FileName

PageCount

static final int PageCount

See Also:

Constant Field Values

Size

static final int Size

See Also:

Constant Field Values

FileStream

static final java.io.InputStream FileStream

Uri

static final java.net.URI Uri

Method Detail

getFileName

java.lang.String getFileName()

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

Returns:

filename.

getSize

int getSize()

Gives the size of byte array of the loaded file.

Returns:

filesize.

getCompression

int getCompression()

Gives the value of compression of loaded image.

Returns:

compression.

getPageCount

int getPageCount()

Gives the number of pages in the file.

Returns:

page count.

getFileStream

java.io.InputStream getFileStream()

Gives the Inputstream of the file.

Returns:

Inputstream.

Load

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

This method loads the image data into the MSTImage object.

Parameters:

FileName - Either name or the path of file.

Returns:

Boolean true if image is loaded successfully otherwise false.

Throws:

MSTException

Load

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

This method loads the image data into the MSTImage object.

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

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

This method loads the image data into the MSTImage object.

Parameters:

uri - URI path of the file.

Returns:

Boolean true if image is loaded successfully otherwise false.

Throws:

MSTException

GetPage

IMSTPage GetPage(int pageNo)
                 throws MSTException

This method loads the page data into the IMSTPage object.

Parameters:

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

Returns:

IMSTPage Contains the page data.

Throws:

MSTException

GetPage

IMSTPage GetPage(int PageNo,
               PageInfo pgInfo)
                 throws MSTException

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

Parameters:

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

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

Returns:

IMSTPage Contains the page data.

Throws:

MSTException

GetPages

IMSTPage[] GetPages(int FromPage,
                  int ToPage,
                  java.util.List<PageInfo> lstPageInfo)
                    throws MSTException

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

Parameters:

FromPage - Range of pages.

ToPage - Range of pages.

lstPageInfo - List having the PageInfo objects

Returns:

IMSTPage Contains the page data.

Throws:

MSTException

GetPageInfo

boolean GetPageInfo(int nPageNo,
                  PageInfo pageInfo)
                    throws MSTException

Gives the information about a specific page .

Parameters:

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

pageInfo - PageInfo object reference.

Returns:

Throws:

MSTException

GetPageInfo

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

Gives the information about the given array of pages .

Parameters:

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

pageInfo - PageInfo object reference.

Returns:

Throws:

MSTException

Export

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

Exports the file in specified output type .

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

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

Exports the file in specified output type.

Parameters:

fos - streaming file in which output image is saved.

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

Returns:

Throws:

MSTException

Export

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

Exports the file in specified output type.

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

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

Exports the file in specified output type.

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

FileFormat Detect()
                  throws MSTException

Gives the file format for the corresponding IMSTFileFormat object.

Returns:

Throws:

MSTException

DropDocument

boolean DropDocument()

All the reference of the corresponding document are made null.

Returns: