Package io.keikai.model

Interface SPivotDataField

All Known Implementing Classes:

PivotDataFieldImpl

public interface SPivotDataField

Represents a data (value) field in a pivot table.

Since:

7.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	SPivotDataField.ShowDataAs	How the data values are displayed relative to other values.
static enum	SPivotDataField.Subtotal	Aggregation function (subtotal type) for this data field.

Method Summary

Modifier and Type	Method	Description
int	getBaseFieldIndex()	Returns the index of the base cache field.
String	getName()	Returns the display name of this data field.
String	getNumberFormat()	Returns the number format string for this data field.
SPivotDataField.ShowDataAs	getShowDataAs()	Returns how values are displayed.
SPivotDataField.Subtotal	getSubtotal()	Returns the subtotal (aggregation) function.
void	setName(String name)	Sets the display name of this data field.
void	setNumberFormat(String format)	Sets the number format string for this data field.
void	setShowDataAs(SPivotDataField.ShowDataAs showAs)	Sets how values are displayed.
void	setSubtotal(SPivotDataField.Subtotal subtotal)	Sets the subtotal (aggregation) function.

Method Details

getName

String getName()

Returns the display name of this data field.

Returns:

the name

setName

void setName(String name)

Sets the display name of this data field.

Parameters:

name - the name

getBaseFieldIndex

int getBaseFieldIndex()

Returns the index of the base cache field.

Returns:

the cache field index

getSubtotal

SPivotDataField.Subtotal getSubtotal()

Returns the subtotal (aggregation) function.

Returns:

the subtotal type

setSubtotal

void setSubtotal(SPivotDataField.Subtotal subtotal)

Sets the subtotal (aggregation) function.

Parameters:

subtotal - the subtotal type

getShowDataAs

SPivotDataField.ShowDataAs getShowDataAs()

Returns how values are displayed.

Returns:

the show-data-as mode

setShowDataAs

void setShowDataAs(SPivotDataField.ShowDataAs showAs)

Sets how values are displayed.

Parameters:

showAs - the show-data-as mode

getNumberFormat

String getNumberFormat()

Returns the number format string for this data field.

Returns:

the number format, or null if default

setNumberFormat

void setNumberFormat(String format)

Sets the number format string for this data field.

Parameters:

format - the number format