Class symantec.itools.db.beans.binding.QueryNavigator
All Packages Class Hierarchy This Package Previous Next Index
Class symantec.itools.db.beans.binding.QueryNavigator
Object
|
+----symantec.itools.db.beans.binding.QueryNavigator
- public class QueryNavigator
- extends Object
- implements Synchronizable, ExpandableSet, BasicDataSource, ExceptionEventListener, PropertyChangeListener, RecordSaveEventExceptionListener
-
symantec.itools.db.beans.binding.QueryNavigator. TaskAction
-
-
AVAILABLE_SPECIAL_FEATURES
-
-
BASE_FOR_ROW_NUMBER
-
-
CHECK_QBE_VALUES
-
-
LAST_ROW
-
-
NUMOFROWS_SPECIALFEATURE
-
-
OVERRIDE_MESSAGE
-
-
PROP_EXECUTE
-
-
QBE_ROW_NUMBER
-
-
QBE_STRING
-
-
ROWNUMBER_SPECIALFEATURE
-
-
ROWSTATE_SPECIALFEATURE
-
-
SLEEP_TIME
-
-
SpecialFeatures
-
-
applet
- Constructor.
-
fullname
-
-
m_CurrentCursor
-
-
m_DeletedRecordsVector
-
-
m_Live
-
-
m_ObjectEnumeration
-
-
m_ObjectVector
-
-
m_POClassName
-
-
m_POFactory
-
-
m_QBECursor
-
-
m_UpdatedRecordsVector
-
-
m_Xlator
-
-
markedAsDeletedString
-
-
markedAsExistingString
-
-
markedAsModifiedString
-
-
markedAsNewString
-
-
markedAsQBEString
-
-
newSet
-
-
numberOfSpecialFeatures
-
-
taskAction
-
-
symantec.itools.db.beans.binding.QueryNavigator()
-
-
BOF()
-
-
EOF()
-
-
TriggerUI(int, int)
-
-
addColumnDataEventListener(ColumnDataEventListener)
-
-
addExceptionEventListener(ExceptionEventListener)
-
-
addExceptionListener(ExceptionEventListener, String)
-
-
addPropertyChangeListener(PropertyChangeListener)
- javadoc comments go here...
-
addRecordNavigateEventListener(RecordNavigateEventListener)
-
-
addRecordSaveEventExceptionListener(RecordSaveEventExceptionListener)
-
-
addRecordSaveEventListener(RecordSaveEventListener)
-
-
addTriggerUIListener(TriggerUIListener)
- Implementing the BasicDataSource Interface
-
announceException(ExceptionEvent)
-
-
announceOnAfterColumnDataChange(ColumnDataEvent)
-
-
announceOnAfterRecordSave(RecordSaveEvent)
-
-
announceOnBeforeColumnDataChange(ColumnDataEvent)
-
-
announceOnBeforeRecordSave(RecordSaveEvent)
-
-
announceRecordNavigateOnAfterNavigate(RecordNavigateEvent)
-
-
announceRecordNavigateOnBeforeNavigate(RecordNavigateEvent)
-
-
announceRecordNavigateOnBoundary(RecordNavigateEvent)
-
-
announceRecordSaveException(RecordSaveEvent)
-
-
close()
-
-
commitState()
-
-
createQueryByExampleRow()
- Constructs a query by example by reseting the privates members of the object.
-
delete()
- Deletes the current row from the Data Source and from the Data Base.
-
execute(boolean)
-
-
executeQuery(Synchronizable)
-
-
executeQueryByExample()
- Populates a Data Source with the result from the query by example.
-
expandPOSet()
-
-
finalize()
-
-
findRecord(String, Object)
- This function retrieves the first RecordDefinition that
matches the criteria "Table[colName]=value"
The return will be a Hashtable with the format (ColumnName-->KEY,ColumnValue-->VALUE)
If no Record is found then the function will return null
If the colName doesn't exist the the function will return null
-
findRecord(int, Object)
- This function retrieves the first RecordDefinition that
matches the criteria "Table[colNumber]=value"
The return will be a Hashtable with the format (ColumnName-->KEY,ColumnValue-->VALUE)
If no Record is found then the function will return null
If the colName doesn't exist the the function will return null
-
first()
-
-
getAliasName()
-
-
getAutoStart()
-
-
getClassName()
-
-
getConnection()
-
-
getCurrentObject()
-
-
getCurrentRowNumber()
-
-
getDataName()
- Gets the the database table name
Format: "TableName
-
getDirtyRowsNumber()
-
-
getDirtySaveMessage()
- Gets the message to be displayed when a dirty QN is navigated
-
getElementAt(int)
- Gets the Object stored in the QueryNavigator at the given position
-
getLink()
-
-
getMasterAliasName()
-
-
getName()
-
-
getQBEObject()
-
-
getQueryNavigatorObject(String)
-
-
getRowState(PersistentObject)
- Returns the row state.
-
getRowState()
-
-
getSaveChangesWindowClass()
- Gets the message window class string
-
getSpecialFeature(int, int)
- Returns a special value for the getvalue Method.
-
getTotalNumberOfRows()
-
-
getValue(int, int)
- Gets the object stored in the QueryNavigator with the coordinates
row and col.
-
getValueFromFirst(int, int)
- Gets the object stored in the QueryNavigator with the coordinates
row and col.
-
go_to(int)
-
-
gxecute()
-
-
handleExceptionEvent(ExceptionEvent)
-
-
initPO(PersistentObject)
-
-
insert()
- Inserts a new row in the Data Source.
-
insertIntern()
-
-
isDirty()
-
-
isEmpty()
-
-
isExpandable()
-
-
isQBERow()
-
-
last()
-
-
moveDataToUI(int, int)
-
-
navigate(int, Integer)
-
-
next()
- Move the focus to the next row
-
onRecordSaveException(RecordSaveEvent)
-
-
previous()
- Move the focus to the previous row
-
propertyChange(PropertyChangeEvent)
- Handle the property changed event.
-
removeColumnDataEventListener(ColumnDataEventListener)
-
-
removeExceptionEventListener(ExceptionEventListener)
-
-
removeExceptionListener(ExceptionEventListener, String)
-
-
removePropertyChangeListener(PropertyChangeListener)
- javadoc comments go here...
-
removeRecordNavigateEventListener(RecordNavigateEventListener)
-
-
removeRecordSaveEventExceptionListener(RecordSaveEventListener)
-
-
removeRecordSaveEventListener(RecordSaveEventListener)
-
-
removeTriggerUIListener(TriggerUIListener)
-
-
restart()
-
-
save()
-
-
saveAll(int)
-
-
saveAll()
-
-
saveAllLevels()
-
-
saveIntern()
- Saves the current row in the Data Base.
-
setAliasName(String)
- Set the alias name for a QueryNavigator.
-
setApplet(Applet)
-
-
setAutoStart(boolean)
-
-
setClassName(String)
-
-
setDirtySaveMessage(String)
- Sets the message to be displayed when a dirty QN is navigated
-
setDisplaced(int, Object, PersistentObject)
-
-
setLink(SynchronizerLink)
-
-
setMarkedAsDeleted()
-
-
setMasterAliasName(String)
-
-
setMasterName(String)
-
-
setName(String)
-
-
setSaveChangesWindowClass(String)
- Sets the message window class string
-
setSpecialFeature(int, int, Object)
-
-
setValue(Object, int, int)
- Sets the object stored in the QueryNavigator with the coordinates
row and col.
-
setValueAsQBE(Object, int)
-
-
setValueFromFirst(Object, int, int)
- Sets the object stored in the QueryNavigator with the coordinates
row and col.
-
startQBE()
-
-
startQueryByExample()
-
-
toString()
-
-
undoChanges()
- Undoes the changes on the current row.
-
undoColumnChanges(int)
- Undoes the changes on the current row and on the specific column.
AVAILABLE_SPECIAL_FEATURES
public static final java.lang.String[] AVAILABLE_SPECIAL_FEATURES
BASE_FOR_ROW_NUMBER
public static final int BASE_FOR_ROW_NUMBER
CHECK_QBE_VALUES
public final boolean CHECK_QBE_VALUES
LAST_ROW
public static java.lang.String LAST_ROW
NUMOFROWS_SPECIALFEATURE
public static final java.lang.String NUMOFROWS_SPECIALFEATURE
OVERRIDE_MESSAGE
public static java.lang.String OVERRIDE_MESSAGE
PROP_EXECUTE
public static final java.lang.String PROP_EXECUTE
QBE_ROW_NUMBER
public static final int QBE_ROW_NUMBER
QBE_STRING
public static final java.lang.String QBE_STRING
ROWNUMBER_SPECIALFEATURE
public static final java.lang.String ROWNUMBER_SPECIALFEATURE
ROWSTATE_SPECIALFEATURE
public static final java.lang.String ROWSTATE_SPECIALFEATURE
SLEEP_TIME
public static final int SLEEP_TIME
SpecialFeatures
public static final java.lang.String[] SpecialFeatures
applet
protected java.applet.Applet applet
- Constructor. Constructs a data source and initializes three navigational cursors
Also creates a mediator ds
fullname
protected java.lang.String fullname
m_CurrentCursor
protected symantec.itools.db.beans.binding.Cursor m_CurrentCursor
m_DeletedRecordsVector
protected java.util.Vector m_DeletedRecordsVector
m_Live
protected boolean m_Live
m_ObjectEnumeration
protected java.util.Enumeration m_ObjectEnumeration
m_ObjectVector
protected java.util.Vector m_ObjectVector
m_POClassName
protected java.lang.String m_POClassName
m_POFactory
protected java.lang.Class m_POFactory
m_QBECursor
protected symantec.itools.db.beans.binding.Cursor m_QBECursor
m_UpdatedRecordsVector
protected java.util.Vector m_UpdatedRecordsVector
m_Xlator
protected symantec.itools.db.beans.qbe.QBExlator m_Xlator
markedAsDeletedString
public static java.lang.String markedAsDeletedString
markedAsExistingString
public static java.lang.String markedAsExistingString
markedAsModifiedString
public static java.lang.String markedAsModifiedString
markedAsNewString
public static java.lang.String markedAsNewString
markedAsQBEString
public static java.lang.String markedAsQBEString
newSet
protected boolean newSet
numberOfSpecialFeatures
public final int numberOfSpecialFeatures
taskAction
protected symantec.itools.db.beans.binding.QueryNavigator. TaskAction taskAction
QueryNavigator
public QueryNavigator()
BOF
public boolean BOF()
EOF
public boolean EOF()
TriggerUI
protected void TriggerUI(int row,
int type)
addColumnDataEventListener
public synchronized void addColumnDataEventListener(ColumnDataEventListener listener)
addExceptionEventListener
public synchronized void addExceptionEventListener(ExceptionEventListener listener)
addExceptionListener
public static void addExceptionListener(ExceptionEventListener member,
String aName)
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)
- javadoc comments go here...
addRecordNavigateEventListener
public synchronized void addRecordNavigateEventListener(RecordNavigateEventListener listener)
addRecordSaveEventExceptionListener
public synchronized void addRecordSaveEventExceptionListener(RecordSaveEventExceptionListener listener)
addRecordSaveEventListener
public synchronized void addRecordSaveEventListener(RecordSaveEventListener listener)
addTriggerUIListener
public synchronized void addTriggerUIListener(TriggerUIListener mds)
- Implementing the BasicDataSource Interface
announceException
public void announceException(ExceptionEvent e)
announceOnAfterColumnDataChange
public void announceOnAfterColumnDataChange(ColumnDataEvent e)
announceOnAfterRecordSave
public void announceOnAfterRecordSave(RecordSaveEvent e)
announceOnBeforeColumnDataChange
public void announceOnBeforeColumnDataChange(ColumnDataEvent e)
announceOnBeforeRecordSave
public void announceOnBeforeRecordSave(RecordSaveEvent e)
announceRecordNavigateOnAfterNavigate
public void announceRecordNavigateOnAfterNavigate(RecordNavigateEvent e)
announceRecordNavigateOnBeforeNavigate
public void announceRecordNavigateOnBeforeNavigate(RecordNavigateEvent e)
announceRecordNavigateOnBoundary
public void announceRecordNavigateOnBoundary(RecordNavigateEvent e)
announceRecordSaveException
public void announceRecordSaveException(RecordSaveEvent e) throws RecordSaveException
close
public synchronized void close()
commitState
public synchronized void commitState()
createQueryByExampleRow
public void createQueryByExampleRow()
- Constructs a query by example by reseting the privates members of the object.
delete
public void delete()
- Deletes the current row from the Data Source and from the Data Base.
execute
public void execute(boolean value)
executeQuery
public void executeQuery(Synchronizable masterReference)
executeQueryByExample
public synchronized void executeQueryByExample()
- Populates a Data Source with the result from the query by example.
For interface only
expandPOSet
protected boolean expandPOSet()
finalize
public void finalize() throws Throwable
-
- Throws: Throwable
-
- Overrides:
- finalize in class Object
findRecord
public java.util.Hashtable findRecord(String colName,
Object value)
- This function retrieves the first RecordDefinition that
matches the criteria "Table[colName]=value"
The return will be a Hashtable with the format (ColumnName-->KEY,ColumnValue-->VALUE)
If no Record is found then the function will return null
If the colName doesn't exist the the function will return null
findRecord
public java.util.Hashtable findRecord(int colNumber,
Object value)
- This function retrieves the first RecordDefinition that
matches the criteria "Table[colNumber]=value"
The return will be a Hashtable with the format (ColumnName-->KEY,ColumnValue-->VALUE)
If no Record is found then the function will return null
If the colName doesn't exist the the function will return null
first
public final void first() throws PositionOutOfRangeException
getAliasName
public java.lang.String getAliasName()
getAutoStart
public boolean getAutoStart()
getClassName
public java.lang.String getClassName()
getConnection
public symantec.itools.db.beans.binding.Connection getConnection()
getCurrentObject
public java.lang.Object getCurrentObject()
getCurrentRowNumber
public int getCurrentRowNumber()
getDataName
public java.lang.String getDataName()
- Gets the the database table name
Format: "TableName@column1,...,columnN"
- Returns:
- the database table name.
getDirtyRowsNumber
public int getDirtyRowsNumber()
getDirtySaveMessage
public java.lang.String getDirtySaveMessage()
- Gets the message to be displayed when a dirty QN is navigated
- Returns:
- the message to be displayed when a dirty QN is navigated.
getElementAt
public java.lang.Object getElementAt(int position) throws PositionOutOfRangeException
- Gets the Object stored in the QueryNavigator at the given position
- Parameters:
- position - The position.
- Throws: PositionOutOfRangeException
- when position is out of range
getLink
public symantec.itools.db.beans.binding.SynchronizerLink getLink()
getMasterAliasName
public java.lang.String getMasterAliasName()
getName
public java.lang.String getName()
getQBEObject
public symantec.itools.db.beans.binding.PersistentObject getQBEObject()
getQueryNavigatorObject
public static symantec.itools.db.beans.binding.QueryNavigator getQueryNavigatorObject(String aName)
getRowState
protected java.lang.String getRowState(PersistentObject po)
- Returns the row state.
- Parameters:
- po - the row to check
getRowState
public java.lang.String getRowState() throws PositionOutOfRangeException
getSaveChangesWindowClass
public java.lang.String getSaveChangesWindowClass()
- Gets the message window class string
- Returns:
- the message window class string
getSpecialFeature
protected java.lang.Object getSpecialFeature(int column,
int offset)
- Returns a special value for the getvalue Method. These special features are defined
in an array of strings.
- Parameters:
- column - the special feature column ( < 0 )
- offset - the row for the special feature
getTotalNumberOfRows
public int getTotalNumberOfRows()
getValue
public java.lang.Object getValue(int offset,
int column)
- Gets the object stored in the QueryNavigator with the coordinates
row and col.
- Parameters:
- offset - The current row, relative value.
- column - The column value.
- Returns:
- The value of the object.
getValueFromFirst
public java.lang.Object getValueFromFirst(int offset,
int column)
- Gets the object stored in the QueryNavigator with the coordinates
row and col.
- Parameters:
- offset - The current row, relative value.
- column - The column value.
- Returns:
- The value of the object.
go_to
public void go_to(int row)
gxecute
public boolean gxecute()
handleExceptionEvent
public void handleExceptionEvent(ExceptionEvent e)
initPO
protected synchronized void initPO(PersistentObject newPO)
insert
public void insert()
- Inserts a new row in the Data Source. In order to save this row in the Data Base
the save method must be called
insertIntern
protected void insertIntern()
isDirty
public boolean isDirty()
isEmpty
public boolean isEmpty()
isExpandable
public synchronized boolean isExpandable()
isQBERow
public boolean isQBERow()
last
public void last()
moveDataToUI
protected synchronized void moveDataToUI(int row,
int type)
navigate
public synchronized void navigate(int typeNavigation,
Integer rowNumber)
next
public final void next() throws PositionOutOfRangeException
- Move the focus to the next row
onRecordSaveException
public void onRecordSaveException(RecordSaveEvent e) throws RecordSaveException
previous
public final void previous() throws PositionOutOfRangeException
- Move the focus to the previous row
propertyChange
public void propertyChange(PropertyChangeEvent event)
- Handle the property changed event.
We check for property name in case someday we add another property.
We don't check for old and new values because regarding the close property
it is only used when the sender is going from an open to closed transition.
removeColumnDataEventListener
public synchronized void removeColumnDataEventListener(ColumnDataEventListener listener)
removeExceptionEventListener
public synchronized void removeExceptionEventListener(ExceptionEventListener listener)
removeExceptionListener
public static void removeExceptionListener(ExceptionEventListener member,
String aName)
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
- javadoc comments go here...
removeRecordNavigateEventListener
public synchronized void removeRecordNavigateEventListener(RecordNavigateEventListener listener)
removeRecordSaveEventExceptionListener
public synchronized void removeRecordSaveEventExceptionListener(RecordSaveEventListener listener)
removeRecordSaveEventListener
public synchronized void removeRecordSaveEventListener(RecordSaveEventListener listener)
removeTriggerUIListener
public synchronized void removeTriggerUIListener(TriggerUIListener mds)
restart
public void restart()
save
public synchronized void save()
saveAll
public int saveAll(int resolveType) throws SQLException
saveAll
public int saveAll()
saveAllLevels
public int saveAllLevels()
saveIntern
public synchronized int saveIntern() throws SQLException
- Saves the current row in the Data Base.
setAliasName
public synchronized void setAliasName(String aName)
- Set the alias name for a QueryNavigator. This alias name identifies the object
- Parameters:
- aName - the alias name checked.
setApplet
public void setApplet(Applet app)
setAutoStart
public void setAutoStart(boolean value)
setClassName
public void setClassName(String POCName)
setDirtySaveMessage
public void setDirtySaveMessage(String dirtySaveMessage)
- Sets the message to be displayed when a dirty QN is navigated
setDisplaced
protected void setDisplaced(int column,
Object value,
PersistentObject po)
setLink
public synchronized void setLink(SynchronizerLink sLink)
setMarkedAsDeleted
public void setMarkedAsDeleted()
setMasterAliasName
public synchronized void setMasterAliasName(String aName)
setMasterName
public synchronized void setMasterName(String aName)
setName
public void setName(String value)
setSaveChangesWindowClass
public void setSaveChangesWindowClass(String WindowClass)
- Sets the message window class string
setSpecialFeature
protected void setSpecialFeature(int column,
int offset,
Object value) throws PositionOutOfRangeException
setValue
public final synchronized void setValue(Object value,
int offset,
int column)
- Sets the object stored in the QueryNavigator with the coordinates
row and col.
- Parameters:
- value. - The value of the object.
- offset. - The current row, relative value.
- column. - The column value.
setValueAsQBE
public void setValueAsQBE(Object value,
int column)
setValueFromFirst
public void setValueFromFirst(Object value,
int offset,
int column)
- Sets the object stored in the QueryNavigator with the coordinates
row and col.
- Parameters:
- value - The value of the object.
- offset - The current row, relative value.
- column - The column value.
startQBE
public final void startQBE()
startQueryByExample
public synchronized void startQueryByExample()
toString
public java.lang.String toString()
- Overrides:
- toString in class Object
undoChanges
public void undoChanges()
- Undoes the changes on the current row.
undoColumnChanges
public void undoColumnChanges(int columnIndex)
- Undoes the changes on the current row and on the specific column.
All Packages Class Hierarchy This Package Previous Next Index