com.f1j.ss.pivot
Interface Item

public interface Item

extends Lockable

This interface defines the PivotRange item API.

Method Summary

java.lang.String	getFormula() Returns the formula for a calculated item in US English.
java.lang.String	getFormulaLocal() Returns the formula for a calculated item in the user's language.
java.lang.String	getName() Returns the name of the item.
int	getPosition() Returns the position of the item.
java.lang.String	getSourceName() Returns the item’s name as it appears in the original source data for this PivotRange report.
boolean	isCalculated() Indicates if this item is a calculated item.
boolean	isShowingDetail() Indicates if this is item is showing detail.
boolean	isSummary() Indicates if this is a summary item in the data field.
boolean	isVisible() Indicates if this item is visible or hidden.
void	setFormula(java.lang.String formula) Sets the formula for a calculated item in US English.
void	setFormulaLocal(java.lang.String formula) Sets the formula for a calculated item in the user's language.
void	setName(java.lang.String name) Sets the name of the item.
void	setPosition(int position) Sets the position of the item.
void	setShowDetail(boolean showDetail) Sets whether this item should show detail.
void	setVisibility(boolean isVisible) Sets whether this item is visible or hidden.

Methods inherited from interface com.f1j.util.Lockable

getLock, releaseLock

Method Detail

getFormula

public java.lang.String getFormula()

Returns the formula for a calculated item in US English. If not a calculated item, returns null.

Returns:

The formula in a calculated item.

Since:

11.0

getFormulaLocal

public java.lang.String getFormulaLocal()

Returns the formula for a calculated item in the user's language. If not a calculated item, returns null.

Returns:

The formula in a calculated item.

Since:

11.0

getName

public java.lang.String getName()

Returns the name of the item.

Returns:

The name of the item.

Since:

11.0

getPosition

public int getPosition()

Returns the position of the item.

Returns:

The position of the item.

Since:

11.0

getSourceName

public java.lang.String getSourceName()

Returns the item’s name as it appears in the original source data for this PivotRange report. This might be different from the current item name if the user renamed the item after creating the PivotRange report.

Returns:

Original item name.

Since:

11.0

isCalculated

public boolean isCalculated()

Indicates if this item is a calculated item.

Returns:

boolean. true = if item is a calculated item.

Since:

11.0

isShowingDetail

public boolean isShowingDetail()

Indicates if this is item is showing detail.

Returns:

boolean. true = if item is showing detail.

Since:

11.0

isSummary

public boolean isSummary()

Indicates if this is a summary item in the data field.

Returns:

boolean. true = if item is summary.

Since:

11.0

isVisible

public boolean isVisible()

Indicates if this item is visible or hidden.

Returns:

boolean. true = if item is visible.

Since:

11.0

setFormula

public void setFormula(java.lang.String formula)
                throws DataConflictException,
                       DuplicateNameException,
                       InvalidPivotRangeException,
                       F1Exception

Sets the formula for a calculated item in US English. Only valid if item is calculated item.

Parameters:

formula - The formula to use in the calculated item.

Throws:

DataConflictException - if the PivotRange would grow too large.

DuplicateNameException - if an item already exists with the specified name.

InvalidPivotRangeException - if PivotRange is invalid.

F1Exception - if an error occurs.

Since:

11.0

setFormulaLocal

public void setFormulaLocal(java.lang.String formula)
                     throws DataConflictException,
                            DuplicateNameException,
                            InvalidPivotRangeException,
                            F1Exception

Sets the formula for a calculated item in the user's language. Only valid if item is calculated item.

Parameters:

formula - The formula to use in the calculated item.

Throws:

DataConflictException - if the PivotRange would grow too large.

DuplicateNameException - if an item already exists with the specified name.

InvalidPivotRangeException - if PivotRange is invalid.

F1Exception - if an error occurs.

Since:

11.0

setName

public void setName(java.lang.String name)
             throws InvalidPivotRangeException,
                    DuplicateNameException,
                    com.f1j.ss.pivot.InvalidNameException,
                    F1Exception

Sets the name of the item.

Parameters:

name - The name of the item.

Since:

11.0

setPosition

public void setPosition(int position)
                 throws AccessDeniedException,
                        InvalidPivotRangeException,
                        DataConflictException,
                        SelectionException,
                        F1Exception

Sets the position of the item.

Parameters:

position - The position of the item.

Throws:

AccessDeniedException - if sheet is protected.

DataConflictException - if PivotRange would grow too large.

InvalidPivotRangeException - if the PivotRange is invalid.

SelectionException - if field is a summary or is not in an area.

F1Exception - if an error occurs.

Since:

11.0

setShowDetail

public void setShowDetail(boolean showDetail)
                   throws InvalidPivotRangeException,
                          F1Exception

Sets whether this item should show detail.

Parameters:

showDetail - boolean. true = if item should show detail.

Throws:

InvalidPivotRangeException - if PivotRange is invalid.

F1Exception - if an error occurs.

Since:

11.0

setVisibility

public void setVisibility(boolean isVisible)
                   throws InvalidPivotRangeException,
                          F1Exception

Sets whether this item is visible or hidden.

Parameters:

isVisible - boolean. true = if item is visible.

Throws:

InvalidPivotRangeException - if PivotRange is invalid.

F1Exception - if an error occurs.

Since:

11.0