com.f1j.ss.pivot
Interface FieldGroupDef

public interface FieldGroupDef

extends Lockable

this interface contains the API for defining a PivotRange field group.

Inner Class Summary

static class	FieldGroupDef.EDateType
static class	FieldGroupDef.EType Enumeration class identifying the type of field group.

Method Summary

boolean	allowIncrementAdjustment() Indicates whether the increment can be adjusted based on other grouping characteristics, such as the date type for date grouping.
int	getDateTypeTitleCount() Returns the number of date type titles.
java.lang.String[]	getDateTypeTitles() Returns an array of titles for the types of date grouping.
double	getFinalValue() Returns the final grouping value for this field.
java.lang.String	getFinalValueAsString() Returns the final grouping value for this field as a string.
double	getIncrement() Returns the grouping increment for this field.
java.lang.String	getIncrementAsString() Returns the final grouping increment as a string.
double	getInitialValue() Returns the initial grouping value for this field.
java.lang.String	getInitialValueAsString() Returns the initial grouping value for this field as a string.
FieldGroupDef.EType	getType() Returns an enumeration identifying the type of grouping.
boolean	isDateTypeEnabled(FieldGroupDef.EDateType dateType) Indicates whether the specified date type is enabled for grouping.
boolean	isDateTypeEnabled(int index) Indicates whether the specified date type is enabled for grouping.
void	setDateTypeEnabled(FieldGroupDef.EDateType dateType, boolean enabled) Sets whether the specified date type is enabled for grouping.
void	setDateTypeEnabled(int index, boolean enabled) Sets whether the specified date type is enabled for grouping.
void	setFinalValue(double value) Sets the final grouping value for this field.
void	setFinalValue(java.lang.String str) Sets the final grouping value for this field from a string.
void	setIncrement(double value) Sets the grouping increment for this field.
void	setIncrement(java.lang.String str) Sets the grouping increment for this field from a string.
void	setInitialValue(double value) Sets the initial grouping value for this field.
void	setInitialValue(java.lang.String str) Sets the initial grouping value for this field from a string.
void	setWantsDefaultFinalValue(boolean useDefault) Sets whether the default final group value should be used.
void	setWantsDefaultInitialValue(boolean useDefault) Sets whether the default initial group value should be used.
boolean	wantsDefaultFinalValue() Indicates that the default final group value should be used.
boolean	wantsDefaultInitialValue() Indicates that the default initiali group value should be used.

Methods inherited from interface com.f1j.util.Lockable

getLock, releaseLock

Method Detail

allowIncrementAdjustment

public boolean allowIncrementAdjustment()

Indicates whether the increment can be adjusted based on other grouping characteristics, such as the date type for date grouping.

Returns:

boolean. true = if increment can be adjusted.

Since:

11.0

getDateTypeTitles

public java.lang.String[] getDateTypeTitles()
                                     throws InvalidStateException,
                                            F1Exception

Returns an array of titles for the types of date grouping. this field must be grouped by date.

Returns:

Array of date type titles.

Throws:

InvalidStateException - if not grouped by date.

F1Exception - if an error occurs.

Since:

11.0

getFinalValue

public double getFinalValue()

Returns the final grouping value for this field. this field must be grouped by date or number.

Returns:

The final group value as a number.

Since:

11.0

See Also:

Field

getFinalValueAsString

public java.lang.String getFinalValueAsString()

Returns the final grouping value for this field as a string. this field must be grouped by date or number.

Returns:

The final group value as a string.

Since:

11.0

See Also:

Field

getIncrement

public double getIncrement()

Returns the grouping increment for this field. this field must be grouped by date or number.

Returns:

The grouping increment for this field.

Since:

11.0

See Also:

Field

getIncrementAsString

public java.lang.String getIncrementAsString()

Returns the final grouping increment as a string. this field must be grouped by date or number.

Returns:

The grouping increment for this field as a string.

Since:

11.0

See Also:

Field

getInitialValue

public double getInitialValue()

Returns the initial grouping value for this field. this field must be grouped by date or number.

Returns:

The initial group value as a number.

Since:

11.0

See Also:

Field

getInitialValueAsString

public java.lang.String getInitialValueAsString()

Returns the initial grouping value for this field as a string. this field must be grouped by date or number.

Returns:

The initial group value as a string.

Since:

11.0

See Also:

Field

getDateTypeTitleCount

public int getDateTypeTitleCount()
                          throws InvalidStateException,
                                 F1Exception

Returns the number of date type titles. this field must be grouped by date.

Returns:

The initial group value as a string.

Throws:

InvalidStateException - if not grouped by date.

F1Exception - if an error occurs.

Since:

11.0

getType

public FieldGroupDef.EType getType()

Returns an enumeration identifying the type of grouping.

Returns:

An enumeration identifying the type of grouping.

Since:

11.0

See Also:

Field

isDateTypeEnabled

public boolean isDateTypeEnabled(int index)
                          throws InvalidStateException,
                                 com.f1j.util.InvalidIndexException,
                                 F1Exception

Indicates whether the specified date type is enabled for grouping.

Parameters:

index - Index of the desired date type.

Returns:

boolean. true = if date type is enabled.

Throws:

InvalidStateException - if not grouped by date.

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

F1Exception - if an error occurs.

Since:

11.0

isDateTypeEnabled

public boolean isDateTypeEnabled(FieldGroupDef.EDateType dateType)
                          throws InvalidStateException,
                                 F1Exception

Indicates whether the specified date type is enabled for grouping.

Parameters:

dateType - Enumeration identifying the desired date type.

Returns:

boolean. true = if date type is enabled.

Throws:

InvalidStateException - if not grouped by date.

F1Exception - if an error occurs.

Since:

11.0

See Also:

FieldGroupDef.EDateType

setDateTypeEnabled

public void setDateTypeEnabled(int index,
                               boolean enabled)
                        throws InvalidStateException,
                               com.f1j.util.InvalidIndexException,
                               F1Exception

Sets whether the specified date type is enabled for grouping.

Parameters:

index - Index of the desired date type.

enabled - boolean. true = if date type is enabled.

Throws:

InvalidStateException - if not grouped by date.

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

F1Exception - if an error occurs.

Since:

11.0

setDateTypeEnabled

public void setDateTypeEnabled(FieldGroupDef.EDateType dateType,
                               boolean enabled)
                        throws InvalidStateException,
                               F1Exception

Sets whether the specified date type is enabled for grouping.

Parameters:

dateType - Enumeration identifying the desired date type.

enabled - boolean. true = if date type is enabled.

Throws:

InvalidStateException - if not grouped by date.

F1Exception - if an error occurs.

Since:

11.0

See Also:

FieldGroupDef.EDateType

setFinalValue

public void setFinalValue(double value)

Sets the final grouping value for this field. WantsDefaultFinalValue is set to false. this field must be grouped by date or number.

Parameters:

value - The final group value.

Since:

11.0

See Also:

Field

setFinalValue

public void setFinalValue(java.lang.String str)
                   throws InvalidArgumentException,
                          F1Exception

Sets the final grouping value for this field from a string. WantsDefaultFinalValue is set to false. this field must be grouped by date or number.

Parameters:

str - The final group value as a string.

Throws:

InvalidArgumentException - if str is not a date or number.

F1Exception - if an error occurs.

Since:

11.0

See Also:

Field

setIncrement

public void setIncrement(double value)

Sets the grouping increment for this field. this field must be grouped by date or number.

Parameters:

value - The grouping increment for this field.

Since:

11.0

See Also:

Field

setIncrement

public void setIncrement(java.lang.String str)
                  throws InvalidArgumentException,
                         F1Exception

Sets the grouping increment for this field from a string. this field must be grouped by date or number.

Parameters:

str - The grouping increment as a string.

Throws:

InvalidArgumentException - if str is not a date or number.

F1Exception - if an error occurs.

Since:

11.0

See Also:

Field

setInitialValue

public void setInitialValue(double value)

Sets the initial grouping value for this field. WantsDefaultInitialValue is set to false. this field must be grouped by date or number.

Parameters:

value - The initial group value.

Since:

11.0

See Also:

Field

setInitialValue

public void setInitialValue(java.lang.String str)
                     throws InvalidArgumentException,
                            F1Exception

Sets the initial grouping value for this field from a string. WantsDefaultInitialValue is set to false. this field must be grouped by date or number.

Parameters:

str - The initial group value as a string.

Throws:

InvalidArgumentException - if str is not a date or number.

F1Exception - if an error occurs.

Since:

11.0

See Also:

Field

setWantsDefaultFinalValue

public void setWantsDefaultFinalValue(boolean useDefault)

Sets whether the default final group value should be used. this field must be grouped by date or number.

Parameters:

useDefault - boolean. true = if default value should be used.

Since:

11.0

setWantsDefaultInitialValue

public void setWantsDefaultInitialValue(boolean useDefault)

Sets whether the default initial group value should be used. this field must be grouped by date or number.

Parameters:

useDefault - boolean. true = if default value should be used.

Since:

11.0

wantsDefaultFinalValue

public boolean wantsDefaultFinalValue()

Indicates that the default final group value should be used. this field must be grouped by date or number.

Returns:

boolean. true = if default value should be used.

Since:

11.0

wantsDefaultInitialValue

public boolean wantsDefaultInitialValue()

Indicates that the default initiali group value should be used. this field must be grouped by date or number.

Returns:

boolean. true = if default value should be used.

Since:

11.0