com.sas.servlet.tbeans.olaptableview
Class BaseOLAPDrillState

com.sas.servlet.tbeans.olaptableview.BaseOLAPDrillState

All Implemented Interfaces:

ActionProviderViewInterface, HttpActionProviderInterface, HttpActionProviderViewInterface, com.sas.actionprovider.refresh.PartialRefreshActionsInterface, URLTemplateViewInterface, com.sas.beans.PropertyChangeSource, com.sas.collection.ContentsChangedListener, com.sas.lang.ObjectDataInterface, com.sas.servlet.tbeans.AJAXControllerURLInterface, RenderableInterface, TransformationInterface, com.sas.servlet.tbeans.TransformationInterface2, com.sas.util.WriteToPrintWriterInterface, java.io.Serializable, java.util.EventListener

Direct Known Subclasses:

OLAPDrillState

public abstract class BaseOLAPDrillState
implements com.sas.collection.ContentsChangedListener

The BaseOLAPDrillState is an abstract TransformationBean™

See Also:

Serialized Form

Field Summary

static int	TITLE_ALWAYS
static int	TITLE_NEVER
static int	TITLE_WHEN_CONTENT

Constructor Summary

BaseOLAPDrillState()
Constructor

Method Summary

void	contentsChanged(com.sas.collection.ContentsChangedEvent event)
int	getCellPadding() Gets the number of pixels between the border of a cell and the cell's contents.
int	getCellSpacing() Gets the number of pixels between the border of each cell.
int	getHorizontalAlignment() Returns the horizontal alignment of the OLAPDrillState component.
int	getLabelType() Returns the type of label to display at the beginning of the drill state items.
OLAPDataSetInterface	getModel() Deprecated. use getDrillStateProvider()
java.lang.String	getNoDrillStateText() Returns the text that is displayed if no drill state has been applied to the model and noDrillStateTextDisplayed is true.
java.lang.String	getSeparator() Returns the separator of the menu
java.lang.String	getSeparatorImage() Returns the separator image of the menu
java.lang.String	getTitle() Returns the title.
int	getTitleDisplayed() Determines if the title should be written out.
boolean	getUseCachedTuples() Return whether or not the object is to use the cached tuples or all the tuples when creating the drill state.
protected boolean	isDrillStateDirty() Returns true if the drill state information needs to be freshly computed from the drill state provider.
boolean	isNoDrillStateTextDisplayed() Indicates if the value of noDrillStateText is displayed when no drill state has been applied to the model.
boolean	isVisible() Returns whether or not the drill state should be rendered.
void	setActionProvider(HttpActionProvider actionProvider) Sets the HttpActionProvider object
void	setCellPadding(int cellPadding) Sets the number of pixels between the border of a cell and the cell's contents.
void	setCellSpacing(int cellSpacing) Sets the number of pixels between the border of each cell of the NavigationBar.
protected void	setDrillStateDirty(boolean dirty) Sets the flag that indicates whether the drill state needs to be freshly captured before the next rendering.
void	setHorizontalAlignment(int alignment) Sets the horizontal alignment of the OLAPDrillState component.
void	setLabelType(int labelType) Sets the type of label to display at the beginning of the drill state items.
void	setModel(OLAPDataSetInterface model) Deprecated. Use setDrillStateProvider(DrillStateProvider) instead. For example, setDrillStateProvider(new OLAPDataSetDrillStateProvider(...)).
void	setNoDrillStateText(java.lang.String noDrillStateText) Sets the text that is displayed if no drill state has been applied to the model and noDrillStateTextDisplayed is true.
void	setNoDrillStateTextDisplayed(boolean isNoDrillStateTextDisplayed) Indicates if the value of noDrillStateText is displayed when no drill state has been applied to the model.
void	setSeparator(java.lang.String separator) Sets the separator of the menu
void	setSeparatorImage(java.lang.String separatorImage) Sets the separator image of the menu
void	setTitle(java.lang.String title) Sets the title.
void	setTitleDisplayed(int isTitleDisplayed) If true then the title is written out prior to the drill state.
void	setUseCachedTuples(boolean useTupleCache) Determines whether or not the object is to use the cached tuples or all the tuples when creating the drill state.

Methods inherited from class com.sas.servlet.tbeans.BaseActionTransformation

dispose, getActionProvider, getActionSupportType, getUniqueId, isActionVisible, listActionTypes, listAreaTypes, setActionSupportType, setActionVisible, setUniqueId

Methods inherited from class com.sas.servlet.tbeans.BaseTransformation

addPropertyChangeListener, addPropertyChangeListener, cleanUpResources, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCustomAttributes, getDescription, getId, getInputTransform, getLocale, getName, getObjectData, getObjectDataProperty, getOutputTransform, getRequest, getResponse, getTagEpilog, getTagProlog, hasListeners, isCleanUpResourcesOn, removePropertyChangeListener, removePropertyChangeListener, setCleanUpResourcesOn, setCustomAttributes, setDescription, setId, setInputTransform, setLocale, setLocaleDependentProperties, setName, setObjectData, setObjectDataProperty, setOutputTransform, setRequest, setResponse, setTagEpilog, setTagProlog, setVisible, toString, write, write, write

Methods inherited from interface com.sas.servlet.tbeans.TransformationInterface

getCustomAttributes, getDescription, getId, getLocale, getName, getRequest, getResponse, getTagEpilog, getTagProlog, setCustomAttributes, setDescription, setId, setLocale, setName, setRequest, setResponse, setTagEpilog, setTagProlog, setVisible, write, write, write

Methods inherited from interface com.sas.actionprovider.HttpActionProviderViewInterface

getRequest, setRequest

Field Detail

TITLE_ALWAYS

public static final int TITLE_ALWAYS

See Also:

Constant Field Values

TITLE_NEVER

public static final int TITLE_NEVER

See Also:

Constant Field Values

TITLE_WHEN_CONTENT

public static final int TITLE_WHEN_CONTENT

See Also:

Constant Field Values

Constructor Detail

BaseOLAPDrillState

public BaseOLAPDrillState()

Constructor

Method Detail

getModel

public OLAPDataSetInterface getModel()

Deprecated. use getDrillStateProvider()

Return the model for the OLAPDtillState. Returns null if not set or a drill state provider has been set if.

Returns:

the model for the OLAPDrillState component

setModel

public void setModel(OLAPDataSetInterface model)

Deprecated. Use setDrillStateProvider(DrillStateProvider) instead. For example, setDrillStateProvider(new OLAPDataSetDrillStateProvider(...)).

Sets the model for the OLAPDrillState. The model should be set before calling the write methods. If the model is not set then an exception will be thrown when the write methods are called.

Note that invoking this method will overwrite any drill state provider set using setDrillStateProvider. Passing a null model will result in the drill state provider being set to null.

Parameters:

model - the model for the OLAPDrillState component

isDrillStateDirty

protected boolean isDrillStateDirty()

Returns true if the drill state information needs to be freshly computed from the drill state provider. Returns false otherwise. The presence and management of this flage, allows the capturing of drill state information to be delayed until it is actually needed. For example, if for some reason, this component is never attempted to written, then the cost of the drill state calculation will never be paid, however cheap or expensive it may be.

Returns:

True if the drill state information needs to be freshly computed from the drill state provider. Returns false otherwise.

setDrillStateDirty

protected void setDrillStateDirty(boolean dirty)

Sets the flag that indicates whether the drill state needs to be freshly captured before the next rendering.

Parameters:

dirty - True if drill state has been caused to become dirty for some reason and the drill state needs to be recaptured before the next rendering. False otherwise.

See Also:

isDrillStateDirty()

setLabelType

public void setLabelType(int labelType)

Sets the type of label to display at the beginning of the drill state items. Valid values are OLAPDrillStateUtil.DIMENSION, OLAPDrillStateUtil.HIERARCHY, or OLAPDrillStateUtil.NONE. The default behavior is to have no label.

Parameters:

labelType - the type of display label to use for the drill state items

getLabelType

public int getLabelType()

Returns the type of label to display at the beginning of the drill state items.

contentsChanged

public void contentsChanged(com.sas.collection.ContentsChangedEvent event)

Specified by:

contentsChanged in interface com.sas.collection.ContentsChangedListener

setActionProvider

public void setActionProvider(HttpActionProvider actionProvider)

Description copied from class: BaseActionTransformation

Sets the HttpActionProvider object

Specified by:

setActionProvider in interface HttpActionProviderInterface

Overrides:

setActionProvider in class BaseActionTransformation

Parameters:

actionProvider - object

See Also:

HttpActionProviderInterface.getActionProvider()

setSeparator

public void setSeparator(java.lang.String separator)

Sets the separator of the menu

Parameters:

value - The separator of the menu

getSeparator

public java.lang.String getSeparator()

Returns the separator of the menu

Returns:

The separator

setSeparatorImage

public void setSeparatorImage(java.lang.String separatorImage)

Sets the separator image of the menu

Parameters:

value - The separator image of the menu

getSeparatorImage

public java.lang.String getSeparatorImage()

Returns the separator image of the menu

Returns:

The separator image

getHorizontalAlignment

public int getHorizontalAlignment()

Returns the horizontal alignment of the OLAPDrillState component. Returned values can be compared against HttpConstants.LEFT, HttpConstants.CENTER, HttpConstants.RIGHT and HttpConstants.NONE. The default is HttpConstants.LEFT.

Returns:

the horizontal alignment of the OLAPDrillState component

setHorizontalAlignment

public void setHorizontalAlignment(int alignment)

Sets the horizontal alignment of the OLAPDrillState component. Valid values are HttpConstants.LEFT, HttpConstants.CENTER, HttpConstants.RIGHT and HttpConstants.NONE, with HttpConstants.LEFT being the default.

Parameters:

alignment - the horizontal alignment of the OLAPDrillState component

Throws:

java.lang.IllegalArgumentException - if alignment is invalid

getCellSpacing

public int getCellSpacing()

Gets the number of pixels between the border of each cell. The default is 0.

Returns:

the number of pixels between each cell

setCellSpacing

public void setCellSpacing(int cellSpacing)

Sets the number of pixels between the border of each cell of the NavigationBar.

Parameters:

cellSpacing - the number of pixels between each cell

getCellPadding

public int getCellPadding()

Gets the number of pixels between the border of a cell and the cell's contents. The default is 1.

Returns:

the number of pixels between the cell border and the cell content

setCellPadding

public void setCellPadding(int cellPadding)

Sets the number of pixels between the border of a cell and the cell's contents. The default is 1.

Parameters:

cellPadding - the number of pixels between the cell border and the cell content

getUseCachedTuples

public boolean getUseCachedTuples()

Return whether or not the object is to use the cached tuples or all the tuples when creating the drill state. The default is false.

Returns:

true is cached tuples are used, false if all tuples are used.

setUseCachedTuples

public void setUseCachedTuples(boolean useTupleCache)

Determines whether or not the object is to use the cached tuples or all the tuples when creating the drill state. The default is false.

Parameters:

useTupleCache - true to use the cached tuples, false to use all tuples.

isVisible

public boolean isVisible()

Returns whether or not the drill state should be rendered.

Specified by:

isVisible in interface TransformationInterface

Overrides:

isVisible in class BaseTransformation

Returns:

true if the tbean should be visible, false otherwise.

setTitle

public void setTitle(java.lang.String title)

Sets the title. The title is written out before the drill state if the titleDisplayed property is true.

Parameters:

title - the String to be written out prior to the drill state when the titleDisplayed property is true

See Also:

getTitle(), setTitleDisplayed(int)

getTitle

public java.lang.String getTitle()

Returns the title. This is written out before the drill state if the titleDisplayed property is true.

Returns:

the title

See Also:

setTitle(java.lang.String)

setTitleDisplayed

public void setTitleDisplayed(int isTitleDisplayed)

If true then the title is written out prior to the drill state. If false, then no title is written out.

Parameters:

isTitleDisplayed - true if the title should be written out, false otherwise

See Also:

#isTitleDiplayed, setTitle(java.lang.String)

getTitleDisplayed

public int getTitleDisplayed()

Determines if the title should be written out. If true then the title is written out prior to the drill state. If false, then no title is written out.

Returns:

a boolean value indicating if the title should be written out

See Also:

setTitleDisplayed(int), getTitle()

setNoDrillStateText

public void setNoDrillStateText(java.lang.String noDrillStateText)

Sets the text that is displayed if no drill state has been applied to the model and noDrillStateTextDisplayed is true. The default value is "None".

Parameters:

noDrillStateText - the text that is displayed if no drill state has been applied to the model and noDrillStateTextDisplayed is true

See Also:

getNoDrillStateText()

getNoDrillStateText

public java.lang.String getNoDrillStateText()

Returns the text that is displayed if no drill state has been applied to the model and noDrillStateTextDisplayed is true. The default value is "None".

Returns:

the text that is displayed if no drill state has been applied to the model and noDrillStateTextDisplayed is true.

See Also:

setNoDrillStateText(java.lang.String)

setNoDrillStateTextDisplayed

public void setNoDrillStateTextDisplayed(boolean isNoDrillStateTextDisplayed)

Indicates if the value of noDrillStateText is displayed when no drill state has been applied to the model. No text is displayed if isNoDrillStateTextDisplayed is false. If set to true, the the value of noDrillStateText is displayed.

See Also:

isNoDrillStateDisplayed, setNoDrillStateText(java.lang.String)

isNoDrillStateTextDisplayed

public boolean isNoDrillStateTextDisplayed()

Indicates if the value of noDrillStateText is displayed when no drill state has been applied to the model. No text is displayed is the value is false. If true, value of noDrillStateText is displayed.

Returns:

true if the value of noDrillStateText is displayed when no drill state has been applied, false if no text is displayed.

See Also:

setNoDrillStateTextDisplayed(boolean)