com.aspose.cells

Class LoadFilter

java.lang.Object

com.aspose.cells.LoadFilter

public class LoadFilter
extends java.lang.Object

Represents the filter that provides options for loading data when loading workbook from template.

Remarks

User may specify the filter options or implement their own LoadFilter to specify how to load data.

Example

The following example shows how to determine the filter options according to worksheet's properties.

 
         class LoadFilterSheet extends LoadFilter
         {
             public /*override*/ void startSheet(Worksheet sheet) 
             {
                 if ("Sheet1".equals(sheet.getName()))
                 {
                     setLoadDataFilterOptions(LoadDataFilterOptions.ALL);
                 }
                 else
                 {
                     setLoadDataFilterOptions(LoadDataFilterOptions.STRUCTURE);
                 }
             }
         }
         LoadOptions opts = new LoadOptions();
         opts.setLoadFilter(new LoadFilterSheet());
         Workbook wb = new Workbook("template.xlsx", opts);
         //Custom LoadFilter implementation
 

Constructor Summary

Constructors

Constructor and Description
LoadFilter() Constructs one LoadFilter with default filter options LoadDataFilterOptions.All.
LoadFilter(int opts) Constructs one LoadFilter with given filter options.

Method Summary

Methods

Modifier and Type	Method and Description
int	getLoadDataFilterOptions() The filter options to denote what data should be loaded.
int[]	getSheetsInLoadingOrder() Specifies the sheets(indices) and order to be loaded.
void	setLoadDataFilterOptions(int value) The filter options to denote what data should be loaded.
void	startSheet(Worksheet sheet) Prepares filter options before loading given worksheet.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadFilter

public LoadFilter()

Constructs one LoadFilter with default filter options LoadDataFilterOptions.All.

LoadFilter

public LoadFilter(int opts)

Constructs one LoadFilter with given filter options.

Parameters:

opts - LoadDataFilterOptions. the default filter options

Method Detail

getLoadDataFilterOptions

public int getLoadDataFilterOptions()

The filter options to denote what data should be loaded.

See LoadDataFilterOptions.

setLoadDataFilterOptions

public void setLoadDataFilterOptions(int value)

The filter options to denote what data should be loaded.

See LoadDataFilterOptions.

getSheetsInLoadingOrder

public int[] getSheetsInLoadingOrder()

Specifies the sheets(indices) and order to be loaded. Default is null, that denotes to load all sheets in the default order in template file. If not null and some sheet's index is not in the returned array, then the sheet will not be loaded.

startSheet

public void startSheet(Worksheet sheet)

Prepares filter options before loading given worksheet. User's implementation of LoadFilter can change the LoadDataFilterOptions here to denote how to load data for this worksheet.

Parameters:

sheet - The worksheet to be loaded. There are only few properties can be used for the given worksheet object here because most data and properties have not been loaded. The available properties are: Name, Index, VisibilityType