com.aspose.gridjs

Class GridJsService

java.lang.Object

com.aspose.gridjs.GridJsService

All Implemented Interfaces:

IGridJsService

public class GridJsService
extends java.lang.Object
implements IGridJsService

Provides the basic operation apis used in controller actions.

Constructor Summary

Constructors

Constructor and Description
GridJsService(GridJsOptions options) The default constructor for GridJsService

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	addImage(java.lang.String p, java.lang.String uid, java.io.InputStream filestream) Applies the add image from local file operation.
java.lang.String	addImageByURL(java.lang.String p, java.lang.String uid, java.io.InputStream filestream, java.lang.String imageurl) Applies the add image from local file operation.
boolean	checkInCacheForCollaborative(java.lang.String uid) Check wether workbook instance is in memory cache .this method is apply for Collaborative mode only.
java.lang.String	copyImage(java.lang.String p, java.lang.String uid) Applies the copy image operation.
java.lang.StringBuilder	detailFileJsonWithUid(java.lang.String filePath, java.lang.String uid) Gets JSON string for the file by the specified unique id.
void	detailStreamJson(java.io.OutputStream stream, java.lang.String filePath) Write the JSON string for the file to the stream .
void	detailStreamJsonWithUid(java.io.OutputStream stream, java.lang.String filePath, java.lang.String uid) Write the JSON string for the file to the stream by the specified unique id.
java.lang.String	download(java.lang.String p, java.lang.String uid, java.lang.String filename) Applies the download file operation
java.io.InputStream	getFile(java.lang.String fileid) Get file stream
java.io.InputStream	image(java.lang.String uid, java.lang.String picid) Get Stream of image.
java.lang.String	imageUrl(java.lang.String baseURL, java.lang.String picid, java.lang.String uid) Gets the image URL.
java.lang.StringBuilder	lazyLoadingJson(java.lang.String sheetName, java.lang.String uid) Gets the JSON string of the specified sheet in the file from the cache using the specified unique id.
void	lazyLoadingStreamJson(java.io.OutputStream stream, java.lang.String sheetName, java.lang.String uid) Writes the JSON string of the specified sheet in the file from the cache using the specified unique id to the stream..
java.lang.String	load(java.lang.String uid, java.lang.String filename) Gets the JSON string of the file from the cache using the specified unique id,set the output filename in the JSON.
byte[]	ole(java.lang.String uid, java.lang.String sheet, int oleid, java.lang.String filename) Gets the byte array data of the embedded ole object .
java.lang.String	updateCell(java.lang.String p, java.lang.String uid) Applies the update operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridJsService

public GridJsService(GridJsOptions options)

The default constructor for GridJsService

Method Detail

checkInCacheForCollaborative

public boolean checkInCacheForCollaborative(java.lang.String uid)

Check wether workbook instance is in memory cache .this method is apply for Collaborative mode only.

Specified by:

checkInCacheForCollaborative in interface IGridJsService

Parameters:

uid -

Returns:

updateCell

public java.lang.String updateCell(java.lang.String p,
                          java.lang.String uid)

Applies the update operation.

Specified by:

updateCell in interface IGridJsService

Parameters:

p - The JSON format string of update operation.

uid - The unique id for the file cache.

detailFileJsonWithUid

public java.lang.StringBuilder detailFileJsonWithUid(java.lang.String filePath,
                                            java.lang.String uid)

Gets JSON string for the file by the specified unique id. .

Specified by:

detailFileJsonWithUid in interface IGridJsService

Parameters:

filePath - The file path

uid - The unique id for the file cache.

detailStreamJsonWithUid

public void detailStreamJsonWithUid(java.io.OutputStream stream,
                           java.lang.String filePath,
                           java.lang.String uid)

Write the JSON string for the file to the stream by the specified unique id.

Specified by:

detailStreamJsonWithUid in interface IGridJsService

Parameters:

stream - The stream that will be written

filePath - The file path

uid - The unique id for the file cache.

detailStreamJson

public void detailStreamJson(java.io.OutputStream stream,
                    java.lang.String filePath)

Write the JSON string for the file to the stream .

Specified by:

detailStreamJson in interface IGridJsService

Parameters:

stream - The stream that will be written

filePath - The file path

lazyLoadingJson

public java.lang.StringBuilder lazyLoadingJson(java.lang.String sheetName,
                                      java.lang.String uid)

Gets the JSON string of the specified sheet in the file from the cache using the specified unique id.

Specified by:

lazyLoadingJson in interface IGridJsService

Parameters:

sheetName - the sheet name.

uid - The unique id for the file cache.

lazyLoadingStreamJson

public void lazyLoadingStreamJson(java.io.OutputStream stream,
                         java.lang.String sheetName,
                         java.lang.String uid)

Writes the JSON string of the specified sheet in the file from the cache using the specified unique id to the stream..

Specified by:

lazyLoadingStreamJson in interface IGridJsService

Parameters:

stream - The stream that will be written

sheetName - The sheet name.

uid - The unique id for the file cache.

addImage

public java.lang.String addImage(java.lang.String p,
                        java.lang.String uid,
                        java.io.InputStream filestream)

Applies the add image from local file operation.

Specified by:

addImage in interface IGridJsService

Parameters:

p - The JSON string parameter

uid - The unique id for the file cache.

filestream - The filestream of the image

Returns:

The JSON string result

addImageByURL

public java.lang.String addImageByURL(java.lang.String p,
                             java.lang.String uid,
                             java.io.InputStream filestream,
                             java.lang.String imageurl)

Applies the add image from local file operation.

Specified by:

addImageByURL in interface IGridJsService

Parameters:

p - The JSON string parameter

uid - The unique id for the file cache.

filestream - The filestream of the image

imageurl - Specify the image URL.

Returns:

The JSON string result

copyImage

public java.lang.String copyImage(java.lang.String p,
                         java.lang.String uid)

Applies the copy image operation.

Specified by:

copyImage in interface IGridJsService

Parameters:

p - The JSON string parameter

uid - The unique id for the file cache.

Returns:

The JSON string result

load

public java.lang.String load(java.lang.String uid,
                    java.lang.String filename)

Gets the JSON string of the file from the cache using the specified unique id,set the output filename in the JSON.

Specified by:

load in interface IGridJsService

Parameters:

uid - The unique id for the file cache.

filename - Specifies the file name in the JSON. If set to null,the default filename is: book1.

Returns:

The JSON string

image

public java.io.InputStream image(java.lang.String uid,
                        java.lang.String picid)

Get Stream of image.

Specified by:

image in interface IGridJsService

Parameters:

uid - The unique id for the file cache.

picid - The image id.

Returns:

The image stream

ole

public byte[] ole(java.lang.String uid,
         java.lang.String sheet,
         int oleid,
         java.lang.String filename)

Gets the byte array data of the embedded ole object .

Specified by:

ole in interface IGridJsService

Parameters:

uid - The unique id for the file cache.

sheetname - The worksheet name.

oleid - The id for the embedded ole object.

label - The display label of the embedded ole object.

Returns:

The byte array data of the embedded ole object .

imageUrl

public java.lang.String imageUrl(java.lang.String baseURL,
                        java.lang.String picid,
                        java.lang.String uid)

Gets the image URL.

Specified by:

imageUrl in interface IGridJsService

Parameters:

baseURL - The base action URL.

picid - The image id.

uid - The unique id for the file cache.

Returns:

The image URL

getFile

public java.io.InputStream getFile(java.lang.String fileid)

Get file stream

Specified by:

getFile in interface IGridJsService

Parameters:

fileid - the file id

Returns:

The stream of the file

download

public java.lang.String download(java.lang.String p,
                        java.lang.String uid,
                        java.lang.String filename)

Applies the download file operation

Specified by:

download in interface IGridJsService

Parameters:

p - The JSON parameter

uid - The unique id for the file cache.

filename - The file name

Returns:

The file URL