|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--javax.swing.JComponent | +--javax.swing.JPanel | +--oracle.dss.dataView.Dataview | +--oracle.dss.gridView.GridView | +--oracle.dss.table.Table
The table bean class. The table displays data in the form of a relational table.
To display data in this table, call the setDataSource
method of its superclass, or use the table 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 attributes on the table to customize its appearance and behavior. In addition, the table has several components, whose attributes you can also set in order to customize the table.
getDatabody()
, Dataview.getDataviewTitle()
, Dataview.getDataviewSubtitle()
, Dataview.getDataviewFootnote()
, DataAccess
, DataDirector
, Serialized FormInner classes inherited from class javax.swing.JComponent |
javax.swing.JComponent.AccessibleJComponent |
Field Summary | |
static int |
TABLE This table. |
Fields inherited from class javax.swing.JComponent |
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
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 java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
Table() Constructor. |
Method Summary | |
void |
addTableDataListener(TableDataListener l) Adds a listener for a user clicks that affect data. |
void |
autoFit() Calculates sizes for rows and columns in this Table . |
GridViewHeader |
getColumnHeader() Retrieves the column header component for this table. |
int |
getColumnHeaderRowHeight() Retrieves the height of a row in the column header. |
java.awt.Color |
getCornerComponentColor() Retrieves the background color of the corner component. |
GridViewDatabody |
getDatabody() Retrieves the databody component for this table. |
int |
getFetchIncrement() Retrieves the number of rows to fetched in an incremental fetch. |
java.lang.String |
getFetchMessage() Retrieves the message that appears in the incremental fetch row. |
GridViewSelectionManager |
getGridViewSelectionManager() Retrieves the selection manager that this table uses. |
GridViewHeader |
getRowHeader() Retrieves the row header component for this table. |
int |
getRowHeaderColumnWidth() Retrieves the width of the column in the row header. |
int |
getStartColumn() Retrieves the index of the first column that this table displays. |
int |
getStartRow() Retrieves the index of the first row that this table displays. |
TableController |
getTableController() Retrieves the controller for this table. |
TableModel |
getTableModel() Retrieves the model that this table uses. |
TableSizingManager |
getTableSizingManager() Retrieves the sizing manager that this table uses. |
int |
getViewType() Retrieves the type of this view. |
boolean |
isColumnHeaderVisible() Indicates whether the column header appears in this table. |
boolean |
isColumnVisible(int column) Indicates whether a column is visible. |
boolean |
isHGridVisible() Indicates whether horizontal gridlines are visible in this table. |
boolean |
isIncrementalFetchEnabled() Indicates whether incremental fetch is enabled. |
boolean |
isIncrementalFetchRowVisible() Determine whether the incremental fetch row is currently visible |
boolean |
isRowHeaderVisible() Indicates whether the row header appears in this table. |
boolean |
isRowVisible(int row) Indicates whether a row is visible. |
boolean |
isVGridVisible() Specifies whether vertical gridlines are visible in this table. |
boolean |
readXML(java.io.InputStream stream, boolean reset) Deprecated. As of 1.7.0.12, replaced by readXML(InputStream, int) |
boolean |
readXML(java.io.InputStream stream, int reset) Applies XML to this Crosstab , from a String . |
void |
removeTableDataListener(TableDataListener l) Removes the listener for requests of data changes. |
void |
resetToDefault(int reset) Resets properties of this Crosstab to their default values. |
boolean |
selectObject(ComponentHandle id) Selects a component or part of a component in this table. |
void |
setBackgroundImage(java.awt.Image image) Specifies an image to display in the databody for this table. |
void |
setCellEditingAllowed(boolean b) Specifies whether any cells in this table can be edited by a user. |
void |
setColumnHeaderRowHeight(int height) Specifies the height of a row in the column header. |
void |
setColumnHeaderVisible(boolean visible) Specifies whether the column header appears in this table. |
void |
setColumnVisible(int column, boolean visible) Specifies whether a column appears. |
void |
setColumnWidth(int index, int width) Specifies the width of a column in the databody. |
void |
setCornerComponentColor(java.awt.Color c) Specifies a background color for the corner component. |
void |
setDefaultCornerComponentColor(java.awt.Color c) Specifies a default background color for the corner component. |
void |
setFetchIncrement(int i) Specifies the number of rows of data to fetch in an incremental fetch. |
void |
setFetchMessage(java.lang.String s) Specifies the message that appears in the incremental fetch row. |
void |
setHGridVisible(boolean b) Specifies whether horizontal gridlines appear in this table. |
void |
setIncrementalFetchEnabled(boolean b) Specifies whether incremental fetch is enabled. |
void |
setLocale(java.util.Locale loc) Specifies the Locale for this Dataview . |
void |
setManualColumnSizingEnabled(boolean bEnabled) Specifies whether users can manually resize columns in the databody. |
void |
setManualRowSizingEnabled(boolean bEnabled) Specifies whether users can manually resize rows in the databody. |
void |
setRowHeaderColumnWidth(int width) Specifies the width of the column in the row header. |
void |
setRowHeaderVisible(boolean visible) Specifies whether the row header appears in this table. |
void |
setRowHeight(int index, int height) Specifies the height of a row in the databody, in pixels. |
void |
setRowVisible(int row, boolean visible) Specifies whether a row appears. |
void |
setStartColumn(int c) Specifies the first column of data for this table to display. |
void |
setStartRow(int r) Specifies the first row of data to display in this table. |
void |
setVGridVisible(boolean b) Indicates whether vertical gridlines appear in this table. |
boolean |
setXML(java.lang.String xmlString, boolean reset) Deprecated. As of 1.7.0.12, replaced by setXML(String, int) |
boolean |
setXML(java.lang.String xmlString, int reset) Applies XML to this Table , from a String . |
boolean |
setXMLAsString(java.lang.String xml) Specifies the XML representation of this Table . |
Methods inherited from class javax.swing.JPanel |
getAccessibleContext, getUIClassID, updateUI |
Methods inherited from class javax.swing.JComponent |
addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update |
Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setLayout, validate |
Methods inherited from class java.awt.Component |
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocation, getLocationOnScreen, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocation, setLocation, setSize, setSize, show, show, size, toString, transferFocus |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface oracle.dss.dataView.GridViewAttribute |
applyViewFormat, applyViewStyle, getComponentViewFormat, getComponentViewStyle |
Methods inherited from interface oracle.dss.gridView.GridViewCommon |
getBanding, getCellMaxHeight, getCellMaxWidth, getCellMinHeight, getCellMinWidth, getHTMLColumnSizing, getHTMLRowBlockSize, getHTMLTableCellPadding, getHTMLTableWidth, getHTMLTextInputSize, setBanding, setHTMLColumnSizing, setHTMLRowBlockSize, setHTMLTableCellPadding, setHTMLTableWidth, setHTMLTextInputSize |
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 |
Methods inherited from interface oracle.dss.gridView.UIGridView |
dataAndMetadataStyleChanged, getAutoFitScope, getBackgroundImage, getGridColor, getGridViewDatabodyStyleManager, getGridViewFormatManager, getGridViewHeaderStyleManager, getHGridColor, getLocale, getModel, getPagingControl, getToolbarUIFormatCount, getUIFormatCount, getUIFormats, getVGridColor, isGrid3D, setAutoFitScope, setGrid3D, setGridColor, setHGridColor, setToolbarUIFormatCount, setUIFormatCount, setUIFormats, setVGridColor |
Methods inherited from interface oracle.dss.dataView.UIDataview |
addControllerListener, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getSelectedObject, getTokenSubstitution, removeControllerListener, setTokenSubstitution |
Methods inherited from interface oracle.dss.util.PagingControlAttributes |
isPagingControlVisible, setPagingControlVisible |
Methods inherited from interface oracle.dss.util.persistence.Persistable |
initialize, setPersistableComponents |
Field Detail |
public static final int TABLE
Constructor Detail |
public Table()
setDataSource
method to specify the data that this table displays.Dataview.setDataSource(oracle.dss.util.DataSource)
Method Detail |
public TableModel getTableModel()
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.TableModel
that this table uses.public TableController getTableController()
TableController
for this table.public GridViewSelectionManager getGridViewSelectionManager()
GridViewSelectionManager
also manages whether a cell can be edited by a user.getGridViewSelectionManager
in class GridView
public void setLocale(java.util.Locale loc)
Dataview
Locale
for this Dataview
.setLocale
in class GridView
oracle.dss.dataView.Dataview
loc
- The Locale
for this Dataview
.public TableSizingManager getTableSizingManager()
public boolean selectObject(ComponentHandle id)
selectObject
in class Dataview
id
- The ComponentHandle
that represents the component that you want to select.true
if the component is successfully selected, false
if id
has a structural problem. For example, this method returns false
if id
is a RowComponentHandle
that seems to represent a column instead of a row.public void setStartRow(int r)
setStartRow
in class GridView
r
- The index of the first row to display. Row indexes begin at zero. If r
is less than zero or greater than the number of rows in the Table
, then this method logs a message with the error handler, and StartRow
keeps its previous value.public int getStartRow()
getStartRow
in class GridView
public void setStartColumn(int c)
setStartColumn
in class GridView
c
- The index of the first column to display. If c
is less than zero or greater than the number of columns in the Table
, then this method logs a message with the error handler, and StartColumn
keeps its previous value.public int getStartColumn()
getStartColumn
in class GridView
public void setHGridVisible(boolean b)
setHGridVisible
in interface UIGridView
setHGridVisible
in class GridView
b
- true
to display horizontal gridlines, false
to hide them.public boolean isHGridVisible()
isHGridVisible
in interface UIGridView
isHGridVisible
in class GridView
true
horizontal gridlines are visible, false
if they are not visible.public void setVGridVisible(boolean b)
setVGridVisible
in interface UIGridView
setVGridVisible
in class GridView
b
- true
if vertical gridlines are visible, false
if they are not.public boolean isVGridVisible()
isVGridVisible
in interface UIGridView
isVGridVisible
in class GridView
true
if vertical gridlines are visible, false
if they are not visible.public void setIncrementalFetchEnabled(boolean b)
IncrementalFetch
attribute to true
, then you must add a TableDataListener
to this table, to support the incremental fetch. You should add the listener and call this method before you display this table.
When incremental fetch is enabled, the table displays the number of rows that you specify in the setFetchIncrement
method. Below the fetched rows, the table displays an "incremental fetch" row, which instructs the users to click in that row to display more data. The table then notifies any TableDataListener
that has been added. The TableDataListener
should request more rows of data from the data source to display in this table.
To specify the message that is displayed in the incremental fetch row, call the setFetchMessage
method.
b
- true
to enable incremental fetch, false
to disable it.addTableDataListener(oracle.dss.table.TableDataListener)
, setFetchIncrement(int)
, setFetchMessage(java.lang.String)
public boolean isIncrementalFetchEnabled()
isIncrementalFetchEnabled
in interface TableCommon
true
if incremental fetch is enabled, false
if it is not.setIncrementalFetchEnabled(boolean)
public boolean isIncrementalFetchRowVisible()
isIncrementalFetchRowVisible
in interface TableCommon
public void setFetchMessage(java.lang.String s)
s
- The message to display in the incremental fetch row.setIncrementalFetchEnabled(boolean)
public java.lang.String getFetchMessage()
setIncrementalFetchEnabled(boolean)
public void setFetchIncrement(int i)
i
- The number of rows to fetch.setIncrementalFetchEnabled(boolean)
public int getFetchIncrement()
setIncrementalFetchEnabled(boolean)
public void setCellEditingAllowed(boolean b)
setCellEditingAllowed
in class GridView
b
- true
to allow users to edit cells, false
to prevent any cell editing.public GridViewDatabody getDatabody()
getDatabody
in interface UIGridView
getDatabody
in class GridView
TableDatabody
public GridViewHeader getColumnHeader()
getColumnHeader
in interface UIGridView
getColumnHeader
in class GridView
ColHeader
public GridViewHeader getRowHeader()
getRowHeader
in interface UIGridView
getRowHeader
in class GridView
RowHeader
public void setColumnHeaderVisible(boolean visible)
setColumnHeaderVisible
in interface UIGridView
setColumnHeaderVisible
in class GridView
true
- to display the column header, false
to hide it.public boolean isColumnHeaderVisible()
isColumnHeaderVisible
in interface UIGridView
isColumnHeaderVisible
in class GridView
true
if the column header appears in this table, false
if it does not.public void setRowHeaderVisible(boolean visible)
setRowHeaderVisible
in interface UIGridView
setRowHeaderVisible
in class GridView
visible
- true
to display the row header, false
to hide it.public boolean isRowHeaderVisible()
isRowHeaderVisible
in interface UIGridView
isRowHeaderVisible
in class GridView
true
if the row header appears in this table, false
if it does not.public void setBackgroundImage(java.awt.Image image)
Background
attribute is null
. To make all the cells in the databody transparent, set the Background
attribute in the ViewStyle
for the databody. To make individual cells transparent, create rules and set them in the style manager for this table.setBackgroundImage
in interface UIGridView
setBackgroundImage
in class GridView
image
- The background image.GridView.getGridViewDatabodyStyleManager()
, TableDatabody.getViewStyle()
, ViewStyle
, DiscriminatorRule
public void setCornerComponentColor(java.awt.Color c)
setCornerComponentColor
in class GridView
c
- The background color to use for the corner component.public java.awt.Color getCornerComponentColor()
getCornerComponentColor
in class GridView
public void setDefaultCornerComponentColor(java.awt.Color c)
The GridView.applyCSSStyleDefaults
method calls this method to set the new default value. Application developers do not need to call this method directly.
setDefaultCornerComponentColor
in interface GridViewCommon
setDefaultCornerComponentColor
in class GridView
c
- The color to set as the new default background color for the corner component.GridView.applyCSSStyleDefaults(oracle.dss.gridView.GridViewCommon, oracle.dss.dataView.CSSStyleDefaults)
public void setColumnWidth(int index, int width)
setColumnWidth
in class GridView
index
- The column whose width you want to set. Column numbers begin at zero.width
- The width to set the column, in pixels.public void setRowHeaderColumnWidth(int width)
width
- The width to set the column, in pixels.public int getRowHeaderColumnWidth()
public void setRowHeight(int index, int height)
setRowHeight
in class GridView
index
- The row whose height you want to set. Row numbers begin with zero.height
- The height to set the row, in pixels.public void setColumnHeaderRowHeight(int height)
index
- The row whose height you want to set. Row numbers begin at zero.height
- The height to set the row, in pixels.public int getColumnHeaderRowHeight()
index
- The row whose height you want to retrieve. Row numbers begin at zero.public void autoFit()
Table
. This method can calculate the heights of rows, the widths of columns, the width of the row headers, the heights of column headers, or a combination of all of these, depending on the value of the AutoFitScope
property.
Calculated sizes are checked against the minimum and maximum cell sizes. If the calculated sizes are not within that range, then the calculated size is changed to be within the minimum and maximum sizes.
This method sets the calculated sizes on the TableSizingManager
and then resizes the Table
through the sizing manager. If the TableSizingManager
is null
, then this method does nothing. The average calculated row height is set on the TableSizingManager
as the default row height. This is to minimize the difference between heights of rows that have not been calculated yet and the heights of those rows once they are calculated.
The range of rows used for autofitting is determined by the AutoFitRowRangeCallback
, if one is set, or if not, by the value of the AutoFitRowCount
. If the first row in the range is greater than the last row, this method logs a message with the error handler and then returns.
If there are no sizes to be calculated, for instance if AutoFitScope
is set to AUTOFIT_SCOPE_NONE
, then this method does nothing.
autoFit
in class GridView
TableSizingManager
, AutoFitRowRangeCallback
, GridView.setAutoFitScope(int)
, GridView.setCellMaxHeight(int)
, GridView.setCellMinHeight(int)
, GridView.setCellMaxWidth(int)
, GridView.setCellMinWidth(int)
public void setColumnVisible(int column, boolean visible)
setColumnVisible
in class GridView
column
- The column to hide or to reveal. Column numbers begin at zero.visible
- true
to show the column, false
to hide it.public boolean isColumnVisible(int column)
isColumnVisible
in class GridView
col
- The column to check. Column numbers begin at zero.true
if the column is visible, false
if it is not.public void setRowVisible(int row, boolean visible)
setRowVisible
in class GridView
row
- The row to hide or to reveal. Row numbers begin at zero.visible
- true
to show the row, false
to hide it.public boolean isRowVisible(int row)
isRowVisible
in class GridView
row
- The row to check. Row numbers begin with zero.true
if the row is visible, false
if it is not.public void addTableDataListener(TableDataListener l)
l
- The listener to add.setIncrementalFetchEnabled(boolean)
public void removeTableDataListener(TableDataListener l)
l
- The listener to remove.public void setManualRowSizingEnabled(boolean bEnabled)
setManualRowSizingEnabled
in class GridView
bEnabled
- true
to allow users to use the mouse to resize rows, false
to prevent them from doing so.public void setManualColumnSizingEnabled(boolean bEnabled)
setManualColumnSizingEnabled
in class GridView
bEnabled
- true
to allow users to use the mouse to resize columns, false
to prevent them from doing so.public int getViewType()
getViewType
in interface UIDataview
getViewType
in class Dataview
Dataview.VIEW_TYPE_TABLE
public boolean setXML(java.lang.String xmlString, boolean reset) throws BIIOException, BISAXException, BIParseException
setXML(String, int)
setXML
method that takes an int
for the reset
parameter allows you to specify how much and how far to reset the view before you apply XML.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.public boolean setXML(java.lang.String xmlString, int reset) throws BIIOException, BISAXException, BIParseException
Table
, from a String
. This method reads the XML from xmlString
and applies its attribute settings to this Table
. The reset
parameter determines how much of the Table
to reset before applying XML. In general, you can:
Table
without resetting anything to default valuesTable
Resetting returns property values in the Table
to the default values for the version that is specified in the XML.
setXML
in class Dataview
xmlString
- The XML to apply to this Table
.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.true
if the XML is successfully applied to this Table
, false
if an IO exception occurs.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.Dataview.RESET_NONE
, Dataview.RESET_XML_PROPERTIES
, Dataview.RESET_EVERYTHING
public boolean readXML(java.io.InputStream stream, boolean reset) throws BIIOException, BISAXException, BIParseException
readXML(InputStream, int)
readXML
method that takes an int
for the reset
parameter allows you to specify how much and how far to reset the view before you apply XML.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.public boolean readXML(java.io.InputStream stream, int reset) throws BIIOException, BISAXException, BIParseException
Crosstab
, from a String
. This method reads the XML from xmlString
and applies its attribute settings to this Crosstab
. The reset
parameter determines how much of the Crosstab
to reset before applying XML. In general, you can:
Table
without resetting anything to default valuesTable
Resetting returns property values in the Table
to the default values for the version that is specified in the XML.
readXML
in class Dataview
stream
- The XML to apply to this Table
.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.true
if the XML is successfully applied to this Table
, false
if an IO exception occurs.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.Dataview.RESET_NONE
, Dataview.RESET_XML_PROPERTIES
, Dataview.RESET_EVERYTHING
public void resetToDefault(int reset)
Crosstab
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.
This method is helpful when you want to reuse a Crosstab
rather than instantiate a new one.
resetToDefault
in class GridView
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.Dataview.RESET_XML_PROPERTIES
, Dataview.RESET_EVERYTHING
public boolean setXMLAsString(java.lang.String xml) throws BIPersistenceException
Table
. 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 Table
.
Application developers should not call this method. To load XML from a file, call setXML
or readXML
.
setXMLAsString
in class Dataview
xml
- The XML representation of the view.true
if the XML was successfully set, false
if not.BIPersistenceException
- If a problem occurs in setting the XML.readXML(java.io.InputStream, boolean)
, setXML(java.lang.String, boolean)
|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |