com.f1j.ss.pivot
Interface SummaryFieldSettings

public interface SummaryFieldSettings

extends BaseFieldSettings

this interface defines the PivotRange field settings API for summary fields.

Inner Class Summary

static class

SummaryFieldSettings.ECalculationType

Inner classes inherited from class com.f1j.ss.pivot.BaseFieldSettings

BaseFieldSettings.EFunctionType

Method Summary

boolean	allowBaseFields() Indicates whether setting of the base field should be allowed.
boolean	allowBaseItems() Indicates whether setting of the base item should be allowed.
java.lang.String	getBaseField(int index) Returns the name of the base field at the specified index.
int	getBaseFieldCount() Returns the number of base fields.
java.lang.String	getBaseItem(int index) Returns the name of the base item at the specified index.
int	getBaseItemCount() Returns the number of base items.
SummaryFieldSettings.ECalculationType	getCalculation() Returns the current calculation type.
java.lang.String	getCurrentBaseField() Returns the name of the current base field.
java.lang.String	getCurrentBaseItem() Returns the name of the current base item.
BaseFieldSettings.EFunctionType	getFunction() Returns the current function.
void	setCalculation(SummaryFieldSettings.ECalculationType calculation) Sets the current calculation type.
void	setCurrentBaseField(java.lang.String name) Sets the name of the current base field.
void	setCurrentBaseItem(java.lang.String name) Sets the name of the current base item.
void	setFunction(BaseFieldSettings.EFunctionType function) Sets the current function.

Methods inherited from interface com.f1j.ss.pivot.BaseFieldSettings

getName, getNumberFormat, setName, setNumberFormat

Methods inherited from interface com.f1j.util.Lockable

getLock, releaseLock

Method Detail

allowBaseFields

public boolean allowBaseFields()

Indicates whether setting of the base field should be allowed.

Returns:

boolean. true = if base field should be allowed.

Since:

11.0

allowBaseItems

public boolean allowBaseItems()

Indicates whether setting of the base item should be allowed.

Returns:

boolean. true = if base item should be allowed.

Since:

11.0

getCurrentBaseField

public java.lang.String getCurrentBaseField()

Returns the name of the current base field.

Returns:

The name of the base field.

Since:

11.0

getCurrentBaseItem

public java.lang.String getCurrentBaseItem()

Returns the name of the current base item.

Returns:

The name of the base item.

Since:

11.0

getBaseField

public java.lang.String getBaseField(int index)
                              throws com.f1j.util.InvalidIndexException,
                                     F1Exception

Returns the name of the base field at the specified index.

Returns:

Name of the base field at the specified index.

Throws:

com.f1j.util.InvalidIndexException - if index is invalid.

F1Exception - if an error occurs.

Since:

11.0

getBaseItem

public java.lang.String getBaseItem(int index)
                             throws com.f1j.util.InvalidIndexException,
                                    F1Exception

Returns the name of the base item at the specified index.

Returns:

Name of the base item at the specified index.

Throws:

com.f1j.util.InvalidIndexException - if index is invalid.

F1Exception - if an error occurs.

Since:

11.0

getCalculation

public SummaryFieldSettings.ECalculationType getCalculation()

Returns the current calculation type.

Returns:

The current calculation.

Since:

11.0

getFunction

public BaseFieldSettings.EFunctionType getFunction()

Returns the current function.

Returns:

The current function.

Since:

11.0

getBaseFieldCount

public int getBaseFieldCount()

Returns the number of base fields.

Returns:

Number of base fields.

Since:

11.0

getBaseItemCount

public int getBaseItemCount()

Returns the number of base items.

Returns:

Number of base items.

Since:

11.0

setCurrentBaseField

public void setCurrentBaseField(java.lang.String name)

Sets the name of the current base field.

Parameters:

name - The name of the base field.

Since:

11.0

setCurrentBaseItem

public void setCurrentBaseItem(java.lang.String name)
                        throws InvalidArgumentException,
                               F1Exception

Sets the name of the current base item.

Parameters:

name - The name of the base item.

Since:

11.0

setCalculation

public void setCalculation(SummaryFieldSettings.ECalculationType calculation)
                    throws com.f1j.util.InvalidIndexException,
                           F1Exception

Sets the current calculation type.

Parameters:

calculation - The calculation type to use.

Throws:

com.f1j.util.InvalidIndexException - if calculation index is invalid.

F1Exception - if an error occurs.

Since:

11.0

setFunction

public void setFunction(BaseFieldSettings.EFunctionType function)
                 throws com.f1j.util.InvalidIndexException,
                        F1Exception

Sets the current function.

Parameters:

function - The desired function type.

Throws:

com.f1j.util.InvalidIndexException - if function index is invalid.

F1Exception - if an error occurs.

Since:

11.0