| org.jpox.store.scostore.MapStore
| MapStore | | public interface MapStore extends Store(Code) | | Interface representation of the backing store for a Map.
version:
$Revision: 1.17 $ |
| Method Summary | |
| void | clear(StateManager ownerSM)
Method to clear the collection.
Parameters:
ownerSM - State Manager for the collection. | | boolean | containsKey(StateManager ownerSM, Object key)
Accessor for whether the Map contains this key. | | boolean | containsValue(StateManager ownerSM, Object value)
Accessor for whether the Map contains this value. | | SetStore | entrySetStore()
Accessor for the entry set for the Map. | | Object | get(StateManager ownerSM, Object key)
Accessor for a value from the Map.
Parameters:
ownerSM - State Manager for the Map. | | QueryExpression | getExistsSubquery(QueryExpression stmt, JavaTypeMapping ownerMapping, LogicSetExpression ownerTe, DatastoreIdentifier mapRangeVar)
Create a subquery for the given query that joins a MapStore value table to the owner table.
This subquery can subsequently be used in an EXISTS expression to determine whether a Map is empty or not. | | String | getKeyType()
Accessor for the key type in the collection. | | QueryExpression | getSizeSubquery(QueryExpression stmt, JavaTypeMapping ownerMapping, LogicSetExpression ownerTe, DatastoreIdentifier mapRangeVar)
Create a subquery for the size of the map. | | String | getValueType()
Accessor for the value type in the collection. | | ScalarExpression | joinKeysTo(QueryExpression stmt, QueryExpression parentStmt, JavaTypeMapping ownerMapping, LogicSetExpression te, DatastoreIdentifier mapRangeVar, Class filteredKeyType, ScalarExpression keyExpr, DatastoreIdentifier keyRangeVar)
Utility to create a join for keys to be used in a containsKey() query.
Parameters:
stmt - The Query Statement
Parameters:
parentStmt - the parent Query Statement. | | ScalarExpression[] | joinKeysToGet(QueryExpression stmt, QueryExpression parentStmt, JavaTypeMapping ownerMapping, LogicSetExpression ownerTe, DatastoreIdentifier mapRangeVar, Class filteredKeyType, DatastoreIdentifier keyRangeVar, DatastoreIdentifier valueRangeVar)
Used as part of the Querying of Maps where a get(Key) is used.
Parameters:
stmt - The Query Statement to apply the join
Parameters:
parentStmt - the parent Query Statement. | | ScalarExpression[] | joinKeysValuesTo(QueryExpression stmt, QueryExpression parentStmt, JavaTypeMapping ownerMapping, LogicSetExpression te, DatastoreIdentifier mapRangeVar, Class filteredKeyType, Class filteredValueType, ScalarExpression keyExpr, ScalarExpression valExpr, DatastoreIdentifier keyRangeVar, DatastoreIdentifier valueRangeVar)
Utility to create a join for keys and values to be used in ai
containsEntry() query.
Parameters:
stmt - The Query Statement to apply the join
Parameters:
parentStmt - the parent Query Statement. | | ScalarExpression | joinValuesTo(QueryExpression stmt, QueryExpression parentStmt, JavaTypeMapping ownerMapping, LogicSetExpression ownerTe, DatastoreIdentifier mapRangeVar, Class filteredValueType, ScalarExpression valExpr, DatastoreIdentifier valueRangeVar)
Used as part of the Querying of Maps where a containsValue() is used.
Parameters:
stmt - The Query Statement
Parameters:
parentStmt - the parent Query Statement. | | SetStore | keySetStore(ClassLoaderResolver clr)
Accessor for the keys in the Map. | | boolean | keysAreEmbedded()
| | boolean | keysAreSerialised()
| | QueryExpression | newQueryStatement(StateManager ownerSM, String candidateClass, DatastoreIdentifier candidateAlias)
Method to create a query statement for a Map with values of the supplied
candidate class. | | ResultObjectFactory | newResultObjectFactory(StateManager ownerSM, QueryExpression stmt, boolean ignoreCache, boolean useFetchPlan)
Utility to create a Result Object Factory to process the results of
selects returning values. | | Object | put(StateManager ownerSM, Object key, Object value)
Method to add a value to the Map against this key.
Parameters:
ownerSM - State Manager for the Map. | | void | putAll(StateManager ownerSM, Map m)
Method to add a map of values to the Map.
Parameters:
ownerSM - State Manager for the Map. | | Object | remove(StateManager ownerSM, Object key)
Method to remove a value from the Map.
Parameters:
ownerSM - State Manager for the Map. | | boolean | updateEmbeddedKey(StateManager sm, Object key, int fieldNumber, Object newValue)
Method to update en embedded key in the collection. | | boolean | updateEmbeddedValue(StateManager sm, Object value, int fieldNumber, Object newValue)
Method to update en embedded value in the collection. | | SetStore | valueSetStore(ClassLoaderResolver clr)
Accessor for the values in the Map. | | boolean | valuesAreEmbedded()
| | boolean | valuesAreSerialised()
|
| clear | | void clear(StateManager ownerSM)(Code) | | Method to clear the collection.
Parameters:
ownerSM - State Manager for the collection. |
| containsKey | | boolean containsKey(StateManager ownerSM, Object key)(Code) | | Accessor for whether the Map contains this key.
Parameters:
ownerSM - State Manager for the Map.
Parameters:
key - The key to check Whether it is contained. |
| containsValue | | boolean containsValue(StateManager ownerSM, Object value)(Code) | | Accessor for whether the Map contains this value.
Parameters:
ownerSM - State Manager for the Map.
Parameters:
value - The value to check Whether it is contained. |
| entrySetStore | | SetStore entrySetStore()(Code) | | Accessor for the entry set for the Map.
Entry set for the Map. |
| get | | Object get(StateManager ownerSM, Object key)(Code) | | Accessor for a value from the Map.
Parameters:
ownerSM - State Manager for the Map.
Parameters:
key - Key for the value. Value for this key. |
| getExistsSubquery | | QueryExpression getExistsSubquery(QueryExpression stmt, JavaTypeMapping ownerMapping, LogicSetExpression ownerTe, DatastoreIdentifier mapRangeVar)(Code) | | Create a subquery for the given query that joins a MapStore value table to the owner table.
This subquery can subsequently be used in an EXISTS expression to determine whether a Map is empty or not.
Parameters:
stmt - The parent query statement that will use this as a subquery
Parameters:
ownerMapping - the mapping for the owner
Parameters:
ownerTe - Table Expression for the owner that the subquery joins to
Parameters:
mapRangeVar - The range variable for the "Map" table. A subquery for the given query that joins a MapStore valuetable to the owner table. |
| getKeyType | | String getKeyType()(Code) | | Accessor for the key type in the collection.
The key type. |
| getSizeSubquery | | QueryExpression getSizeSubquery(QueryExpression stmt, JavaTypeMapping ownerMapping, LogicSetExpression ownerTe, DatastoreIdentifier mapRangeVar)(Code) | | Create a subquery for the size of the map.
Parameters:
stmt - The parent query statement that will use this as a subquery
Parameters:
ownerMapping - the mapping for the owner
Parameters:
ownerTe - Table Expression for the owner that the subquery joins to
Parameters:
mapRangeVar - Range variable for this subquery main table A subquery for the size. |
| getValueType | | String getValueType()(Code) | | Accessor for the value type in the collection.
The value type. |
| joinKeysTo | | ScalarExpression joinKeysTo(QueryExpression stmt, QueryExpression parentStmt, JavaTypeMapping ownerMapping, LogicSetExpression te, DatastoreIdentifier mapRangeVar, Class filteredKeyType, ScalarExpression keyExpr, DatastoreIdentifier keyRangeVar)(Code) | | Utility to create a join for keys to be used in a containsKey() query.
Parameters:
stmt - The Query Statement
Parameters:
parentStmt - the parent Query Statement. If there is no parent, parentStmt must be equals to stmt
Parameters:
ownerMapping - Mapping for the owner
Parameters:
te - Table Expression for the owner
Parameters:
mapRangeVar - The range variable for the "Map" table.
Parameters:
filteredKeyType - The Class Type for the filtered key
Parameters:
keyExpr - the expression to the key field. if not provided, obtain the expression of the ID of the table where filteredKeyType is stored
Parameters:
keyRangeVar - The SQL alias, or "range variable", to assign to theexpression or to the key table. QueryColumnList with the columns from the key mapping |
| joinKeysToGet | | ScalarExpression[] joinKeysToGet(QueryExpression stmt, QueryExpression parentStmt, JavaTypeMapping ownerMapping, LogicSetExpression ownerTe, DatastoreIdentifier mapRangeVar, Class filteredKeyType, DatastoreIdentifier keyRangeVar, DatastoreIdentifier valueRangeVar)(Code) | | Used as part of the Querying of Maps where a get(Key) is used.
Parameters:
stmt - The Query Statement to apply the join
Parameters:
parentStmt - the parent Query Statement. If there is no parent, parentStmt must be equals to stmt
Parameters:
ownerMapping - Mapping for the owner
Parameters:
ownerTe - Table Expression for the owner
Parameters:
mapRangeVar - The SQL alias, or "range variable", to assign to theexpression or to the main table.
Parameters:
filteredKeyType - The Class Type for the filtered key
Parameters:
keyRangeVar - The SQL alias, or "range variable", to assign to theexpression or to the key table.
Parameters:
valueRangeVar - The SQL alias, or "range variable", to assign to theexpression or to the value table. an array with 2 elements of QueryColumnList. The first elementcontains the columns from the key mapping and the second element thecolumns from the value mapping |
| joinKeysValuesTo | | ScalarExpression[] joinKeysValuesTo(QueryExpression stmt, QueryExpression parentStmt, JavaTypeMapping ownerMapping, LogicSetExpression te, DatastoreIdentifier mapRangeVar, Class filteredKeyType, Class filteredValueType, ScalarExpression keyExpr, ScalarExpression valExpr, DatastoreIdentifier keyRangeVar, DatastoreIdentifier valueRangeVar)(Code) | | Utility to create a join for keys and values to be used in ai
containsEntry() query.
Parameters:
stmt - The Query Statement to apply the join
Parameters:
parentStmt - the parent Query Statement. If there is no parent, parentStmt must be equals to stmt
Parameters:
ownerMapping - Mapping for the owner
Parameters:
te - Table Expression for the owner
Parameters:
mapRangeVar - The SQL alias, or "range variable", to assign to theexpression or to the main table.
Parameters:
filteredKeyType - The Class Type for the filtered key
Parameters:
filteredValueType - The Class Type for the filtered value
Parameters:
keyExpr - the expression to the key field
Parameters:
valExpr - Table Expression for the value
Parameters:
keyRangeVar - The SQL alias, or "range variable", to assign to theexpression or to the key table.
Parameters:
valueRangeVar - The SQL alias, or "range variable", to assign to theexpression or to the value table. an array with 2 elements of QueryColumnList. The first elementcontains the columns from the key mapping and the second element thecolumns from the value mapping |
| joinValuesTo | | ScalarExpression joinValuesTo(QueryExpression stmt, QueryExpression parentStmt, JavaTypeMapping ownerMapping, LogicSetExpression ownerTe, DatastoreIdentifier mapRangeVar, Class filteredValueType, ScalarExpression valExpr, DatastoreIdentifier valueRangeVar)(Code) | | Used as part of the Querying of Maps where a containsValue() is used.
Parameters:
stmt - The Query Statement
Parameters:
parentStmt - the parent Query Statement. If there is no parent, parentStmt must be equals to stmt
Parameters:
ownerMapping - Mapping for the owner
Parameters:
ownerTe - Table Expression for the owner
Parameters:
mapRangeVar - The range variable for the "Map" table.
Parameters:
filteredValueType - The Class Type for the filtered value
Parameters:
valExpr - the expression to the value field. if not provided, obtain the expression of the ID of the table where filteredValueType is stored
Parameters:
valueRangeVar - The SQL alias, or "range variable", to assign to theexpression or to the value table. QueryColumnList with the columns from the value mapping |
| keysAreEmbedded | | boolean keysAreEmbedded()(Code) | | Accessor for whether the keys are embedded
Whether we have embedded keys |
| keysAreSerialised | | boolean keysAreSerialised()(Code) | | Accessor for whether the keys are serialised
Whether we have serialised keys |
| newQueryStatement | | QueryExpression newQueryStatement(StateManager ownerSM, String candidateClass, DatastoreIdentifier candidateAlias)(Code) | | Method to create a query statement for a Map with values of the supplied
candidate class.
Parameters:
ownerSM - StateManager for the Map
Parameters:
candidateClass - The class for the values
Parameters:
candidateAlias - Alias for the candidate The Query Statement. |
| newResultObjectFactory | | ResultObjectFactory newResultObjectFactory(StateManager ownerSM, QueryExpression stmt, boolean ignoreCache, boolean useFetchPlan)(Code) | | Utility to create a Result Object Factory to process the results of
selects returning values.
Parameters:
ownerSM - State Manager for the Map.
Parameters:
stmt - The Query Statement
Parameters:
ignoreCache - Whether to ignore the cache
Parameters:
useFetchPlan - whether to use the fetch plan to retrieve fields in the same query The result object factory. |
| put | | Object put(StateManager ownerSM, Object key, Object value)(Code) | | Method to add a value to the Map against this key.
Parameters:
ownerSM - State Manager for the Map.
Parameters:
key - The key.
Parameters:
value - The value. Value that was previously against this key. |
| putAll | | void putAll(StateManager ownerSM, Map m)(Code) | | Method to add a map of values to the Map.
Parameters:
ownerSM - State Manager for the Map.
Parameters:
m - The map to add. |
| remove | | Object remove(StateManager ownerSM, Object key)(Code) | | Method to remove a value from the Map.
Parameters:
ownerSM - State Manager for the Map.
Parameters:
key - Key whose value is to be removed. Value that was removed. |
| updateEmbeddedKey | | boolean updateEmbeddedKey(StateManager sm, Object key, int fieldNumber, Object newValue)(Code) | | Method to update en embedded key in the collection.
Parameters:
sm - State Manager of the owner
Parameters:
key - The element
Parameters:
fieldNumber - Field to update in the key
Parameters:
newValue - The new value for the field Whether the element was modified |
| updateEmbeddedValue | | boolean updateEmbeddedValue(StateManager sm, Object value, int fieldNumber, Object newValue)(Code) | | Method to update en embedded value in the collection.
Parameters:
sm - State Manager of the owner
Parameters:
value - The element
Parameters:
fieldNumber - Field to update in the value
Parameters:
newValue - The new value for the field Whether the element was modified |
| valueSetStore | | SetStore valueSetStore(ClassLoaderResolver clr)(Code) | | Accessor for the values in the Map.
Parameters:
clr - The ClassLoaderResolver Values for the Map. |
| valuesAreEmbedded | | boolean valuesAreEmbedded()(Code) | | Accessor for whether the values are embedded
Whether we have embedded values |
| valuesAreSerialised | | boolean valuesAreSerialised()(Code) | | Accessor for whether the values are serialised
Whether we have serialised values |
|
|