com.aspose.gridjs

Class GridJsWorkbook

java.lang.Object

com.aspose.gridjs.GridJsWorkbook

public class GridJsWorkbook
extends java.lang.Object

Represents the main entry class for GridJs

Field Summary

Fields

Modifier and Type	Field and Description
static GridCacheForStream	CacheImp Custom implemention for cache storage,If you want to store cache in stream way ,you need to set and implement it.
static GridAbstractCalculationEngine	CalculateEngine Custom implemention for calculation engine ,If you want to do custom calculation, you need to set and implement it.
static java.lang.String	PICTURE_TYPE const value for the type of the image
static GridUpdateMonitor	UpdateMonitor Gets/Sets the update monitor to track update operation

Constructor Summary

Constructors

Constructor and Description
GridJsWorkbook()

Method Summary

Methods

Modifier and Type	Method and Description
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	copyImageOrShape(java.lang.String uid, java.lang.String p) Copys image or shape.
java.lang.String	errorJson(java.lang.String msg) Gets the error message string in JSON format.
java.lang.String	exportToJson() Gets JSON string from memory data, the default filename in the JSON is: book1.
java.lang.String	exportToJson(java.lang.String filename) Gets JSON string from memory data,set the output filename in the JSON.
java.lang.StringBuilder	exportToJsonStringBuilder(java.lang.String filename) Gets JSON string from memory data,set the output filename in the JSON.
static int	getGridLoadFormat(java.lang.String extension) Gets the load format by file extension
static java.io.InputStream	getImageStream(java.lang.String uid, java.lang.String picid) Get Stream of image.
static java.lang.String	getImageUrl(java.lang.String uid, java.lang.String picid, java.lang.String delimiter) Gets the image URL.
java.lang.StringBuilder	getJsonByUid(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[]	getOle(java.lang.String uid, java.lang.String sheetname, int oleid, java.lang.String label) Gets the byte array data of the embedded ole object .
GridWorkbookSettings	getSettings() Represents the workbook settings.
static java.lang.String	getUidForFile(java.lang.String fileName) Generates a new unique id for the file cache using the given file name.
void	importExcelFile(java.io.InputStream filestream, int format) Imports the excel file from file stream with load format.
void	importExcelFile(java.io.InputStream filestream, int format, java.lang.String password) Imports the excel file from file stream with load format and open password.
void	importExcelFile(java.lang.String fileName) Imports the excel file from the file path.
void	importExcelFile(java.lang.String uid, java.io.InputStream filestream, int format) Imports the excel file from file stream.
void	importExcelFile(java.lang.String uid, java.io.InputStream filestream, int format, java.lang.String password) Imports the excel file from file stream with load format and open password.
void	importExcelFile(java.lang.String uid, java.lang.String fileName) Imports the excel file from the file path.
void	importExcelFile(java.lang.String uid, java.lang.String fileName, java.lang.String password) Imports the excel file from file path and open password.
void	importExcelFileFromJson(java.lang.String json) Imports the excel file from JSON format string.
java.lang.String	insertImage(java.lang.String uid, java.lang.String p, java.io.InputStream s, java.lang.String imageUrl) Inserts image in the worksheet from file stream or the URL,(either the file stream or the URL shall be provided) or Inserts shape ,when the p.type is one of AutoShapeType
void	jsonToStream(java.io.OutputStream stream, java.lang.String filename) Retrieve the JSON string from memory data,set the output filename in the JSON, and write it to the stream.
boolean	jsonToStreamByUid(java.io.OutputStream stream, java.lang.String uid, java.lang.String filename) Retrieve the JSON string of the file from the cache using the specified unique id,set the output filename in the JSON,and write it to the stream.
java.lang.StringBuilder	lazyLoadingJson(java.lang.String uid, java.lang.String sheetName) Gets the JSON string of the specified sheet in the file from the cache using the specified unique id.
void	lazyLoadingStream(java.io.OutputStream stream, java.lang.String uid, java.lang.String sheetName) Retrieve the JSON string of the specified sheet in the file from the cache using the specified unique id, and write it to the stream.
void	mergeExcelFileFromJson(java.lang.String uid, java.lang.String json) Applies a batch update to the memory data.
void	saveToCacheWithFileName(java.lang.String uid, java.lang.String filename, java.lang.String password) Saves the memory data to the cache file with the specified filename and also set the open password, the save format is baseed on the file extension of the filename .
void	saveToExcelFile(java.io.OutputStream stream) Saves the memory data to the sream, baseed on the origin file format.
void	saveToExcelFile(java.lang.String path) Saves the memory data to the file path,if the file has extension ,save format is baseed on the file extension .
void	saveToHtml(java.io.OutputStream stream) Saves the memory data to the sream,the save format is html
void	saveToHtml(java.lang.String path) Saves the memory data to the file path,the save format is html.
void	saveToPdf(java.io.OutputStream stream) Saves the memory data to the sream,the save format is pdf.
void	saveToPdf(java.lang.String path) Saves the memory data to the file path,the save format is pdf.
void	saveToXlsx(java.io.OutputStream stream) Saves the memory data to the sream,the save format is xlsx.
void	saveToXlsx(java.lang.String path) Saves the memory data to the file path,the save format is xlsx.
static void	setImageUrlBase(java.lang.String baseImageURL) Set the base image get action URL from controller .
void	setInterruptMonitorForLoad(GridInterruptMonitor monitor, int calculateTimeoutMilliseconds) Sets InterruptMonitor for load operation.
void	setInterruptMonitorForSave(GridInterruptMonitor monitor) Sets InterruptMonitor for save operation.
void	setSettings(GridWorkbookSettings value) Represents the workbook settings.
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

Field Detail

CacheImp

public static GridCacheForStream CacheImp

Custom implemention for cache storage,If you want to store cache in stream way ,you need to set and implement it.

CalculateEngine

public static GridAbstractCalculationEngine CalculateEngine

Custom implemention for calculation engine ,If you want to do custom calculation, you need to set and implement it.

UpdateMonitor

public static GridUpdateMonitor UpdateMonitor

Gets/Sets the update monitor to track update operation

PICTURE_TYPE

public static final java.lang.String PICTURE_TYPE

const value for the type of the image

See Also:

Constant Field Values

Constructor Detail

GridJsWorkbook

public GridJsWorkbook()

Method Detail

getSettings

public GridWorkbookSettings getSettings()

Represents the workbook settings.

setSettings

public void setSettings(GridWorkbookSettings value)

Represents the workbook settings.

setInterruptMonitorForLoad

public void setInterruptMonitorForLoad(GridInterruptMonitor monitor,
                              int calculateTimeoutMilliseconds)

Sets InterruptMonitor for load operation.

Parameters:

monitor - The InterruptMonitor instance.

calculateTimeoutMilliseconds - The time out in millisecond for load file.

setInterruptMonitorForSave

public void setInterruptMonitorForSave(GridInterruptMonitor monitor)

Sets InterruptMonitor for save operation.

Parameters:

monitor - The InterruptMonitor instance.

getJsonByUid

public java.lang.StringBuilder getJsonByUid(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.

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 StringBuilder

jsonToStreamByUid

public boolean jsonToStreamByUid(java.io.OutputStream stream,
                        java.lang.String uid,
                        java.lang.String filename)

Retrieve the JSON string of the file from the cache using the specified unique id,set the output filename in the JSON,and write it to the stream.

Parameters:

stream - The stream that will be written

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.

jsonToStream

public void jsonToStream(java.io.OutputStream stream,
                java.lang.String filename)

Retrieve the JSON string from memory data,set the output filename in the JSON, and write it to the stream.

Parameters:

stream - The stream that will be written

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

lazyLoadingStream

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

Retrieve the JSON string of the specified sheet in the file from the cache using the specified unique id, and write it to the stream.

Parameters:

stream - The stream that will be written

uid - The unique id for the file cache.

sheetName - the sheet name.

lazyLoadingJson

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

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

Parameters:

uid - The unique id for the file cache.

sheetName - the sheet name.

Returns:

The JSON string StringBuilder

importExcelFile

public void importExcelFile(java.lang.String uid,
                   java.lang.String fileName,
                   java.lang.String password)

Imports the excel file from file path and open password.

Parameters:

uid - The unique id for the file cache, if set to null,it will be generated automatically.

fileName - The full path of the file.

password - The open password of the excel file.The value can be null If no passowrd is set.

importExcelFile

public void importExcelFile(java.lang.String uid,
                   java.lang.String fileName)

Imports the excel file from the file path.

Parameters:

uid - The unique id for the file cache, if set to null,it will be generated automatically.

fileName - The full path of the file.

importExcelFile

public void importExcelFile(java.lang.String fileName)

Imports the excel file from the file path.

Parameters:

fileName - The full path of the file.

getUidForFile

public static java.lang.String getUidForFile(java.lang.String fileName)

Generates a new unique id for the file cache using the given file name.

Parameters:

fileName - The file name.

Returns:

importExcelFile

public void importExcelFile(java.lang.String uid,
                   java.io.InputStream filestream,
                   int format,
                   java.lang.String password)

Imports the excel file from file stream with load format and open password.

Parameters:

uid - The unique id for the file cache, if set to null,it will be generated automatically.

filestream - The stream of the excel file .

format - GridLoadFormat. The LoadFormat of the excel file.

password - The open password of the excel file.The value can be null If no passowrd is set

importExcelFile

public void importExcelFile(java.lang.String uid,
                   java.io.InputStream filestream,
                   int format)

Imports the excel file from file stream.

Parameters:

uid - The unique id for the file cache, if set to null,it will be generated automatically.

filestream - The stream of the excel file .

format - GridLoadFormat. The LoadFormat of the excel file.

importExcelFile

public void importExcelFile(java.io.InputStream filestream,
                   int format,
                   java.lang.String password)

Imports the excel file from file stream with load format and open password.

Parameters:

filestream - The stream of the excel file .

format - GridLoadFormat. The LoadFormat of the excel file.

password - The open password of the excel file.The value can be null If no passowrd is set.

importExcelFile

public void importExcelFile(java.io.InputStream filestream,
                   int format)

Imports the excel file from file stream with load format.

Parameters:

filestream - The stream of the excel file .

format - GridLoadFormat. The LoadFormat of the excel file.

importExcelFileFromJson

public void importExcelFileFromJson(java.lang.String json)

Imports the excel file from JSON format string.

Parameters:

json - The JSON format string.

mergeExcelFileFromJson

public void mergeExcelFileFromJson(java.lang.String uid,
                          java.lang.String json)

Applies a batch update to the memory data.

Parameters:

uid - The unique id for the file cache.

json - The update JSON format string.

exportToJson

public java.lang.String exportToJson(java.lang.String filename)

Gets JSON string from memory data,set the output filename in the JSON.

Parameters:

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

Returns:

The JSON string.

exportToJson

public java.lang.String exportToJson()

Gets JSON string from memory data, the default filename in the JSON is: book1.

Returns:

The JSON string.

exportToJsonStringBuilder

public java.lang.StringBuilder exportToJsonStringBuilder(java.lang.String filename)

Gets JSON string from memory data,set the output filename in the JSON.

Parameters:

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

Returns:

The JSON StringBuilder.

saveToExcelFile

public void saveToExcelFile(java.io.OutputStream stream)

Saves the memory data to the sream, baseed on the origin file format.

Parameters:

stream - The stream to save.

saveToExcelFile

public void saveToExcelFile(java.lang.String path)

Saves the memory data to the file path,if the file has extension ,save format is baseed on the file extension .

Parameters:

path - The file path to save.

saveToCacheWithFileName

public void saveToCacheWithFileName(java.lang.String uid,
                           java.lang.String filename,
                           java.lang.String password)

Saves the memory data to the cache file with the specified filename and also set the open password, the save format is baseed on the file extension of the filename .

Parameters:

uid - The unique id for the file cache.

filename - The filename to save.

password - The excel file's open password. The value can be null If no passowrd is set.

saveToPdf

public void saveToPdf(java.lang.String path)

Saves the memory data to the file path,the save format is pdf.

Parameters:

path - The file path to save.

saveToXlsx

public void saveToXlsx(java.lang.String path)

Saves the memory data to the file path,the save format is xlsx.

Parameters:

path - The file path to save.

saveToHtml

public void saveToHtml(java.lang.String path)

Saves the memory data to the file path,the save format is html.

Parameters:

path - The file path to save.

saveToPdf

public void saveToPdf(java.io.OutputStream stream)

Saves the memory data to the sream,the save format is pdf.

Parameters:

stream - The stream to save.

saveToXlsx

public void saveToXlsx(java.io.OutputStream stream)

Saves the memory data to the sream,the save format is xlsx.

Parameters:

stream - The stream to save.

saveToHtml

public void saveToHtml(java.io.OutputStream stream)

Saves the memory data to the sream,the save format is html

Parameters:

stream - The stream to save.

getImageStream

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

Get Stream of image.

Parameters:

uid - The unique id for the file cache.

picid - The image id.

Returns:

The image stream

getOle

public byte[] getOle(java.lang.String uid,
            java.lang.String sheetname,
            int oleid,
            java.lang.String label)

Gets the byte array data of the embedded ole object .

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 .

checkInCacheForCollaborative

public boolean checkInCacheForCollaborative(java.lang.String uid)

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

Parameters:

uid -

Returns:

updateCell

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

Applies the update operation.

Parameters:

p - The JSON format string of update operation.

uid - The unique id for the file cache.

Returns:

The JSON format string of the update result.

insertImage

public java.lang.String insertImage(java.lang.String uid,
                           java.lang.String p,
                           java.io.InputStream s,
                           java.lang.String imageUrl)

Inserts image in the worksheet from file stream or the URL,(either the file stream or the URL shall be provided) or Inserts shape ,when the p.type is one of AutoShapeType

Parameters:

uid - The unique id for the file cache

p - The JSON format string for the operation which specify the cell location ,the worksheet name,upper left row,upper left column for the image锛宔tc {name:'sheet1',ri:1,ci:1}

s - The file stream of the image file

imageUrl - The URL of the image file

Returns:

The JSON format string of the inserted image

copyImageOrShape

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

Copys image or shape.

Parameters:

uid - The unique id for the file cache.

p - The JSON string for the operation which specify the cell location ,it contains the worksheet name,upper left row,upper left column for the image or shape锛宔tc {name:'sheet1',ri:1,ci:1,srcid:2,srcname:'sheet2',isshape:true}

Returns:

The JSON string of the new copied image

errorJson

public java.lang.String errorJson(java.lang.String msg)

Gets the error message string in JSON format.

Parameters:

msg - The error message.

Returns:

The JSON string.

getGridLoadFormat

public static int getGridLoadFormat(java.lang.String extension)

Gets the load format by file extension

Parameters:

extension - The file extention ,usually start with '.' .

Returns:

GridLoadFormat.

getImageUrl

public static java.lang.String getImageUrl(java.lang.String uid,
                           java.lang.String picid,
                           java.lang.String delimiter)

Gets the image URL.

Parameters:

uid - The unique id for the file cache.

picid - The image id.

delimiter - The string delimiter.

Returns:

setImageUrlBase

public static void setImageUrlBase(java.lang.String baseImageURL)

Set the base image get action URL from controller .

Remarks

when CacheImp is null,we need to set this .

Parameters:

baseImageURL - the base image get action URL.