com.f1j.ss.pivot
Interface PivotRangeDef

public interface PivotRangeDef

extends Lockable

This interface defines the API for defining a PivotRange.

Since:

11.0

Inner Class Summary

static class

PivotRangeDef.ELocationType Enumeration class for defining PivotRange locations.

Method Summary

DataSourceInfo	getDataSourceInfo() Returns a DataSourceInfo object that can be used to define the data source for the PivotRange being created or modified.
java.lang.String	getLocation() Returns the formula defining the top left corner of the PivotRange in US English.
int	getLocationColumn() Returns the starting column for the defined PivotRange.
java.lang.String	getLocationLocal() Returns the formula defining the top left corner of the PivotRange in the user's language.
int	getLocationRow() Returns the starting row for the defined PivotRange.
Sheet	getLocationSheet() Returns the target worksheet for the defined PivotRange.
PivotRangeDef.ELocationType	getLocationType() Returns whether the defined PivotRange should be placed on a new worksheet or an existing worksheet.
PivotRangeOptions	getOptions() Returns a PivotRangeOptions object that can be used to define specific characteristics of the PivotRange being created or modified.
void	setLocation(Sheet sheet, int row, int column) Defines the location of the PivotRange.
void	setLocation(java.lang.String strLoc) Defines the location of the PivotRange using a formula in US English.
void	setLocationLocal(java.lang.String strLoc) Defines the location of the PivotRange using a formula in the user's language.
void	setLocationType(PivotRangeDef.ELocationType type) Sets whether the PivotRange should be placed on a new worksheet or an existing worksheet.
void	setOptions(PivotRangeOptions options) Sets the characteristics of the PivotRange being defined.

Methods inherited from interface com.f1j.util.Lockable

getLock, releaseLock

Method Detail

getDataSourceInfo

public DataSourceInfo getDataSourceInfo()

Returns a DataSourceInfo object that can be used to define the data source for the PivotRange being created or modified.

Returns:

An object with information about the PivotRange's data source.

Since:

11.0

See Also:

DataSourceInfo, PivotRange

getLocationColumn

public int getLocationColumn()

Returns the starting column for the defined PivotRange.

Returns:

The starting column for the PivotRange.

Since:

11.0

See Also:

PivotRange

getLocationSheet

public Sheet getLocationSheet()

Returns the target worksheet for the defined PivotRange.

Returns:

The target worksheet for the PivotRange.

Since:

11.0

See Also:

PivotRange, Sheet

getLocationRow

public int getLocationRow()

Returns the starting row for the defined PivotRange.

Returns:

the starting row for the PivotRange

Since:

11.0

See Also:

PivotRange

getLocation

public java.lang.String getLocation()

Returns the formula defining the top left corner of the PivotRange in US English.

Returns:

A formula defining the top left corner of the PivotRange.

Since:

11.0

See Also:

PivotRange

getLocationLocal

public java.lang.String getLocationLocal()

Returns the formula defining the top left corner of the PivotRange in the user's language.

Returns:

A formula defining the top left corner of the PivotRange.

Since:

11.0

See Also:

PivotRange

getLocationType

public PivotRangeDef.ELocationType getLocationType()

Returns whether the defined PivotRange should be placed on a new worksheet or an existing worksheet.

Returns:

An enumeration that indicates whether to use a new worksheet or an existing worksheet.

Since:

11.0

See Also:

PivotRangeDef.ELocationType, PivotRange

getOptions

public PivotRangeOptions getOptions()

Returns a PivotRangeOptions object that can be used to define specific characteristics of the PivotRange being created or modified.

Returns:

An object containing specific characteristics of the PivotRange.

Since:

11.0

See Also:

PivotRange, PivotRangeOptions

setLocation

public void setLocation(Sheet sheet,
                        int row,
                        int column)

Defines the location of the PivotRange.

Parameters:

sheet - The worksheet that contains the PivotRange.

row - The row where the PivotRange starts.

column - The column where the PivotRange starts.

Since:

11.0

See Also:

PivotRange, Sheet

setLocation

public void setLocation(java.lang.String strLoc)
                 throws F1Exception

Defines the location of the PivotRange using a formula in US English.

Parameters:

strLoc - A formula defining the location.

Throws:

F1Exception - if formula is invalid.

Since:

11.0

See Also:

PivotRange

setLocationLocal

public void setLocationLocal(java.lang.String strLoc)
                      throws F1Exception

Defines the location of the PivotRange using a formula in the user's language.

Parameters:

strLoc - A formula defining the location.

Throws:

F1Exception - if formula is invalid.

Since:

11.0

See Also:

PivotRange

setLocationType

public void setLocationType(PivotRangeDef.ELocationType type)

Sets whether the PivotRange should be placed on a new worksheet or an existing worksheet.

Parameters:

type - An enumeration that indicates whether the PivotRange should be placed on a new worksheet or an existing worksheet.

Since:

11.0

See Also:

PivotRangeDef.ELocationType, PivotRange

setOptions

public void setOptions(PivotRangeOptions options)

Sets the characteristics of the PivotRange being defined.

Parameters:

options - An object containing the characteristics of the PivotRange being defined.

Since:

11.0

See Also:

PivotRange, PivotRangeOptions