AccessCacheOptions

Inheritance: java.lang.Object

public final class AccessCacheOptions

Cache options for data access. Can be combined with | operator for multiple options together.

Remarks

For some features, accessing large dataset requires a lot of repeated and complicated operations such as search, calculation, …etc and those operations will take a lot of extra time. For common situations, all dependent data remains unchanged during the access, so some caches can be built and used to improve the access performance. For this purpose, we provide this API so that user can specify which kind of data access needs to be optimized by possible caching mechanism.

Please note, for different options, different data set may be required to be “read-only”. And performance of accessing data depends on many aspects, the use of caching mechanism does not guarantee that performance will be improved. For some situations, such as the dataset to be accessed is small, using cache may cause even more time because caching itself also needs certain extra time.

Fields

FieldDescription
ALLApply all possible optimizations for all kinds of data access in the workbook.
CALCULATE_FORMULAApply possible optimization for calculating formulas.
CELLS_DATAApply possible optimization for getting cells’ values.
CELL_DISPLAYApply possible optimization for getting display-related results of cells(Cell.getDisplayStringValue(), Cell.getStyle(), Cell.getDisplayStyle(), etc.).
CONDITIONAL_FORMATTINGApply possible optimization for getting formatting result of conditional formattings.
GET_FORMULAApply possible optimization for getting formulas.
NONENo cache for any data access.
POSITION_AND_SIZEApply possible optimization for getting object(such as Shape)’s position and size.
SET_FORMULAApply possible optimization for setting formulas.
VALIDATIONApply possible optimization for getting validation result.

Methods

MethodDescription
equals(Object arg0)
getClass()
hashCode()
notify()
notifyAll()
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

ALL

public static final int ALL

Apply all possible optimizations for all kinds of data access in the workbook. All settings and data should not be changed during the optimized access.

CALCULATE_FORMULA

public static final int CALCULATE_FORMULA

Apply possible optimization for calculating formulas. Cells data should not be changed during the optimized access, none new objects(Cell, Row, etc.) should be created either(such as by Cells.get(int,int)).

CELLS_DATA

public static final int CELLS_DATA

Apply possible optimization for getting cells’ values. Cells data(data and settings of Cell, Row) should not be changed during the optimized access, no new Cell/Row objects should be created either(such as by Cells.get(int,int)).

CELL_DISPLAY

public static final int CELL_DISPLAY

Apply possible optimization for getting display-related results of cells(Cell.getDisplayStringValue(), Cell.getStyle(), Cell.getDisplayStyle(), etc.). Cells data and style-related objects(Cell/Row/Column styles, column width, etc.) should not be changed during the optimized access.

CONDITIONAL_FORMATTING

public static final int CONDITIONAL_FORMATTING

Apply possible optimization for getting formatting result of conditional formattings. All data and settings which may affect the result of conditional formattings(settings of conditional formattings, dependent cell values, etc.) should not be changed during the optimized access.

GET_FORMULA

public static final int GET_FORMULA

Apply possible optimization for getting formulas. All data and settings which may affect the formula expression(Worksheet’s name, Name’s text, table’s column, etc.) should not be changed during the optimized access.

NONE

public static final int NONE

No cache for any data access.

POSITION_AND_SIZE

public static final int POSITION_AND_SIZE

Apply possible optimization for getting object(such as Shape)’s position and size. Row height and column width settings should not be changed during the optimized access.

SET_FORMULA

public static final int SET_FORMULA

Apply possible optimization for setting formulas. All data and settings which may affect the formula expression(Worksheet’s name, Name’s text, table’s column, etc.) should not be changed during the optimized access.

VALIDATION

public static final int VALIDATION

Apply possible optimization for getting validation result. All data and settings which may affect the result of validation(settings of the validation, dependent cell values, etc.) should not be changed during the optimized access.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int