org.apache.openjpa.slice.jdbc
Class TargetFetchConfiguration
java.lang.Object
   org.apache.openjpa.kernel.FetchConfigurationImpl
org.apache.openjpa.kernel.FetchConfigurationImpl
       org.apache.openjpa.jdbc.kernel.JDBCFetchConfigurationImpl
org.apache.openjpa.jdbc.kernel.JDBCFetchConfigurationImpl
           org.apache.openjpa.slice.jdbc.TargetFetchConfiguration
org.apache.openjpa.slice.jdbc.TargetFetchConfiguration
- All Implemented Interfaces: 
- Serializable, Cloneable, EagerFetchModes, JDBCFetchConfiguration, LRSSizes, JoinSyntaxes, FetchConfiguration, LockLevels, LockScopes, QueryFlushModes
- public class TargetFetchConfiguration 
- extends JDBCFetchConfigurationImpl- implements FetchConfiguration
A fetch configuration that is aware of special hint to narrow its operation on 
 subset of slices.
- Author:
- Pinaki Poddar
- See Also:
- Serialized Form
 
 
 
 
 
 
 
 
 
 
 
 
 
 
| Methods inherited from class org.apache.openjpa.jdbc.kernel.JDBCFetchConfigurationImpl | 
| addFetchInnerJoin, addFetchInnerJoins, addJoin, addJoins, clearJoins, copy, getEagerFetchMode, getFetchDirection, getFetchInnerJoins, getIgnoreDfgForFkSelect, getIsolation, getJoins, getJoinSyntax, getLRSSize, getResultSetType, getSubclassFetchMode, getSubclassFetchMode, hasFetchInnerJoin, hasJoin, newResultList, removeJoin, removeJoins, setContext, setEagerFetchMode, setFetchDirection, setIgnoreDfgForFkSelect, setIsolation, setJoinSyntax, setLRSSize, setResultSetType, setSubclassFetchMode, traverseJDBC | 
 
| Methods inherited from class org.apache.openjpa.kernel.FetchConfigurationImpl | 
| addFetchGroup, addFetchGroups, addField, addFields, clearFetchGroups, clearFields, clone, getCacheRetrieveMode, getCacheStoreMode, getContext, getExtendedPathLookup, getFetchBatchSize, getFetchGroups, getFields, getFlushBeforeQueries, getHint, getHints, getLockScope, getLockTimeout, getMaxFetchDepth, getQueryCacheEnabled, getQueryTimeout, getReadLockLevel, getRootClasses, getRootInstances, getSupportedHints, getWriteLockLevel, hasFetchGroup, hasFetchGroupAll, hasFetchGroupDefault, hasField, isHintSet, lock, populateHintSetter, populateHintSetter, removeFetchGroup, removeFetchGroups, removeField, removeFields, removeHint, removeHint, requiresFetch, requiresLoad, resetFetchGroups, setCacheRetrieveMode, setCacheStoreMode, setExtendedPathLookup, setFetchBatchSize, setFlushBeforeQueries, setLockScope, setLockTimeout, setMaxFetchDepth, setQueryCacheEnabled, setQueryTimeout, setReadLockLevel, setRootClasses, setRootInstances, setWriteLockLevel, toString, toString, traverse, unlock | 
 
 
| Methods inherited from interface org.apache.openjpa.kernel.FetchConfiguration | 
| addFetchGroup, addFetchGroups, addField, addFields, clearFetchGroups, clearFields, clone, copy, getCacheRetrieveMode, getCacheStoreMode, getContext, getExtendedPathLookup, getFetchBatchSize, getFetchGroups, getFields, getFlushBeforeQueries, getHint, getHints, getLockScope, getLockTimeout, getMaxFetchDepth, getQueryCacheEnabled, getQueryTimeout, getReadLockLevel, getRootClasses, getRootInstances, getWriteLockLevel, hasFetchGroup, hasField, isHintSet, lock, newResultList, removeFetchGroup, removeFetchGroups, removeField, removeFields, requiresFetch, requiresLoad, resetFetchGroups, setCacheRetrieveMode, setCacheStoreMode, setContext, setExtendedPathLookup, setFetchBatchSize, setFlushBeforeQueries, setLockScope, setLockTimeout, setMaxFetchDepth, setQueryCacheEnabled, setQueryTimeout, setReadLockLevel, setRootClasses, setRootInstances, setWriteLockLevel, traverse, unlock | 
 
_explicitTarget
boolean _explicitTarget
TargetFetchConfiguration
public TargetFetchConfiguration()
TargetFetchConfiguration
protected TargetFetchConfiguration(FetchConfigurationImpl.ConfigurationState state,
                                   JDBCFetchConfigurationImpl.JDBCConfigurationState jstate)
setHint
public void setHint(String key,
                    Object value)
- Setting hints on this configuration is treated specially if the given key
 is a target hint.
 
- 
- Specified by:
- setHintin interface- FetchConfiguration
- Overrides:
- setHintin class- FetchConfigurationImpl
 
- 
- Parameters:
- value- if the given key is target hint, then the value can be either
 null, a String or a non-zero sized String array. It can not be a zero-sized
 String array.
- See Also:
- FetchConfigurationImpl.setHint(String, Object, Object)
 
setHint
public void setHint(String key,
                    Object value,
                    Object original)
- Description copied from class: FetchConfigurationImpl
- Sets the hint to the given value.
 If the key corresponds to a known key, then that value is set via the setter method.
 Otherwise it is put into opaque hints map.  
 
 In either case, the original value is put in the hints map.
 So essential difference between setting a value directly by a setter and via a hint is the memory
 of this original value.
 The other important difference is setting lock levels. Setting of lock level via setter method needs
 active transaction. But setting via hint does not.
 
- 
- Specified by:
- setHintin interface- FetchConfiguration
- Overrides:
- setHintin class- FetchConfigurationImpl
 
- 
- Parameters:
- key- a hint key. If it is one of the statically registered hint key then the setter is called.
- value- to be set. The given value type must match the argument type of the setter, if one exists.
- original- value as specified by the caller. This value is put in the hints map.
 
setTargets
public void setTargets(String[] targets)
- 
 
- 
 
isExplicitTarget
public boolean isExplicitTarget()
- Affirms if the target is set on this receiver explicitly (i.e. by the user).
 
- 
 
- 
 
toSliceNames
String[] toSliceNames(Object o,
                      boolean user)
- 
 
- 
 
assertTargets
void assertTargets(String[] targets,
                   boolean user)
- 
 
- 
 
newInstance
protected TargetFetchConfiguration newInstance(FetchConfigurationImpl.ConfigurationState state)
- Description copied from class: FetchConfigurationImpl
- Return a new hollow instance.
 
- 
- Overrides:
- newInstancein class- JDBCFetchConfigurationImpl
 
- 
 
Copyright © 2006-2012 Apache Software Foundation. All Rights Reserved.