Examples of FetchGroup

javax.jdo.FetchGroup
FetchGroup represents a named fetch group for a specific class or interface. A fetch group instance identifies the name of the class or interface, the list of members (fields or properties) to be fetched when the fetch group is active, and the recursion depth for each member.
Fetch groups are updated using methods on this interface. An instance of a class implementing this interface can be obtained from {@link PersistenceManager#getFetchGroup} or{@link PersistenceManagerFactory#getFetchGroup}.
A FetchGroup can be unscoped or can be in one of two scopes (the {@link PersistenceManager} or the {@link PersistenceManagerFactory} scope). Unscoped FetchGroups do not affect any behavior. A FetchGroup in PersistenceManager scope hides the corresponding FetchGroup in the PersistenceManagerFactory scope.
- When a FetchGroup is obtained via {@link PersistenceManager#getFetchGroup}, it is immediately in scope of its PersistenceManager. Subsequent modifications of the FetchGroup immediately affect FetchPlans that contain the FetchGroup.
- When a FetchGroup is obtained via {@link PersistenceManagerFactory#getFetchGroup}, it is unscoped.
- When a FetchGroup is added to the set of active FetchGroups via {@link PersistenceManagerFactory#addFetchGroups}, it is put in scope of the PersistenceManagerFactory.
- When a FetchGroup is removed from the set of active FetchGroups via {@link PersistenceManagerFactory#removeFetchGroups}, {@link PersistenceManagerFactory#removeAllFetchGroups}, or replaced via {@link PersistenceManagerFactory#addFetchGroups}, it is unscoped.
@version 2.2 @since 2.2
oracle.toplink.essentials.queryframework.FetchGroup

Purpose: A fetch group is a performance enhancement that allows a group of attributes of an object to be loaded on demand, which means that the data for an attribute might not loaded from the underlying data source until an explicit access call for the attribute first occurs. It avoids the wasteful practice of loading up all data of the object?s attributes, in which the user is interested in only partial of them. A great deal of caution and careful system use case analysis should be use when using the fetch group feature, as the extra round-trip would well offset the gain from the deferred loading in many cases. TopLink fetch group support is twofold: the pre-defined fetch groups at the descriptor level; and dynamic (use case) fetch groups at the query level. TopLink fetch group support is only on CMP project. Every query can has at most one fetch group. There is an optional pre-defined default fetch group at the descriptor level. If set, and the query has no fetch group being set, the default fetch group would be used, unless query.setShouldUseDefaultFetchGroup(false) is also called. In the latter case, the full object will be fetched after the query execution. @see oracle.toplink.essentials.queryframework.FetchGroup @see oracle.toplink.essentials.queryframework.FetchGroupTracker @author King Wang @since TopLink 10.1.3.
org.apache.james.mailbox.MessageResult.FetchGroup
org.apache.james.mailbox.model.MessageResult.FetchGroup
org.apache.openjpa.meta.FetchGroup
Captures fetch group metadata.
org.datanucleus.FetchGroup
Group of fields for fetching, to be part of a FetchPlan. Defined at runtime, via the API.
org.eclipse.persistence.queries.FetchGroup
A FetchGroup is a performance enhancement that allows a group of attributes of an object to be loaded on demand, which means that the data for an attribute might not loaded from the underlying data source until an explicit access call for the attribute first occurs. It avoids loading all data of the object's attributes, in which the user is interested in only a subset of them. A great deal of caution and careful system use case analysis should be use when using the fetch group feature, as the extra round-trip would well offset the gain from the deferred loading in many cases.
FetchGroup usage is only possible when an entity class implements the {@link FetchGroupTracker} interface so that the FetchGroup can be stored inthe entity. The entity must also use the provided check methods to ensure the attributes are loaded prior to use. In general this support is enabled through weaving of the entity classes. If an entity class does not implement {@link FetchGroupTracker} no FetchGroup functionality will be supported andattempted use of a FetchGroup in a query will not result in the expected behavior.
FetchGroups are defined in 3 ways:
- A {@link FetchGroupManager#getDefaultFetchGroup()} is created and storedon the {@link FetchGroupManager} during metadata processing if any of thebasic ( {@link DirectToFieldMapping}) are configured to be loaded directly.
- A named FetchGroup can be defined and added to the {@link FetchGroupManager}. For JPA users this can be accomplished using annotation (@FetchGroup) or in an eclipselink-orm.xml. For JPA and native users named groups can be defined in code and added to the {@link FetchGroupManager#addFetchGroup(FetchGroup)}. Adding named groups in code is typically done in a {@link DescriptorCustomizer}and should be done before the session is initialized at login. To use a named FetchGroup on a query the native {@link ObjectLevelReadQuery#setFetchGroupName(String)} canbe used of for JPA users the {@link QueryHints#FETCH_GROUP_NAME} an be used.
- A dynamic FetchGroup can be created within the application and used on a query. For native API usage this is done using {@link ObjectLevelReadQuery#setFetchGroup(FetchGroup)} while JPA usersgenerally use the {@link QueryHints#FETCH_GROUP}.
When a query is executed only one FetchGroup will be used. The order of precedence is:
1. If a FetchGroup is specified on a query it will be used.
2. If no FetchGroup is specified but a FetchGroup name is specified and the FetchGroupManager has a group by this name it will be used.
3. If neither a FetchGroup nor a FetchGroup name is specified on the query an the FetchGroupManager has a default group then it will be used.
4. If none of these conditions are met then no FetchGroup will be used when executing a query.
  Note: This includes the execution of queries to populate lazy and eager relationships.
  Loading: A FetchGroup can optionally specify that it needs its included relationships loaded. This can be done using {@link #setShouldLoad(boolean)} and {@link #setShouldLoadAll(boolean)} aswell as the corresponding configurations in the @FetchGroup annotation and the element in the eclipselink-orm.xml. When this si configured the FetchGroup will also function as a {@link LoadGroup} causing all of itsspecified relationships to be populated prior to returning the results form the query execution. @see FetchGroupManager @see QueryHints#FETCH_GROUP @see LoadGroup @author King Wang, dclarke, ailitchev @since TopLink 10.1.3

Examples of javax.jdo.FetchGroup

323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340                 printFetchGroup(fg),                 64, fg.getRecursionDepth("manager"));     }     public void testPostLoad() {         FetchGroup fg = pm.getFetchGroup(Employee.class, "testPostLoad");         assertFalse("New FetchGroup should have post-load false; "                 + printFetchGroup(fg),                 fg.getPostLoad());         fg.setPostLoad(true);         assertTrue("After setPostLoad(true) FetchGroup should have post-load true; "                 + printFetchGroup(fg),                 fg.getPostLoad());         fg.setPostLoad(false);         assertFalse("After setPostLoad, FetchGroup should have post-load false; "                 + printFetchGroup(fg),                 fg.getPostLoad());     }

View Full Code Here

Examples of javax.jdo.FetchGroup

338 339 340 341 342 343 344 345 346 347 348 349 350 351                 + printFetchGroup(fg),                 fg.getPostLoad());     }     public void testUnmodifiableSetPostLoad() {         FetchGroup fg = pm.getFetchGroup(Employee.class, "testUnmodifiableSetPostLoad");         fg.setUnmodifiable();         try {             fg.setPostLoad(true);             fail("Unmodifiable FetchGroup should throw on setPostLoad.");         } catch(JDOException ex) {             // good catch!         }     }

View Full Code Here

Examples of javax.jdo.FetchGroup

349 350 351 352 353 354 355 356 357 358 359 360 361 362             // good catch!         }     }     public void testUnmodifiableAddMember() {         FetchGroup fg = pm.getFetchGroup(Employee.class, "testUnmodifiableAddMember");         fg.setUnmodifiable();         try {             fg.addMember("hiredate");             fail("Unmodifiable FetchGroup should throw on addMember.");         } catch(JDOException ex) {             // good catch!         }     }

View Full Code Here

Examples of javax.jdo.FetchGroup

360 361 362 363 364 365 366 367 368 369 370 371 372 373             // good catch!         }     }     public void testUnmodifiableAddMembers() {         FetchGroup fg = pm.getFetchGroup(Employee.class, "testUnmodifiableAddMembers");         fg.setUnmodifiable();         try {             fg.addMembers(allMembers);             fail("Unmodifiable FetchGroup should throw on addMembers.");         } catch(JDOException ex) {             // good catch!         }     }

View Full Code Here

Examples of javax.jdo.FetchGroup

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385             // good catch!         }     }     public void testUnmodifiableRemoveMember() {         FetchGroup fg = pm.getFetchGroup(Employee.class, "testUnmodifiableRemoveMember");         fg.addMembers(allMembers);         fg.setUnmodifiable();         try {             fg.removeMember("hiredate");             fail("Unmodifiable FetchGroup should throw on removeMember.");         } catch(JDOException ex) {             // good catch!         }     }

View Full Code Here

Examples of javax.jdo.FetchGroup

383 384 385 386 387 388 389 390 391 392 393 394 395 396 397             // good catch!         }     }     public void testUnmodifiableRemoveMembers() {         FetchGroup fg = pm.getFetchGroup(Employee.class, "testUnmodifiableRemoveMembers");         fg.addMembers(allMembers);         fg.setUnmodifiable();         try {             fg.removeMembers(allMembers);             fail("Unmodifiable FetchGroup should throw on removeMembers.");         } catch(JDOException ex) {             // good catch!         }     }

View Full Code Here

Examples of javax.jdo.FetchGroup

395 396 397 398 399 400 401 402 403 404 405 406 407 408             // good catch!         }     }     public void testUnmodifiableAddCategory() {         FetchGroup fg = pm.getFetchGroup(Employee.class, "testUnmodifiableAddCategory");         fg.setUnmodifiable();         try {             fg.addCategory(FetchGroup.ALL);             fail("Unmodifiable FetchGroup should throw on addCategory.");         } catch(JDOException ex) {             // good catch!         }     }

View Full Code Here

Examples of javax.jdo.FetchGroup

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420             // good catch!         }     }     public void testUnmodifiableRemoveCategory() {         FetchGroup fg = pm.getFetchGroup(Employee.class, "testUnmodifiableRemoveCategory");         fg.addCategory(FetchGroup.ALL);         fg.setUnmodifiable();         try {             fg.removeCategory(FetchGroup.ALL);             fail("Unmodifiable FetchGroup should throw on removeCategory.");         } catch(JDOException ex) {             // good catch!         }     }

View Full Code Here

Examples of oracle.toplink.essentials.queryframework.FetchGroup

148 149 150 151 152 153 154 155 156 157 158      * Return true if the object is partially fetched and cached.      * It applies to the query with fetch group.      */     public boolean isPartialObject(Object domainObject) {         if (domainObject != null) {             FetchGroup fetchGroupInCache = ((FetchGroupTracker)domainObject).getFetchGroup();             //if the fetch group reference is not null, it means the object is partial.             return (fetchGroupInCache != null);         }         return false;

View Full Code Here

Examples of oracle.toplink.essentials.queryframework.FetchGroup

161 162 163 164 165 166 167 168     /**      * INTERNAL:      * Return if the cached object data is sufficiently valid against a fetch group      */     public boolean isObjectValidForFetchGroup(Object object, FetchGroup fetchGroup) {         FetchGroup groupInObject = ((FetchGroupTracker)object).getFetchGroup();         return (groupInObject == null) || groupInObject.isSupersetOf(fetchGroup);     }

View Full Code Here

0 1 2 3 4 5

TOP

Copyright © 2018 www.massapi.com. All rights reserved.

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.