oracle.dss.thin.beans.crosstab
Class ThinCrosstab

java.lang.Object
  |
  +--oracle.dss.thin.beans.dataView.ThinDataview
        |
        +--oracle.dss.thin.beans.gridView.ThinGridView
              |
              +--oracle.dss.thin.beans.crosstab.ThinCrosstab

All Implemented Interfaces:

CheckpointState, ComponentTypeConverter, DataviewCommon, ErrorHandlerCallback, Formattable, GridViewCommon, Persistable, StringXMLizable, ThinBean, ThinBeanUI, ThinDataviewCommon

public class ThinCrosstab

extends ThinGridView

The crosstab bean class. The crosstab displays data in a tabular form, for analysis. The data is arranged in rows, columns, and pages. You can easily rearrange the data to see its different aspects.

To display data in this crosstab, call its setDataSource method, or use the constructor that takes a DataSource as a parameter. You can use the BI Beans DataSource bean, or you can supply your own data source. The DataAccess and DataAccess interfaces, in the oracle.dss.util package, define the methods and constants that a data source must provide.

You can set properties on the crosstab to customize its appearance and behavior. In addition, the crosstab has several components, whose properties you can also set in order to customize the crosstab.

The ThinCrosstab generates the following events:

• BIConstants.DRILL_EVENT -- generated by drilling on a drillable component of a view
• BIConstants.PAGE_EVENT -- generated by selecting a different page of data to display
• BIConstants.INIT_FIND_MEMBER_EVENT -- generated by the "more..." selection on a page dimension in the paging control. Handled by the FindMember bean
• BIConstants.DATADRILL_EVENT -- generated by clicking on a graphic image in a databody cell
• BIConstants.HEADERDRILL_EVENT -- generated by clicking on a graphic image in a header cell
• BIConstants.NEXT_COLS_EVENT -- generated by the crosstab's column navigation control
• BIConstants.PREVIOUS_COLS_EVENT -- generated by the crosstab's column navigation control
• BIConstants.NEXT_ROWS_EVENT -- generated by the crosstab's row navigation control
• BIConstants.PREVIOUS_ROWS_EVENT -- generated by the crosstab's row navigation control

The ThinCrosstab handles the following events:

• BIConstants.ROTATE_EVENT - generated by the RotateTool bean
• BIConstants.ROTATE_EVENT -- generated by the RotateTool bean
• BIConstants.DRILL_EVENT - generated by drilling on a drillable component of a view
• BIConstants.PAGE_EVENT -- generated by selecting a different page of data to display
• BIConstants.EXPORT_EVENT -- generated by the ExportOptions bean
• BIConstants.SAVE_EVENT -- generated by the SaveAs and SaveConfirmation beans
• BIConstants.DATADRILL_EVENT -- generated by clicking on a graphic image in a databody cell
• BIConstants.HEADERDRILL_EVENT -- generated by clicking on a graphic image in a header cell
• BIConstants.NEXT_COLS_EVENT -- generated by the crosstab's column navigation control
• BIConstants.PREVIOUS_COLS_EVENT -- generated by the crosstab's column navigation control
• BIConstants.NEXT_ROWS_EVENT -- generated by the crosstab's row navigation control
• BIConstants.PREVIOUS_ROWS_EVENT -- generated by the crosstab's row navigation control

For more information about using the ThinCrosstab, see the "Thin Crosstab" topic in the BI Beans Help system.

See Also:

DataAccess, DataDirector, ThinGridView

Fields inherited from class oracle.dss.thin.beans.gridView.ThinGridView

DRILLSTATE_DRILLABLE_BIDI, DRILLSTATE_IS_DRILLED_BIDI

Fields inherited from interface oracle.dss.gridView.GridViewCommon

ABSOLUTE_COLUMN_SIZING, COLUMN_BANDING, NO_BANDING, NO_COLUMN_SIZING, RELATIVE_COLUMN_SIZING, ROW_BANDING

Fields inherited from interface oracle.dss.thin.beans.dataView.ThinDataviewCommon

INLINE_ERROR_MSG, INLINE_INFO_MSG, INLINE_WARNING_MSG

Fields inherited from interface oracle.dss.thin.beans.ThinBeanUI

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Constructor Summary

ThinCrosstab()
Constructor.

Method Summary

int	getAutoIndent() Retrieves the number of spaces that row labels of different levels are indented.
GridViewHeader	getColumnHeader() Retrieves the column header for this ThinGridView.
int	getColumnNavigationScanExtent() Get the column navigation control scan extent.
CrosstabModel	getCrosstabModel() Retrieves the model that this crosstab uses.
CrosstabSizingManager	getCrosstabSizingManager() Retrieves the sizing manager that this crosstab uses.
GridViewDatabody	getDatabody() Retrieves the databody for this ThinGridView.
PersistableAttributes	getPersistableAttributes(PersistableAttributes oldAttrs) Retrieves the attributes of this ThinDataview, for searching.
GridViewHeader	getRowHeader() Retrieves the row header for this ThinGridView.
int	getRowNavigationScanExtent() Get the row navigation control scan extent.
int	getViewType() Retrieves the type of view that implements this ThinDataviewCommon.
boolean	isColumnHeaderVisible() Indicates whether the column header appears in this ThinGridView.
boolean	isIndentEnabled() Indicates whether row labels are indented.
boolean	isOutline() Indicates whether the row header is displayed in outline form.
boolean	isRowHeaderVisible() Indicates whether the row header appears in this ThinGridView.
boolean	readXML(java.io.InputStream stream, int reset) Applies XML to this ThinDataview, from a String.
void	resetToDefault(int reset) Resets properties of this ThinDataview to their default values.
void	setAutoIndent(int i) Specifies how much to indent row labels for each level in a hierarchy.
void	setColumnHeaderVisible(boolean visible) Specifies whether the column header appears in this ThinGridView.
void	setColumnNavigationScanExtent(int extent) Set the column navigation control scan extent.
void	setIndentEnabled(boolean b) Specifies whether to indent the labels in the row header.
void	setLocale(java.util.Locale loc) Specifies the Locale for this ThinDataviewCommon.
void	setOutline(boolean b) Specifies whether the row header is displayed in outline form.
void	setRowHeaderVisible(boolean visible) Specifies whether the row header appears in this ThinGridView.
void	setRowNavigationScanExtent(int extent) Set the row navigation control scan extent.
boolean	setXML(java.lang.String xmlString, int reset) Applies XML to this ThinDataview, from a String.
boolean	setXMLAsString(java.lang.String xml) Specifies the XML representation of this ThinCrosstab.

Methods inherited from class oracle.dss.thin.beans.gridView.ThinGridView

addGridViewDataListener, applyCSSStyleDefaults, checkpointState, getBanding, getCellMaxWidth, getCellMinWidth, getCheckpointState, getCornerComponentColor, getDrillImagePath, getDrillOutCallback, getGraphicImageCount, getGraphicImagePath, getGridColor, getGridViewDatabodyStyleManager, getGridViewFormatManager, getGridViewHeaderStyleManager, getGridViewModel, getGridViewSizingManager, getHTMLColumnBlockSize, getHTMLColumnSizing, getHTMLRowBlockSize, getHTMLTableCellPadding, getHTMLTableWidth, getHTMLTextInputSize, getStartColumn, getStartRow, getState, getViewFormat, isCellEditingAllowed, isEnabled, isHGridVisible, isVGridVisible, isVisible, removeGridViewDataListener, setBanding, setBaseState, setCellEditingAllowed, setCellMaxWidth, setCellMinWidth, setCheckpointState, setCornerComponentColor, setDrillImagePath, setDrillOutCallback, setEnabled, setGraphicImagePath, setGridColor, setHGridVisible, setHTMLColumnBlockSize, setHTMLColumnSizing, setHTMLRowBlockSize, setHTMLTableCellPadding, setHTMLTableWidth, setHTMLTextInputSize, setStartColumn, setStartRow, setState, setVGridVisible, setViewFormat, setVisible

Methods inherited from class oracle.dss.thin.beans.dataView.ThinDataview

addDataListener, addErrorHandler, addThinViewListener, cleanUp, getDataDirector, getDataSource, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getDescription, getErrorHandler, getEventTarget, getExportCharacterEncoding, getHTMLPagingControlWidth, getInlineMessage, getInlineMessageType, getLocale, getLocalName, getModel, getName, getPagingControl, getPagingControlPosition, getPersistableComponents, getThinBeanName, getTokenSubstitution, getXML, getXMLAsString, handleEvent, initialize, isDrillingEnabled, isExternalFootnoteVisible, isExternalSubtitleVisible, isExternalTitleVisible, isHTMLPagingControlAutosubmit, isPagingControlVisible, isPropertyOverrideFlag, isXMLValidated, removeDataListener, removeErrorHandler, removeThinViewListener, setDataSource, setDescription, setDrillingEnabled, setEventTarget, setExportCharacterEncoding, setExternalFootnoteVisible, setExternalSubtitleVisible, setExternalTitleVisible, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setInlineMessage, setInlineMessageType, setLocalName, setName, setPagingControlPosition, setPagingControlVisible, setPersistableAttributes, setPersistableComponents, setThinBeanName, setTokenSubstitution, setXMLValidated, writeXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.dss.gridView.GridViewCommon

getCellMaxHeight, getCellMinHeight, setDefaultCornerComponentColor

Methods inherited from interface oracle.dss.dataView.DataviewCommon

getDataSource, getErrorHandler, getHTMLPagingControlWidth, getLocale, getModel, isHTMLPagingControlAutosubmit, setDataSource, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth

Methods inherited from interface oracle.dss.rules.ComponentTypeConverter

convertComponentTypeToInteger, convertComponentTypeToString

Constructor Detail

ThinCrosstab

public ThinCrosstab()

Constructor. Call the setDataSource method to specify the data that this crosstab displays.

Method Detail

getCrosstabSizingManager

public CrosstabSizingManager getCrosstabSizingManager()

Retrieves the sizing manager that this crosstab uses. The sizing manager is responsible for the width of the columns in the crosstab. Note : The sizing manager is shared with the Java Client Crosstab, so it does contain sizing rules for cell heights. ThinCrosstab does not support sizing of cell heights.

Returns:

The sizing manager that this crosstab uses.

getCrosstabModel

public CrosstabModel getCrosstabModel()

Retrieves the model that this crosstab uses. In the Model-View-Controller architecture, the model is responsible for handling the data that is displayed in a view. In the full BI Beans set, the DataSource is the "big" model. The model that this method returns interacts with the DataSource, retrieving data and having the data formatted so that the view can display it.

Returns:

The CrosstabModel that this crosstab uses.

setLocale

public void setLocale(java.util.Locale loc)

Description copied from interface: ThinDataviewCommon

Specifies the Locale for this ThinDataviewCommon.

Overrides:

setLocale in class ThinGridView

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Parameters:

loc - The Locale for this ThinDataviewCommon.

getDatabody

public GridViewDatabody getDatabody()

Description copied from class: ThinGridView

Retrieves the databody for this ThinGridView.

Overrides:

getDatabody in class ThinGridView

Following copied from class: oracle.dss.thin.beans.gridView.ThinGridView

Returns:

The databody for this ThinGridView.

getColumnHeader

public GridViewHeader getColumnHeader()

Description copied from class: ThinGridView

Retrieves the column header for this ThinGridView.

Overrides:

getColumnHeader in class ThinGridView

Following copied from class: oracle.dss.thin.beans.gridView.ThinGridView

Returns:

The column header for this ThinGridView.

getRowHeader

public GridViewHeader getRowHeader()

Description copied from class: ThinGridView

Retrieves the row header for this ThinGridView.

Overrides:

getRowHeader in class ThinGridView

Following copied from class: oracle.dss.thin.beans.gridView.ThinGridView

Returns:

The row header for this ThinGridView.

setIndentEnabled

public void setIndentEnabled(boolean b)

Specifies whether to indent the labels in the row header.

Parameters:

b - true to indent labels, false to align all the labels.

isIndentEnabled

public boolean isIndentEnabled()

Indicates whether row labels are indented.

Returns:

true if row labels are indented, false if they are all aligned.

setAutoIndent

public void setAutoIndent(int i)

Specifies how much to indent row labels for each level in a hierarchy. This method specifies the number of spaces to indent each level.

Parameters:

i - The number of spaces to indent each level.

getAutoIndent

public int getAutoIndent()

Retrieves the number of spaces that row labels of different levels are indented.

Returns:

The number of spaces that each level is indented.

setOutline

public void setOutline(boolean b)

Specifies whether the row header is displayed in outline form. In outline form, the row labels appear in one column. Labels for different levels in a hierarchy are indented.

When the row header is not in outline form, each dimension, and each level in a dimension, appears in a different column.

Parameters:

b - true to use outline form for the row header, false to use multiple columns.

isOutline

public boolean isOutline()

Indicates whether the row header is displayed in outline form. In outline form, the row labels appear in one column. Labels for different levels in a hierarchy are indented.

When the row header is not in outline form, each dimension, and each level in a dimension, appears in a different column.

Returns:

true if the row header appears in outline form, false if the row header uses multiple columns for labels.

setRowNavigationScanExtent

public void setRowNavigationScanExtent(int extent)

Set the row navigation control scan extent. The scan extent controls how many rows are scanned to figure out the levels that need to populate the row navigation control. If the scan extent is set to -1, then all rows will be scanned. If the scan extent is set to 0, then the scan extent is equal to the row block size.

Parameters:

extent - the scan extent

getRowNavigationScanExtent

public int getRowNavigationScanExtent()

Get the row navigation control scan extent. The scan extent controls how many rows are scanned to figure out the levels that need to populate the row navigation control. If the scan extent is set to -1, then all rows will be scanned. If the scan extent is set to 0, then the scan extent is equal to the row block size.

Returns:

the scan extent

setColumnNavigationScanExtent

public void setColumnNavigationScanExtent(int extent)

Set the column navigation control scan extent. The scan extent controls how many columns are scanned to figure out the levels that need to populate the column navigation control. If the scan extent is set to -1, then all columns will be scanned. If the scan extent is set to 0, then the scan extent is equal to the column block size.

Parameters:

extent - the scan extent

getColumnNavigationScanExtent

public int getColumnNavigationScanExtent()

Get the column navigation control scan extent. The scan extent controls how many columns are scanned to figure out the levels that need to populate the column navigation control. If the scan extent is set to -1, then all columns will be scanned. If the scan extent is set to 0, then the scan extent is equal to the column block size.

Returns:

the scan extent

setXMLAsString

public boolean setXMLAsString(java.lang.String xml)
                       throws BIPersistenceException

Specifies the XML representation of this ThinCrosstab. The persistence service calls this method when the view is restored from the BI Beans Catalog. This method does not reset any properties before applying the XML to this ThinCrosstab.

Application developers should not call this method. To load XML from a file, call setXML or readXML.

Overrides:

setXMLAsString in class ThinDataview

Parameters:

xml - The XML representation of the view.

Returns:

true if the XML was successfully set, false if not.

Throws:

BIPersistenceException - If a problem occurs in setting the XML.

See Also:

ThinDataview.readXML(java.io.InputStream, int), setXML(java.lang.String, int)

getPersistableAttributes

public PersistableAttributes getPersistableAttributes(PersistableAttributes oldAttrs)

Description copied from class: ThinDataview

Retrieves the attributes of this ThinDataview, for searching. This method adds the attributes that this ThinDataview defines to the attributes that the application has specified. The attributes are used by the persistence service, when users search the repository for components that have particular attribute values.

Overrides:

getPersistableAttributes in class ThinDataview

Following copied from class: oracle.dss.thin.beans.dataView.ThinDataview

Parameters:

attrs - The searchable attributes that the application has specified for this ThinDataview.

Returns:

A PersistableAttributes that includes the application specified attributes as well as the attributes that are specific to this ThinDataview.

getViewType

public int getViewType()

Description copied from interface: ThinDataviewCommon

Retrieves the type of view that implements this ThinDataviewCommon.

Overrides:

getViewType in class ThinDataview

Following copied from interface: oracle.dss.thin.beans.dataView.ThinDataviewCommon

Returns:

A constant that represents the type of view. Valid constants are listed in the See Also section.

See Also:

Dataview.VIEW_TYPE_CROSSTAB, Dataview.VIEW_TYPE_GRAPH, Dataview.VIEW_TYPE_TABLE

setXML

public boolean setXML(java.lang.String xmlString,
                      int reset)
               throws BIIOException,
BISAXException,
BIParseException

Description copied from class: ThinDataview

Applies XML to this ThinDataview, from a String. This method reads the XML from xmlString and applies its attribute settings to this ThinDataview. The reset parameter determines how much of the ThinDataview to reset before applying XML. In general, you can:

• Apply the XML to the current ThinDataview without resetting anything to default values
• Reset property values only, leaving registered listeners and callbacks
• Reset property values and remove any listeners and callbacks that have been registered with this ThinDataview

Resetting returns property values in the ThinDataview to the default values for the version that is specified in the XML.

Overrides:

setXML in class ThinDataview

Following copied from class: oracle.dss.thin.beans.dataView.ThinDataview

Parameters:

xmlString - The XML to apply to this ThinDataview.

reset - A constant that indicates how much and how far to reset the view before applying XML. Valid constants appear in the See Also section. If you pass an invalid constant, then this method logs a message with the error handler and does not reset any property values.

Returns:

true if the XML is successfully applied to this ThinDataview, false if an IO exception occurs.

Throws:

BIIOException - If an error occurs in reading xmlString.

BISAXException - If a general SAX exception occurs in parsing the XML.

BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

See Also:

Dataview.RESET_NONE, Dataview.RESET_XML_PROPERTIES, Dataview.RESET_EVERYTHING

readXML

public boolean readXML(java.io.InputStream stream,
                       int reset)
                throws BIIOException,
BISAXException,
BIParseException

Description copied from class: ThinDataview

Applies XML to this ThinDataview, from a String. This method reads the XML from xmlString and applies its attribute settings to this ThinDataview. The reset parameter determines how much of the ThinDataview to reset before applying XML. In general, you can:

• Apply the XML to the current ThinDataview without resetting anything to default values
• Reset property values only, leaving registered listeners and callbacks
• Reset property values and remove any listeners and callbacks that have been registered with this ThinDataview

Resetting returns property values in the ThinDataview to the default values for the version that is specified in the XML.

Overrides:

readXML in class ThinDataview

Following copied from class: oracle.dss.thin.beans.dataView.ThinDataview

Parameters:

stream - The XML to apply to this ThinDataview.

reset - A constant that indicates how much and how far to reset the view before applying XML. Valid constants appear in the See Also section. If you pass an invalid constant, then this method logs a message with the error handler and does not reset any property values.

Returns:

true if the XML is successfully applied to this ThinDataview, false if an IO exception occurs.

Throws:

BIIOException - If an error occurs in reading xmlString.

BISAXException - If a general SAX exception occurs in parsing the XML.

BIParseException - If the XML syntax is not correct, or if the XML is not valid according to the DTD that is specified in the XML.

See Also:

Dataview.RESET_NONE, Dataview.RESET_XML_PROPERTIES, Dataview.RESET_EVERYTHING

resetToDefault

public void resetToDefault(int reset)

Description copied from class: ThinDataview

Resets properties of this ThinDataview to their default values. The reset parameter determines whether to reset only the properties or to reset the properties and remove registered listeners and callbacks.

When reset is RESET_EVERYTHING, then this method removes event targets as well.

This method is helpful when you want to reuse a ThinDataview rather than instantiate a new one.

Overrides:

resetToDefault in class ThinGridView

Following copied from class: oracle.dss.thin.beans.dataView.ThinDataview

Parameters:

reset - A constant that indicates how much to reset. Valid constants are listed in the See Also section. If you pass an invalid value or RESET_NONE, then this method logs a message with the error handler and does not change any properties.

See Also:

Dataview.RESET_XML_PROPERTIES, Dataview.RESET_EVERYTHING

isColumnHeaderVisible

public boolean isColumnHeaderVisible()

Description copied from class: ThinGridView

Indicates whether the column header appears in this ThinGridView.

Overrides:

isColumnHeaderVisible in class ThinGridView

Following copied from class: oracle.dss.thin.beans.gridView.ThinGridView

Returns:

true if the column header appears, false if it does not.

setColumnHeaderVisible

public void setColumnHeaderVisible(boolean visible)

Description copied from class: ThinGridView

Specifies whether the column header appears in this ThinGridView.

Overrides:

setColumnHeaderVisible in class ThinGridView

Following copied from class: oracle.dss.thin.beans.gridView.ThinGridView

Parameters:

visible - true to display the column header, false to hide it.

isRowHeaderVisible

public boolean isRowHeaderVisible()

Description copied from class: ThinGridView

Indicates whether the row header appears in this ThinGridView.

Overrides:

isRowHeaderVisible in class ThinGridView

Following copied from class: oracle.dss.thin.beans.gridView.ThinGridView

Returns:

true if the row header appears, false if it does not.

setRowHeaderVisible

public void setRowHeaderVisible(boolean visible)

Description copied from class: ThinGridView

Specifies whether the row header appears in this ThinGridView.

Overrides:

setRowHeaderVisible in class ThinGridView

Following copied from class: oracle.dss.thin.beans.gridView.ThinGridView

Parameters:

visible - true to display the row header, false to hide it.