SilverStream
Application Server 3.5

com.sssw.rt.form
Class AgcData

java.lang.Object
 |
 +--java.awt.Component
       |
       +--java.awt.Container
             |
             +--javax.swing.JComponent
                   |
                   +--javax.swing.JPanel
                         |
                         +--com.sssw.rt.atlas.AtPanel
                               |
                               +--com.sssw.rt.atlas.AtCanvas
                                     |
                                     +--com.sssw.rt.form.PvBaseCanvas
                                           |
                                           +--com.sssw.rt.form.PvInvisibleControlBase
                                                 |
                                                 +--com.sssw.rt.form.AgcData
All Implemented Interfaces:
Accessible, AgiControl, AgiHelpInfo, AgiRowCursor, AgiRowCursorSort, AgiRowCursorViewSupport, AgiRowSetEventProducer, AgiRowSetManager, ImageObserver, MenuContainer, Serializable
Direct Known Subclasses:
AgcDataPrimary

public class AgcData
extends com.sssw.rt.form.PvInvisibleControlBase
implements AgiRowCursor, AgiRowCursorViewSupport, AgiRowSetEventProducer, AgiRowSetManager, AgiRowCursorSort

This invisible control allows users access to a data set that is independent of the rest of the form.

By default, all SilverStream forms are bound to a primary dataset. The binding occurs through an instance variable on the form called agData.

Multiple datasets are permitted on a single form by adding as many AgcData controls to the form as there are datasets to be accessed. Note that any operations that attempt to change the database contents (such as delete()) or the database structure (such as appendChild()) are not committed to the database until the updateRows() method is called. During the session, SilverStream saves all of these changes in a buffer, and when updateRows() is called, all of the database requests are submitted to the database server. All of the database requests must succeed; if any one fails all requests will be discarded and an exception is thrown.

Note: The ancestor methods in this class, that is all methods inherited from the non-public PvInvisibleControlBase (including JComponent and Component) are not visible at run time, and are primarily for use by SilverStream. The useful methods are contained in the AgcData class itself.

Properties:
Business Object Name, Column Expressions, Distinct, Limit Rows, Load Data, Maximum Rows, Name, Order By, Table, Where Clause
Events:
cursorChanged, cursorPreChange, dataReceivedAsync, dataReloaded, rowDataChanged, rowDeleted, rowInserted, rowPreDelete, rowPreInsert
See Also:
Serialized Form

Inner classes inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel
 
Inner classes inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Fields inherited from class com.sssw.rt.atlas.AtPanel
BGIMAGE_DRAW_CENTERED, BGIMAGE_DRAW_NORMAL, BGIMAGE_DRAW_STRETCH, BGIMAGE_DRAW_TILED
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, 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 com.sssw.rt.util.AgiRowCursor
BANDNAME, ORDINAL
 
Constructor Summary
AgcData()
           
 
Method Summary
 Object invokeQuery(Object param)
          Invokes the business object for which this AgcData is the proxy.
 void setDataSource(String busObjSpec)
          Lets you programmatically switch the source of data for the AgcData control at runtime.
 
Methods inherited from class com.sssw.rt.form.PvInvisibleControlBase
setBounds, setLocation, setSize
 
Methods inherited from class com.sssw.rt.form.PvBaseCanvas
getBackgroundColor, getFontIdentifier, setBackgroundColor, setFontIdentifier
 
Methods inherited from class com.sssw.rt.atlas.AtPanel
addImpl, addNotify, clientPaint, clientPaint, deliverMouseEvent, deliverMouseMoveEvent, doAtCommand, drawTiledImage, enableAtCommands, getBackgroundImage, getBackgroundImageMode, getHelper, getTransparent, hide, hideToolTip, imageUpdate, isFocusTraversable, isOptimizedDrawingEnabled, ownedImage, paintBorder, paintComponent, paintImmediately, paintImmediately, paintNow, preprocessKeyEvent, processEvent, reshape, setBackgroundImage, setBackgroundImageMode, setTransparent, show, showToolTip
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUIClassID, paramString, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isLightweightComponent, isManagingFocus, isOpaque, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, print, printAll, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, 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, processContainerEvent, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setName, setSize, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods implemented from interface com.sssw.rt.form.AgiControl
getComponent, getHelpInfo, setHelpInfo
 
Methods implemented from interface com.sssw.rt.util.AgiRowCursor
addAgiRowCursorListener, allowsChildren, appendChild, copy, delete, getProperty, getProperty, getPropertyCount, getPropertyIndex, getPropertyName, getRowSetEventProducer, gotoChild, gotoFirst, gotoLast, gotoNext, gotoParent, gotoPrevious, gotoRoot, hasChildren, insertAfter, insertBefore, makePrimaryVersion, removeAgiRowCursorListener, setProperty, setProperty
 
Methods implemented from interface com.sssw.rt.util.AgiRowCursorSort
rowCursorSort
 
Methods implemented from interface com.sssw.rt.util.AgiRowCursorViewSupport
getChildEntryCount, getDisplayEntryNumber, setDisplayEntryNumber
 
Methods implemented from interface com.sssw.rt.util.AgiRowSetEventProducer
addAgiRowSetListener, removeAgiRowSetListener
 
Methods implemented from interface com.sssw.rt.util.AgiRowSetManager
clearRows, haveRowsChanged, query, query, refreshRows, updateRows
 

Constructor Detail

AgcData

public AgcData()
Method Detail

setDataSource

public void setDataSource(String busObjSpec)
Lets you programmatically switch the source of data for the AgcData control at runtime.
Parameters:
busObjSpec - the name of the data source object, including its package name.
Usage:

You might do some data binding to an AgcData and then switch from one data source to another one that has the same fields, but different selection criteria or a different actual source of data.

You invoke the data source object by calling AgcData.invokeQuery().

Example:
 	agcData1.setDataSource("com.myco.mydept.CustomerDataSource");
 

invokeQuery

public Object invokeQuery(Object param)
                   throws Exception
Invokes the business object for which this AgcData is the proxy.
Parameters:
param - an argument passed to the business object.
Usage:

If this call succeeds, initialize the AgcData object with the resulting data source.

If the business object throws an exception this method will throw it as well.

Example:
 try
 {
 	agcData1.invokeQuery(custID.getIntegerValue());
 }
 catch (Exception e)
 {
 	agDialog.displayError(e);
 }
 

SilverStream
Application Server 3.5