com.iizix.db.prop

Class ResultSetProps

java.lang.Object

com.iizix.prop.GProp<GProp<?>[]>

com.iizix.prop.PropCnr

com.iizix.prop.vs.VSVariables

com.iizix.db.prop.ResultSetProps

All Implemented Interfaces:

EventListener, IClassInstantiationAtResolve, IGProp<GProp<?>[]>, IPropCnr, IReferrerParticipant, IVSAccessor, IVSComponentListener, IVSComponentState, IVSParticipant, IVSTableListener, Cloneable

Direct Known Subclasses:

EditorResultSetProps

public class ResultSetProps
extends VSVariables
implements IVSParticipant, IVSTableListener, IClassInstantiationAtResolve

Result set property that ties a result set from the execution of an SQL query statement to VirtualSpace.

Author:

Christopher Mindus

Nested Class Summary

Nested classes/interfaces inherited from interface com.iizix.prop.vs.IVSComponentState

IVSComponentState.State

Field Summary

Fields inherited from class com.iizix.prop.PropCnr

EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_ID

Fields inherited from class com.iizix.prop.GProp

GPDEBUG, PROP_ATTR_STRING_EDITOR_PROP, PROP_ATTR_STRING_ERRORED_NAME, PROP_ATTR_STRING_EXTENDS, PROP_ATTR_STRING_EXTENDS_FINAL, PROP_ATTR_STRING_EXTENDS_PRIVATE, PROP_ATTR_STRING_NULLABLE, PROP_ATTR_STRING_PRIVATE, PROP_ATTR_STRING_PRIVATE_CHANGE_EVENT, PROP_ATTR_STRING_READ_ONLY, PROP_USER_1, PROP_USER_2

Fields inherited from interface com.iizix.prop.IGProp

EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE

Constructor Summary

Constructors

Constructor and Description
ResultSetProps() Creates a Result Set property container with the specified name with a null value.
ResultSetProps(Atom propertyAtom) Creates a Result Set property container with the specified name with a null value.

Method Summary

Modifier and Type	Method and Description
ResultSetProps	clone() Clones this ResultSetProp.
boolean	doOverwrite() Gets the flag if the table should overwrite existing entries in the VSTable when populating it.
ClassReference	getClassReference() The Java class associated with result set output.
ResultSetColumnProp[]	getColumns() Gets the result set columns.
DatabaseProps	getDatabaseProps() Gets the Database Transaction properties.
String	getDescription() Gets the result set description.
int	getMaximumRowCount() Gets the maximum number of rows to retrieve.
String	getParticipantDescription() Returns the given description of the referrer participant.
String	getParticipantType() Returns the given type of the referrer participant.
IResultSetProcessor	getResultSetProcessor() Gets the instance of the IResultSetProcessor.
VSParticipant	getTargetVirtualSpaceParticipant() Gets the target VirtualSpace participant for output data.
VirtualSpace	getVirtualSpace() Gets the VirtualSpace.
VSParticipant	getVSReference(Atom refAtom) Gets a VSReference instance from the container or any parent containers.
VSTable	getVSTable() Gets the VirtualSpace table for all the output.
VSTableReference	getVSTableReference() Gets the VirtualSpace table reference for all the output.
VSReferenceOwnerData<VSTable,VSTableReference>	getVSTableReferenceOwnerData() Gets the table reference owner data for the table column reference.
void	onBroken(VSRelativeReference<?> reference, VSTable table) Called when the property reference has been broken, i.e.
void	onCellStateChanged(VSField cell, IVSComponentState.State state, boolean on) Called when the cell changes state.
void	onCellValueChanged(VSField cell, Value value, GProp<?> trigger, IPostEventProcessing postProcessing) Called when the cell value is set.
void	onParentStateChanged(IVSComponent parent, IVSComponentState.State state, boolean on) Called when the column changes state.
void	onResolved(VSRelativeReference<?> reference, VSTable table) Called when the property reference has been resolved.
void	onRowAdded(VSRow row, int index) Called when a row is added.
void	onRowRemoved(VSRow row, int index) Called when a row is removed.
void	onRowStateChanged(VSRow row, IVSComponentState.State state, boolean on) Called when a row selection state changed.
void	onSingleSelectionChanged(VSTable table, int index) Called when the single selection changes.
void	onStateChanged(VSTable table, IVSComponentState.State state, boolean on) Called when the table changes state.
void	onVirtualSpaceVirtualized(IAppSessionGyro appGyro, VirtualSpace virtualizedVirtualSpace) Called when the VirtualSpace has been virtualized, giving the opportunity for e.g.

Methods inherited from class com.iizix.prop.vs.VSVariables

getVariables

Methods inherited from class com.iizix.prop.PropCnr

__transferChildProps, addPredefinedProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, createVSReference, doPropEqualsArrayValues, doVirtualizePropCnr, enablePropCommunication, enablePropHashMap, equalsTree, equalsTree, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsContainer, getExtendsError, getExtendsName, getExtendsOverride, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getPredefinedProps, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getReferences, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, hasFocus, hasSendData, initializeElement, initializeExtendsFramework, initializeProp, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, paramString, prepare, removeAllProps, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, replaceProps, requestFocus, requestFocus, requestFocusEx, requestFocusEx, resolveReferences, resolveRuntimeReferences, setBool, setBool, setBool, setBool, setCreateRequiredProp, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, shouldCreateProps, toElementString, toNativeValue0, usePropHashMap, usesPropIndex, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, verify, verifyInternalUseOnly, verifyTree, virtualize

Methods inherited from class com.iizix.prop.GProp

addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalValues, extendsClone, finalize, fine, fine, finer, finer, finest, finest, fromElementString, getAliasName, getAppSessionGyro, getAppWorker, getAtomPath, getAttribute, getChildReferencePropName, getClientSessionGyro, getClientWorker, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropName, getFullPropNameDebug, getFullPropNameDebug, getListeners, getParent, getParent, getProjectName, getPropAtom, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onRemoteEvent, onVirtualizationCompleted, onVirtualized, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.iizix.prop.vs.IVSParticipant

assignVirtualSpace, getVSParticipantAtom

Methods inherited from interface com.iizix.prop.IReferrerParticipant

isParticipating, isPrimaryParticipant

Methods inherited from interface com.iizix.prop.IPropCnr

addProp, addProp, addProp2, addProp2, canRequestFocus, canRequestFocus, canRequestFocus, containsProp, containsProp, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, enablePropCommunication, enablePropHashMap, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsError, getExtendsName, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropCnr, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getString, getString, getString, getString, hasFocus, initializeExtendsFramework, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsRoot, isPropAddRemoveAllowed, isPropExtended, isSibling, removeAllProps, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, requestFocus, requestFocusEx, setBool, setBool, setBool, setBool, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, usePropHashMap, usesPropIndex, validateClassInstances

Methods inherited from interface com.iizix.prop.IGProp

addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getClientSessionGyro, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getParent, getParent, getPropAtom, getPropBaseReference, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getReferences, getRelativePropName, getRootParent, getTreeLock, getValueClasses, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCommunicating, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPropTreeInitialized, onRemoteEvent, removePropError, removePropListener, renameProp, resolveRuntimeReferences, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toElementString, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, validatePropType, validatePropValue, verify, verifyHasPropertyItem, warning, warning, warning

Methods inherited from interface com.iizix.prop.IClassInstantiationAtResolve

shouldInstantiateAtResolve

Constructor Detail

ResultSetProps

public ResultSetProps()

Creates a Result Set property container with the specified name with a null value.

ResultSetProps

public ResultSetProps(Atom propertyAtom)

Creates a Result Set property container with the specified name with a null value.

Parameters:

propertyAtom - the property atom.

Method Detail

clone

public ResultSetProps clone()

Clones this ResultSetProp.

Overrides:

clone in class VSVariables

getDatabaseProps

public DatabaseProps getDatabaseProps()

Gets the Database Transaction properties.

Returns:

The Database Transaction properties, or null if this property is orphaned.

getDescription

public String getDescription()

Gets the result set description.

Returns:

A description, or null for none.

getColumns

public ResultSetColumnProp[] getColumns()

Gets the result set columns.

Returns:

An array of result set columns, unordered in relation to the column index. Note that too many or too few columns may be returned in comparison to the query statement.

getMaximumRowCount

public int getMaximumRowCount()

Gets the maximum number of rows to retrieve.

Returns:

Zero for indefinite, otherwise a value for maximum row count.

getParticipantDescription

public String getParticipantDescription()

Returns the given description of the referrer participant.

Specified by:

getParticipantDescription in interface IReferrerParticipant

getParticipantType

public String getParticipantType()

Returns the given type of the referrer participant.

Specified by:

getParticipantType in interface IReferrerParticipant

getVSReference

public VSParticipant getVSReference(Atom refAtom)

Gets a VSReference instance from the container or any parent containers. The method is used by VSRelativeReference to look up the VSReference instance in order to resolve the relative path to the target property.

Specified by:

getVSReference in interface IGProp<GProp<?>[]>

Overrides:

getVSReference in class PropCnr

Parameters:

refAtom - The property atom of the requesting relative reference property.

Returns:

The instance of the VSReference or null if unassigned.

getVirtualSpace

public VirtualSpace getVirtualSpace()

Gets the VirtualSpace.

Specified by:

getVirtualSpace in interface IVSAccessor

Returns:

The VirtualSpace connected to the result set, or null for none.

getTargetVirtualSpaceParticipant

public VSParticipant getTargetVirtualSpaceParticipant()

Gets the target VirtualSpace participant for output data.

Returns:

The target VirtualSpace participating with the output data, null for none.

getVSTableReference

public VSTableReference getVSTableReference()

Gets the VirtualSpace table reference for all the output.

Returns:

The VSTableReference, null for none.

getVSTableReferenceOwnerData

public VSReferenceOwnerData<VSTable,VSTableReference> getVSTableReferenceOwnerData()

Gets the table reference owner data for the table column reference.

Returns:

The VSReferenceOwnerData instance, always non-null.

getVSTable

public VSTable getVSTable()

Gets the VirtualSpace table for all the output.

Returns:

The VirtualSpace Table, null for none.

doOverwrite

public boolean doOverwrite()

Gets the flag if the table should overwrite existing entries in the VSTable when populating it. Default is to clear the table before populating it.

Returns:

true to overwrite, false otherwise.

onResolved

public void onResolved(VSRelativeReference<?> reference,
                       VSTable table)

Called when the property reference has been resolved. UI components use this method to set its state according to the field.

Specified by:

onResolved in interface IVSTableListener

Parameters:

reference - The VSRelativeReference instance holding the reference.

table - The target reference.

onBroken

public void onBroken(VSRelativeReference<?> reference,
                     VSTable table)

Called when the property reference has been broken, i.e. unresolved.

Specified by:

onBroken in interface IVSTableListener

Parameters:

reference - The VSRelativeReference instance holding the reference.

table - The target reference.

onStateChanged

public void onStateChanged(VSTable table,
                           IVSComponentState.State state,
                           boolean on)

Called when the table changes state.

Specified by:

onStateChanged in interface IVSTableListener

Parameters:

table - The VS table.

state - The state change.

on - New state.

onSingleSelectionChanged

public void onSingleSelectionChanged(VSTable table,
                                     int index)

Called when the single selection changes.

Specified by:

onSingleSelectionChanged in interface IVSTableListener

Parameters:

table - The table.

index - The row index, -1 if table is unselected.

onParentStateChanged

public void onParentStateChanged(IVSComponent parent,
                                 IVSComponentState.State state,
                                 boolean on)

Called when the column changes state.

Specified by:

onParentStateChanged in interface IVSComponentListener

Parameters:

parent - The parent who's state was changed.

state - The state change, possible values PARENT_ENABLED, PARENT_READONLY, PARENT_VISIBLE.

on - New state.

onRowAdded

public void onRowAdded(VSRow row,
                       int index)

Called when a row is added.

Specified by:

onRowAdded in interface IVSTableListener

Parameters:

row - The row.

index - The index.

onRowRemoved

public void onRowRemoved(VSRow row,
                         int index)

Called when a row is removed.

Specified by:

onRowRemoved in interface IVSTableListener

Parameters:

row - The row.

index - The index.

onRowStateChanged

public void onRowStateChanged(VSRow row,
                              IVSComponentState.State state,
                              boolean on)

Called when a row selection state changed.

Specified by:

onRowStateChanged in interface IVSTableListener

Parameters:

row - The row.

state - The state change.

on - New state.

onCellStateChanged

public void onCellStateChanged(VSField cell,
                               IVSComponentState.State state,
                               boolean on)

Called when the cell changes state.

Specified by:

onCellStateChanged in interface IVSTableListener

Parameters:

cell - The VS cell.

state - The state change.

on - New state.

onCellValueChanged

public void onCellValueChanged(VSField cell,
                               Value value,
                               GProp<?> trigger,
                               IPostEventProcessing postProcessing)

Called when the cell value is set.

Specified by:

onCellValueChanged in interface IVSTableListener

Parameters:

cell - The VS field.

value - The value, never null, but value.isNull() could be true.

trigger - The trigger property that may be null.

postProcessing - Post-processing instance.

getClassReference

public ClassReference getClassReference()

The Java class associated with result set output.

Returns:

The ClassReference instance, or null for none.

getResultSetProcessor

public IResultSetProcessor getResultSetProcessor()

Gets the instance of the IResultSetProcessor.

Returns:

The instance of IResultSetProcessor, or null for none.

onVirtualSpaceVirtualized

public void onVirtualSpaceVirtualized(IAppSessionGyro appGyro,
                                      VirtualSpace virtualizedVirtualSpace)

Called when the VirtualSpace has been virtualized, giving the opportunity for e.g. data connectors to prepare it's virtualized counterparts if this is required.

This call is done to the non-virtualized instance of the VirtualSpace participant.

Specified by:

onVirtualSpaceVirtualized in interface IVSParticipant

Parameters:

appGyro - The application gyro instance.

virtualizedVirtualSpace - The virtualized VirtualSpace instance.