Java Doc for FetchPlan.java in  » Database-ORM » JPOX » org » jpox » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Database ORM » JPOX » org.jpox   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.jpox.FetchPlan FetchPlan public class FetchPlan implements Serializable(Code) FetchPlan for fields for use within JPOX Core. A FetchPlan has a series of FetchPlanForClass objects being the fetch plan for particular classes. Each FetchPlanForClass defines a series of fields of that class that are part of the fetch plan. There are two types of fetch groups under consideration here. Static fetch groups, defined in MetaData (XML/Annotations). Dynamic fetch groups, defined via an API. version:    $Revision: 1.11 $ Inner Class :public class FetchPlanForClass Field Summary final public static  String ALL      final public static  String DEFAULT      Constant defining the fields in the default fetch group. final public static  int DETACH_LOAD_FIELDS      Specify that fields that are not loaded but are in the current fetch plan should be loaded prior to detachment. final public static  int DETACH_UNLOAD_FIELDS      Specify that fields that are loaded but not in the current fetch plan should be unloaded prior to detachment. final public static  int FETCH_SIZE_GREEDY      Fetch size to load all possible. final public static  int FETCH_SIZE_OPTIMAL      Fetch size for the implementation to decide how many to load. final protected static  Localiser LOCALISER      final public static  String NONE      Constant defing no fields. final transient  ClassLoaderResolver clr      ClassLoader resolver.  int detachmentOptions      Options to be used during detachment.  Class[] detachmentRootClasses      The classes used as the roots for detachment (DetachAllOnCommit).  Collection detachmentRoots      The instances used as the roots for detachment (DetachAllOnCommit). transient  Set dynamicGroups      The "dynamic" fetch groups in the current FetchPlan.  int fetchSize      The Fetch size. final  Set groups      The "defined" fetch groups in the current FetchPlan. final transient  Map managedClass       int maxFetchDepth      Maximum depth to fetch from the root object. final transient  ObjectManagerFactoryImpl omf      ObjectManagerFactory. Constructor Summary public   FetchPlan(ObjectManagerFactoryImpl omf, ClassLoaderResolver clr)      Constructor. Method Summary public synchronized  FetchPlan addGroup(String fetchGroupName)      Method to add a group to the fetch plan. public synchronized  FetchPlan clearGroups()      Method to clear the current groups and activate the DFG. public synchronized  FetchPlan getCopy()      public  int getDetachmentOptions()      Return the options to be used at detachment. public  Class[] getDetachmentRootClasses()      Accessor for the root classes of the detachment graph for DetachAllOnCommit. public  Collection getDetachmentRoots()      Accessor for the roots of the detachment graph for DetachAllOnCommit. public synchronized  FetchPlanForClass getFetchPlanForClass(AbstractClassMetaData cmd)      public synchronized  int getFetchSize()      Accessor for the fetch size when using large result sets. public synchronized  Set getGroups()      Accessor for the static groups for this FetchPlan. public synchronized  int getMaxFetchDepth()      Accessor for the maximum fetch depth. public  FetchPlanForClass manageFetchPlanForClass(AbstractClassMetaData cmd)      public  void notifyFetchGroupChange(FetchGroup group)      Method to notify this FetchPlan that the specified FetchGroup has been updated. public  void notifyFetchGroupRemove(FetchGroup group)      Method to notify this FetchPlan that the specified FetchGroup has been updated. public synchronized  FetchPlan removeGroup(String fetchGroupName)      Method to remove a group from the fetch plan.  void resetDetachmentRoots()      Method called at commit() to clear out the detachment roots. public  FetchPlan setDetachmentOptions(int options)      Set the options to be used at detachment. public  FetchPlan setDetachmentRootClasses(Class[] rootClasses)      Set the classes used for roots of the detachment graph for DetachAllOnCommit. public  FetchPlan setDetachmentRoots(Collection roots)      Set the roots for DetachAllOnCommit Parameters:   roots - The roots of the detachment graph. public synchronized  FetchPlan setFetchSize(int fetchSize)      Method to set the fetch size when using large result sets. public synchronized  FetchPlan setGroup(String fetchGroupName)      Method to set the fetch group. public synchronized  FetchPlan setGroups(Collection fetchGroupNames)      Method to set the groups of the fetch plan. public synchronized  FetchPlan setGroups(String[] fetchGroupNames)      Method to set the groups using an array. public synchronized  FetchPlan setMaxFetchDepth(int max)      Mutator for the maximum fetch depth where -1 implies no restriction on the fetch depth and 0 is invalid and throws a JDOUserException. public  String toString()      Field Detail ALL final public static String ALL(Code) Constant defining all fields DEFAULT final public static String DEFAULT(Code) Constant defining the fields in the default fetch group. DETACH_LOAD_FIELDS final public static int DETACH_LOAD_FIELDS(Code) Specify that fields that are not loaded but are in the current fetch plan should be loaded prior to detachment. DETACH_UNLOAD_FIELDS final public static int DETACH_UNLOAD_FIELDS(Code) Specify that fields that are loaded but not in the current fetch plan should be unloaded prior to detachment. FETCH_SIZE_GREEDY final public static int FETCH_SIZE_GREEDY(Code) Fetch size to load all possible. FETCH_SIZE_OPTIMAL final public static int FETCH_SIZE_OPTIMAL(Code) Fetch size for the implementation to decide how many to load. LOCALISER final protected static Localiser LOCALISER(Code) Localisation utility for output messages NONE final public static String NONE(Code) Constant defing no fields. clr final transient ClassLoaderResolver clr(Code) ClassLoader resolver. detachmentOptions int detachmentOptions(Code) Options to be used during detachment. Spec 12.7 says that the default is DETACH_LOAD_FIELDS. detachmentRootClasses Class[] detachmentRootClasses(Code) The classes used as the roots for detachment (DetachAllOnCommit). detachmentRoots Collection detachmentRoots(Code) The instances used as the roots for detachment (DetachAllOnCommit). dynamicGroups transient Set dynamicGroups(Code) The "dynamic" fetch groups in the current FetchPlan. fetchSize int fetchSize(Code) The Fetch size. For use when using large result sets. groups final Set groups(Code) The "defined" fetch groups in the current FetchPlan. managedClass final transient Map managedClass(Code) Managed class keyed by ClassMetaData * maxFetchDepth int maxFetchDepth(Code) Maximum depth to fetch from the root object. omf final transient ObjectManagerFactoryImpl omf(Code) ObjectManagerFactory. Constructor Detail FetchPlan public FetchPlan(ObjectManagerFactoryImpl omf, ClassLoaderResolver clr)(Code) Constructor. Initially has the default fetch group. Parameters:   omf - ObjectManagerFactory Parameters:   clr - ClassLoader Resolver Method Detail addGroup public synchronized FetchPlan addGroup(String fetchGroupName)(Code) Method to add a group to the fetch plan. Parameters:   fetchGroupName - The fetch group to add Updated Fetch Plan clearGroups public synchronized FetchPlan clearGroups()(Code) Method to clear the current groups and activate the DFG. The FetchPlan getCopy public synchronized FetchPlan getCopy()(Code) Returns a copy of this FetchPlan with all settings initialized the FetchPlan getDetachmentOptions public int getDetachmentOptions()(Code) Return the options to be used at detachment. Detachment options getDetachmentRootClasses public Class[] getDetachmentRootClasses()(Code) Accessor for the root classes of the detachment graph for DetachAllOnCommit. The classes to be used as the root of the detachment graph. getDetachmentRoots public Collection getDetachmentRoots()(Code) Accessor for the roots of the detachment graph for DetachAllOnCommit. The roots of the detachment graph. getFetchPlanForClass public synchronized FetchPlanForClass getFetchPlanForClass(AbstractClassMetaData cmd)(Code) Access the fetch plan for the class Parameters:   cmd - the AbstractClassMetaData the FetchPlanForClass getFetchSize public synchronized int getFetchSize()(Code) Accessor for the fetch size when using large result sets. The size getGroups public synchronized Set getGroups()(Code) Accessor for the static groups for this FetchPlan. Doesn't return the dynamic groups. The fetch plan groups (unmodifiable) getMaxFetchDepth public synchronized int getMaxFetchDepth()(Code) Accessor for the maximum fetch depth. The maximum fetch depth manageFetchPlanForClass public FetchPlanForClass manageFetchPlanForClass(AbstractClassMetaData cmd)(Code) Manage the fetch plan for the class Parameters:   cmd - AbstractClassMetaData for the class to manage the FetchPlanForClass notifyFetchGroupChange public void notifyFetchGroupChange(FetchGroup group)(Code) Method to notify this FetchPlan that the specified FetchGroup has been updated. JPOX dynamic fetch groups extension Parameters:   group - The dynamic FetchGroup since:    1.2 notifyFetchGroupRemove public void notifyFetchGroupRemove(FetchGroup group)(Code) Method to notify this FetchPlan that the specified FetchGroup has been updated. JPOX dynamic fetch groups extension Parameters:   group - The dynamic FetchGroup since:    1.2 removeGroup public synchronized FetchPlan removeGroup(String fetchGroupName)(Code) Method to remove a group from the fetch plan. Parameters:   fetchGroupName - The fetch group to remove Updated Fetch Plan resetDetachmentRoots void resetDetachmentRoots()(Code) Method called at commit() to clear out the detachment roots. setDetachmentOptions public FetchPlan setDetachmentOptions(int options)(Code) Set the options to be used at detachment. Parameters:   options - The options The updated fetch plan. setDetachmentRootClasses public FetchPlan setDetachmentRootClasses(Class[] rootClasses)(Code) Set the classes used for roots of the detachment graph for DetachAllOnCommit. Parameters:   rootClasses - Classes to be used as roots of the detachment graph The fetch plan with these roots setDetachmentRoots public FetchPlan setDetachmentRoots(Collection roots)(Code) Set the roots for DetachAllOnCommit Parameters:   roots - The roots of the detachment graph. The fetch plan with these roots setFetchSize public synchronized FetchPlan setFetchSize(int fetchSize)(Code) Method to set the fetch size when using large result sets. Parameters:   fetchSize - the size Updated Fetch Plan setGroup public synchronized FetchPlan setGroup(String fetchGroupName)(Code) Method to set the fetch group. Parameters:   fetchGroupName - Name of the fetch group The Fetch Plan setGroups public synchronized FetchPlan setGroups(Collection fetchGroupNames)(Code) Method to set the groups of the fetch plan. Parameters:   fetchGroupNames - The fetch groups Updated Fetch Plan setGroups public synchronized FetchPlan setGroups(String[] fetchGroupNames)(Code) Method to set the groups using an array. Parameters:   fetchGroupNames - Names of the fetch groups The Fetch Plan setMaxFetchDepth public synchronized FetchPlan setMaxFetchDepth(int max)(Code) Mutator for the maximum fetch depth where -1 implies no restriction on the fetch depth and 0 is invalid and throws a JDOUserException. Parameters:   max - The maximum fetch depth to fetch to toString public String toString()(Code) Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)