Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.addins.runtime.beanRef
Class TableRef

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
                                            |
                                            +--oracle.dss.addins.runtime.beanRef.TableRef
All Implemented Interfaces:
javax.accessibility.Accessible, BeanRef, ComponentTypeConverter, DataviewCommon, ErrorHandlerCallback, Formattable, GridViewAttribute, GridViewCommon, java.awt.image.ImageObserver, java.awt.MenuContainer, PagingControlAttributes, Persistable, java.io.Serializable, StringXMLizable, TableCommon, UIDataview, UIGridView, UITable

public class TableRef
extends Table
implements BeanRef

This class defines a Reference Table Bean. Once a DefinitionInfo object is set on a reference bean, the reference bean can load(save) itself from(to) BICatalog.

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent

 

Fields inherited from class oracle.dss.table.Table
TABLE

 

Fields inherited from class oracle.dss.gridView.GridView
AUTOFIT_SCOPE_ALL, AUTOFIT_SCOPE_COLHDRROWHTS_ROWHDRCOLWDS, AUTOFIT_SCOPE_COLUMN_HEADER_ROW_HEIGHTS, AUTOFIT_SCOPE_COLUMN_WIDTHS, AUTOFIT_SCOPE_COLWDS_COLHDRROWHTS, AUTOFIT_SCOPE_COLWDS_COLHDRROWHTS_ROWHDRCOLWDS, AUTOFIT_SCOPE_COLWDS_ROWHDRCOLWDS, AUTOFIT_SCOPE_COLWDS_ROWHTS, AUTOFIT_SCOPE_COLWDS_ROWHTS_COLHDRROWHTS, AUTOFIT_SCOPE_COLWDS_ROWHTS_ROWHDRCOLWDS, AUTOFIT_SCOPE_NONE, AUTOFIT_SCOPE_ROW_HEADER_COLUMN_WIDTHS, AUTOFIT_SCOPE_ROW_HEIGHTS, AUTOFIT_SCOPE_ROWHTS_COLHDRROWHTS, AUTOFIT_SCOPE_ROWHTS_COLHDRROWHTS_ROWHDRCOLWDS, AUTOFIT_SCOPE_ROWHTS_ROWHDRCOLWDS, COL_HEADER, COL_HEADER_RANGE, DATA_CELL, DATA_CELL_RANGE, DATA_COLUMN, DATA_COLUMN_RANGE, DATA_ROW, DATA_ROW_RANGE, DATABODY, DATABODY_HIGHLIGHTER, FILL_WITH_HASHMARKS, ROW_HEADER, ROW_HEADER_RANGE, TRUNCATE_WITH_ELLIPSIS, TRUNCATE_WITHOUT_ELLIPSIS

 

Fields inherited from class oracle.dss.dataView.Dataview
DATAVIEW_FOOTNOTE, DATAVIEW_FOOTNOTE_NAME, DATAVIEW_SUBTITLE, DATAVIEW_SUBTITLE_NAME, DATAVIEW_TITLE, DATAVIEW_TITLE_NAME, DEFAULT_ZOOM_FACTOR, FOOTNOTE, FOOTNOTE_NAME, PAGE_CONTROL, PAGE_HEADER, PAGE_HEADER_NAME, PAGE_ITEM, PAGE_ITEM_NAME, PAGING_COMPONENT_NAME, PAGING_CONTROL_ABOVE_TITLES, PAGING_CONTROL_BELOW_TITLES, RESET_EVERYTHING, RESET_NONE, RESET_XML_PROPERTIES, SUBTITLE, SUBTITLE_NAME, TITLE, TITLE_NAME, VIEW_TYPE_CROSSTAB, VIEW_TYPE_GRAPH, VIEW_TYPE_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
TableRef()
           

 

Method Summary
 DefinitionInfo getDefinition()
          Retrieves the DefinitionInfo object from this reference bean
 BISession getSession()
          retrieves the BISession object associated this reference bean
 void initialize(java.util.Hashtable env)
          Persistable interface method override
 boolean isBackgroundLoad()
          retrieves a boolean value which indicates if the presentation is loaded using another thread
 boolean isLoaded()
          Return true if the view has finished loading
 void load()
          Load the presentation from the BI Catalog, if the presentation contains a live query, the query will be executed as well.
 void paint(java.awt.Graphics g)
          JComponent method override
 void save()
          Save the changes to the presentation to the BI Catalog.
 void saveAs(java.lang.String path)
          Save the the presentaion to the BI Catalog using a different name
 void setBackgroundLoad(boolean bValue)
          Specifies if the presentation should be loaded using another thread
 void setDefinition(DefinitionInfo definition)
          specifies the DefinitionInfo of this reference bean
 void setPersistableAttributes(PersistableAttributes attrs)
          Persistable interface method override
 void setSession(BISession biSession)
          specifies the BISession Object associated with this refrence bean

 

Methods inherited from class oracle.dss.table.Table
addTableDataListener, autoFit, getColumnHeader, getColumnHeaderRowHeight, getCornerComponentColor, getDatabody, getFetchIncrement, getFetchMessage, getGridViewSelectionManager, getRowHeader, getRowHeaderColumnWidth, getStartColumn, getStartRow, getTableController, getTableModel, getTableSizingManager, getViewType, isColumnHeaderVisible, isColumnVisible, isHGridVisible, isIncrementalFetchEnabled, isIncrementalFetchRowVisible, isRowHeaderVisible, isRowVisible, isVGridVisible, readXML, readXML, removeTableDataListener, resetToDefault, selectObject, setBackgroundImage, setCellEditingAllowed, setColumnHeaderRowHeight, setColumnHeaderVisible, setColumnVisible, setColumnWidth, setCornerComponentColor, setDefaultCornerComponentColor, setFetchIncrement, setFetchMessage, setHGridVisible, setIncrementalFetchEnabled, setLocale, setManualColumnSizingEnabled, setManualRowSizingEnabled, setRowHeaderColumnWidth, setRowHeaderVisible, setRowHeight, setRowVisible, setStartColumn, setStartRow, setVGridVisible, setXML, setXML, setXMLAsString

 

Methods inherited from class oracle.dss.gridView.GridView
addGridViewDataListener, applyCSSStyleDefaults, getAutoFitColumnCount, getAutoFitColumnRangeCallback, getAutoFitRowCount, getAutoFitRowRangeCallback, getAutoFitScope, getBackgroundImage, getBackgroundImagePath, getBanding, getBaseImageURI, getCellMaxHeight, getCellMaxWidth, getCellMinHeight, getCellMinWidth, getColumnWidth, getDrillImage, getDrillImagePath, getGraphicImage, getGraphicImageCount, getGraphicImagePath, getGridColor, getGridViewController, getGridViewDatabodyStyleManager, getGridViewFormatManager, getGridViewHeaderStyleManager, getGridViewModel, getGridViewSizingManager, getHGridColor, getHTMLColumnBlockSize, getHTMLColumnSizing, getHTMLRowBlockSize, getHTMLTableCellPadding, getHTMLTableWidth, getHTMLTextInputSize, getPresentationHeight, getPresentationWidth, getRowHeight, getSelectedObject, getTruncatedNumericDataFormat, getVGridColor, getViewFormat, isCellEditingAllowed, isGrid3D, isManualColumnSizingEnabled, isManualRowSizingEnabled, isSwapAllowed, isVisible, removeGridViewDataListener, setAutoFitColumnCount, setAutoFitColumnRangeCallback, setAutoFitRowCount, setAutoFitRowRangeCallback, setAutoFitScope, setBackgroundImagePath, setBanding, setBaseImageURI, setCellMaxHeight, setCellMaxWidth, setCellMinHeight, setCellMinWidth, setDrillImage, setDrillImagePath, setEnabled, setGraphicImage, setGraphicImagePath, setGrid3D, setGridColor, setHGridColor, setHTMLColumnBlockSize, setHTMLColumnSizing, setHTMLRowBlockSize, setHTMLTableCellPadding, setHTMLTableWidth, setHTMLTextInputSize, setSwapAllowed, setTruncatedNumericDataFormat, setVGridColor, setViewFormat, setVisible

 

Methods inherited from class oracle.dss.dataView.Dataview
addControllerListener, addDataListener, addErrorHandler, addPropertyChangeListener, addViewFocusListener, addViewKeyListener, addViewListener, addViewMouseListener, addViewMouseMotionListener, cleanUp, getController, getDataDirector, getDataSource, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getDescription, getHTMLPagingControlWidth, getInsertCallBack, getLocale, getLocalName, getModel, getName, getPagingControl, getPagingControlPosition, getPersistableAttributes, getPersistableComponents, getPhysicalComponents, getPopupManager, getRolloverTextManager, getTokenSubstitution, getXML, getXMLAsString, isDrillingEnabled, isHTMLPagingControlAutosubmit, isPagingControlVisible, isXMLValidated, removeControllerListener, removeDataListener, removeErrorHandler, removePropertyChangeListener, removeViewFocusListener, removeViewKeyListener, removeViewListener, removeViewMouseListener, removeViewMouseMotionListener, setDataSource, setDescription, setDrillingEnabled, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setInsertCallBack, setLocalName, setName, setPagingControlPosition, setPagingControlVisible, setPopupManager, setRolloverTextManager, setTokenSubstitution, setXMLValidated, writeXML

 

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, 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.util.persistence.Persistable
getPersistableAttributes, getPersistableComponents, setPersistableComponents

 

Methods inherited from interface oracle.dss.util.persistence.StringXMLizable
getXMLAsString, setXMLAsString

 

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

 

Constructor Detail

TableRef

public TableRef()
Method Detail

setSession

public void setSession(BISession biSession)
specifies the BISession Object associated with this refrence bean
Specified by:
setSession in interface BeanRef
Parameters:
The - BISession that is associatedwi the this reference bean

getSession

public BISession getSession()
retrieves the BISession object associated this reference bean
Specified by:
getSession in interface BeanRef
Returns:
The BISession that is associated with this reference bean

setDefinition

public void setDefinition(DefinitionInfo definition)
specifies the DefinitionInfo of this reference bean
Specified by:
setDefinition in interface BeanRef
Parameters:
defintion - the DefinitionInfo object for this reference bean

getDefinition

public DefinitionInfo getDefinition()
Retrieves the DefinitionInfo object from this reference bean
Specified by:
getDefinition in interface BeanRef
Returns:
The DefinitionInfo that specifies the configuration file and the full path of this reference bean

load

public void load()
Load the presentation from the BI Catalog, if the presentation contains a live query, the query will be executed as well.
Specified by:
load in interface BeanRef

save

public void save()
Save the changes to the presentation to the BI Catalog.
Specified by:
save in interface BeanRef

saveAs

public void saveAs(java.lang.String path)
Save the the presentaion to the BI Catalog using a different name
Specified by:
saveAs in interface BeanRef
Parameters:
location - the object Path, such as "folder/object1"

paint

public void paint(java.awt.Graphics g)
JComponent method override
Overrides:
paint in class GridView

initialize

public void initialize(java.util.Hashtable env)
Persistable interface method override
Specified by:
initialize in interface Persistable
Overrides:
initialize in class Dataview
Following copied from interface: oracle.dss.util.persistence.Persistable
Parameters:
env - Environment properties.

setPersistableAttributes

public void setPersistableAttributes(PersistableAttributes attrs)
Persistable interface method override
Specified by:
setPersistableAttributes in interface Persistable
Overrides:
setPersistableAttributes in class Dataview
Following copied from interface: oracle.dss.util.persistence.Persistable
Parameters:
attrs - PersistableAttributes that specify search attributes for the component.

setBackgroundLoad

public void setBackgroundLoad(boolean bValue)
Specifies if the presentation should be loaded using another thread
Specified by:
setBackgroundLoad in interface BeanRef
Parameters:
doBackGroundLoad - true: Presentation is loaded using another thread false: Presentation is loaded in the calling thread

isBackgroundLoad

public boolean isBackgroundLoad()
retrieves a boolean value which indicates if the presentation is loaded using another thread
Specified by:
isBackgroundLoad in interface BeanRef
Returns:
true: presentaiton is loaded using another thread false: presentaion is loaded using the main thead

isLoaded

public boolean isLoaded()
Return true if the view has finished loading
Specified by:
isLoaded in interface BeanRef

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.