Java Doc for FetchGroup.java in  » Testing » PolePosition-0.20 » com » versant » core » metadata » 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 » Testing » PolePosition 0.20 » com.versant.core.metadata 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.versant.core.metadata.FetchGroup

FetchGroup
final public class FetchGroup implements Serializable,Comparable(Code)
A group of fields from a class that are retrieved together. This holds the field and assorted store specific options.


Field Summary
final public static  StringALL_COLS_NAME
     This is the fetchGroup to load all columns in the class table.
final public static  StringDEL_NAME
     This is the name reserved for the fetch group containing all the direct references and dependent fields.
final public static  StringDEP_NAME
     This is the name reserved for the fetch group containing all the depedent reference and collection fields for delete reachability searching.
final public static  StringDETAIL_NAME
     This is the name reserved for the fetch group containing all the reference fields used to complete one-to-many relationships.
final public static  StringDFG_NAME
     This is the name reserved for the default fetch group.
final public static  StringDFG_NAME_NO_FAKES
     This is the name reserved for the default fetch group without fake fields.
final public static  FetchGroupField[]EMPTY_FETCHGROUP_FIELDS
    
final public static  int[]EMPTY_INT_ARRAY
    
final public static  StringMANY_TO_MANY_NAME
     This is the name reserved for the fetch group containing all the many-to-many fields that must be cleared when deleting an instance.
final public static  StringREF_NAME
     This is the name reserved for the fetch group containing all the reference and collection fields for reachability searching.
final public static  StringREQ_NAME
     This is the name reserved for the fetch group containing all the fields that must be filled in the original state (e.g.
final public static  StringRETRIEVE_NAME
     This is the fetchGroup to load all data.
public  ClassMetaDataclassMetaData
     The class this group belongs to.
public  FetchGroupFieldcrossJoinedCollectionField
     This is a fgf for a jdbc collection field that must be cross joined.
public  JdoExtensionextension
     The parsed meta data for this group (null if none i.e.
public  FetchGroupField[]fields
     The fields in this group in fieldNo order.
public  booleanhasPrimaryFields
    
public  intindex
     Our index in our classes fetchGroups array.
public  intjdbcTotalCols
     The total number of main table columns in the fetch group.
public  Stringname
     The name of this group.
public  booleansendFieldsOnFetch
     Send any available State data for the instance being fetched along with the fetch call.
public  int[]stateFieldNos
     The state field no's of the fetchGroup.
public transient  StoreFetchGroupstoreFetchGroup
     Extra store specific info attached to this fetch group.
public  FetchGroup[]subFetchGroups
     The sub fetch groups from our subclasses or null if none.
public  FetchGroupsuperFetchGroup
     The corresponding fetch group from our superclass or null if none.

Constructor Summary
public  FetchGroup(ClassMetaData classMetaData, String name, StoreFetchGroup sfg)
    

Method Summary
public  voidadd(FieldMetaData fmd)
     Add a field to this group.
public  booleancanUseParallelFetch()
     Can this fetch group make use of parallel fetching of collections and maps? This will recursively check fetch groups we reference and so on.
public  intcompareTo(Object o)
     Sort by name except for the default fetch group which is always first.
public  booleancontains(FieldMetaData fmd)
    
public  voiddump()
    
public  voiddump(PrintStream out, String indent)
    
public  voidfinish()
     Finish initialization of this fetch group.
public  intgetStateIndex()
     Get the state fetch group index of this group.
public  booleanhasPrimaryFields(boolean nonFake)
     Does this fetch group or any of its sub fetch groups contain any fields with primaryField true? This will search the heirachy i.e. it does not check the hasPrimaryFields flag.
public  booleanhasSecondaryFields()
    
public  booleanisRefFG()
    
public  FetchGroupresolve(OID oid, ModelMetaData jmd)
     Make sure this fetchGroup is for the available class of OID or one of its superclasses.
public  FetchGroupresolve(ClassMetaData availableCmd)
     Returns the most derived usable group i.e.
public  voidsetHasPrimaryFields(boolean on)
     Set the hasPrimaryFields flag on us and all of our sub fetch groups recursively.
public  voidsetSendFieldsOnFetch(boolean on)
     Set the sendFieldsOnFetch flag for us and all of our sub fetch groups recursively.
public  StringtoString()
    

Field Detail
ALL_COLS_NAME
final public static String ALL_COLS_NAME(Code)
This is the fetchGroup to load all columns in the class table.



DEL_NAME
final public static String DEL_NAME(Code)
This is the name reserved for the fetch group containing all the direct references and dependent fields. All instances in the delete graph must contain at least this group. This will always be a superset of the DEP_NAME group.
See Also:   FetchGroup.DEP_NAME



DEP_NAME
final public static String DEP_NAME(Code)
This is the name reserved for the fetch group containing all the depedent reference and collection fields for delete reachability searching.



DETAIL_NAME
final public static String DETAIL_NAME(Code)
This is the name reserved for the fetch group containing all the reference fields used to complete one-to-many relationships.



DFG_NAME
final public static String DFG_NAME(Code)
This is the name reserved for the default fetch group.



DFG_NAME_NO_FAKES
final public static String DFG_NAME_NO_FAKES(Code)
This is the name reserved for the default fetch group without fake fields.



EMPTY_FETCHGROUP_FIELDS
final public static FetchGroupField[] EMPTY_FETCHGROUP_FIELDS(Code)



EMPTY_INT_ARRAY
final public static int[] EMPTY_INT_ARRAY(Code)



MANY_TO_MANY_NAME
final public static String MANY_TO_MANY_NAME(Code)
This is the name reserved for the fetch group containing all the many-to-many fields that must be cleared when deleting an instance.
See Also:   ClassMetaData.managedManyToManyFetchGroup



REF_NAME
final public static String REF_NAME(Code)
This is the name reserved for the fetch group containing all the reference and collection fields for reachability searching.



REQ_NAME
final public static String REQ_NAME(Code)
This is the name reserved for the fetch group containing all the fields that must be filled in the original state (e.g. jdoVersion etc.) when persisting changes to instances.



RETRIEVE_NAME
final public static String RETRIEVE_NAME(Code)
This is the fetchGroup to load all data.



classMetaData
public ClassMetaData classMetaData(Code)
The class this group belongs to.



crossJoinedCollectionField
public FetchGroupField crossJoinedCollectionField(Code)
This is a fgf for a jdbc collection field that must be cross joined. Maps is not supported.



extension
public JdoExtension extension(Code)
The parsed meta data for this group (null if none i.e. automatically generated fetch group e.g. the default fetch group).



fields
public FetchGroupField[] fields(Code)
The fields in this group in fieldNo order.



hasPrimaryFields
public boolean hasPrimaryFields(Code)
Does this fetch group or any other fetch group in the heirachy contain any fields with primaryField true?



index
public int index(Code)
Our index in our classes fetchGroups array. This is -1 for dynamically created fetch groups as they are not in the fetchGroups array.
See Also:   ClassMetaData.fetchGroups



jdbcTotalCols
public int jdbcTotalCols(Code)
The total number of main table columns in the fetch group.



name
public String name(Code)
The name of this group.



sendFieldsOnFetch
public boolean sendFieldsOnFetch(Code)
Send any available State data for the instance being fetched along with the fetch call. This is used for fields that have some data stored with the instance itself and some data stored elsewhere e.g. collections on VDS.



stateFieldNos
public int[] stateFieldNos(Code)
The state field no's of the fetchGroup.



storeFetchGroup
public transient StoreFetchGroup storeFetchGroup(Code)
Extra store specific info attached to this fetch group.



subFetchGroups
public FetchGroup[] subFetchGroups(Code)
The sub fetch groups from our subclasses or null if none.



superFetchGroup
public FetchGroup superFetchGroup(Code)
The corresponding fetch group from our superclass or null if none.




Constructor Detail
FetchGroup
public FetchGroup(ClassMetaData classMetaData, String name, StoreFetchGroup sfg)(Code)




Method Detail
add
public void add(FieldMetaData fmd)(Code)
Add a field to this group. This is used to add fake fields created by stores to hold extra information (e.g. row version column values for the JDBC store).



canUseParallelFetch
public boolean canUseParallelFetch()(Code)
Can this fetch group make use of parallel fetching of collections and maps? This will recursively check fetch groups we reference and so on.



compareTo
public int compareTo(Object o)(Code)
Sort by name except for the default fetch group which is always first. Do not change this ordering.



contains
public boolean contains(FieldMetaData fmd)(Code)
Is the field part of this group?



dump
public void dump()(Code)



dump
public void dump(PrintStream out, String indent)(Code)



finish
public void finish()(Code)
Finish initialization of this fetch group.



getStateIndex
public int getStateIndex()(Code)
Get the state fetch group index of this group.
See Also:   State



hasPrimaryFields
public boolean hasPrimaryFields(boolean nonFake)(Code)
Does this fetch group or any of its sub fetch groups contain any fields with primaryField true? This will search the heirachy i.e. it does not check the hasPrimaryFields flag. If nonFake is true then only fields with fake == true are not considered.



hasSecondaryFields
public boolean hasSecondaryFields()(Code)
Does this fetch group or any of its sub fetch groups contain any fields with secondaryField true?



isRefFG
public boolean isRefFG()(Code)



resolve
public FetchGroup resolve(OID oid, ModelMetaData jmd)(Code)
Make sure this fetchGroup is for the available class of OID or one of its superclasses. Returns the most derived usable group i.e. if this method is called with a group for class Base and the available class from the OID is a subclass of base then the corresponding sub group will be returned.



resolve
public FetchGroup resolve(ClassMetaData availableCmd)(Code)
Returns the most derived usable group i.e. if this method is called with a group for class Base and availableCmd is a subclass of base then the corresponding sub group will be returned.



setHasPrimaryFields
public void setHasPrimaryFields(boolean on)(Code)
Set the hasPrimaryFields flag on us and all of our sub fetch groups recursively.



setSendFieldsOnFetch
public void setSendFieldsOnFetch(boolean on)(Code)
Set the sendFieldsOnFetch flag for us and all of our sub fetch groups recursively.



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)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.