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


java.lang.Object
   com.versant.core.jdo.QueryDetails

QueryDetails
final public class QueryDetails implements Externalizable,ParamDeclarationParser.Handler(Code)
All the information required to compile a query.


Field Summary
final public static  intFALSE
    
final public static  intLANGUAGE_EJBQL
    
final public static  intLANGUAGE_JDOQL
    
final public static  intLANGUAGE_OQL
    
final public static  intLANGUAGE_SQL
    
final public static  intNOT_SET
    
final public static  intTRUE
    

Constructor Summary
public  QueryDetails()
    
public  QueryDetails(ClassMetaData cmd, JdoQuery q)
     Create from a query definition in the meta data.
public  QueryDetails(QueryDetails qParams)
    

Method Summary
public  voidclearExtentAndCol()
     Clear the extent and col variables.
public  voiddeclareParameters(String params)
    
public  voiddump()
    
public static  booleanenableParallelCollectionFetch(QueryDetails qp, FetchGroup fg)
     Take into acount 'parallelCollectionFetch', 'randomAccess' and 'fg.canUseParallelFetch' to determine if parallel collection fetch should happen.
public  booleanequals(Object o)
    
public  voidfillFrom(QueryDetails qd)
    
public  intgetCacheable()
     Return the cacheable tri-state (NOT_SET, FALSE, TRUE).
public  ClassgetCandidateClass()
    
public  CollectiongetCol()
    
public  int[]getExtraEvictClasses()
    
public  intgetFetchGroupIndex()
    
public  StringgetFilter()
    
public  StringgetGrouping()
    
public  StringgetImports()
    
public  intgetLanguage()
    
public  StringgetLanguageStr()
    
public  intgetMaxResultCount()
    
public  intgetOptionsParamIndex()
    
public  StringgetOrdering()
    
public  intgetParamCount()
     Get the number of parameters excluding the jdoGenieOptions parameter (if any).
public  String[]getParamNames()
     Get the parameter names or null if there are none.
public  String[]getParamTypes()
     Get the parameter types or null if there are none.
public  StringgetParameters()
     Get a comma list of all the parameters or null if none.
public  StringgetResult()
    
public  intgetResultBatchSize()
    
public  intgetTotalParamCount()
     Get the total number of parameters including the jdoGenieOptions parameter (if any).
public  intgetUnique()
    
public  StringgetVariables()
    
public  booleanhasJdoGenieOptions()
    
public  inthashCode()
    
public  booleanincludeSubClasses()
    
public  booleanisBounded()
    
public  booleanisCountOnSize()
    
public  booleanisIgnoreCache()
    
public  booleanisRandomAccess()
    
public  booleanisUseIgnoreCacheFromPM()
     If true then any query created from these params should set its ignoreCache flag to the current setting for the PM.
public  voidparameterParsed(int index, String type, String name)
    
public  booleanprefetchAll()
     This will return true if the maxResults is smaller of equal to the batch size.
public  voidreadExternal(ObjectInput s)
    
public  voidsetBounded(boolean value)
    
public  voidsetCacheable(boolean on)
    
public  voidsetCandidateClass(Class candidateClass)
    
public  voidsetCol(Collection col)
    
public  voidsetCountOnSize(boolean countOnSize)
    
public  voidsetExtent(Extent extent)
    
public  voidsetExtraEvictClasses(int[] extraEvictClasses)
    
public  voidsetFetchGroupIndex(int fetchGroupIndex)
    
public  voidsetFilter(String filter)
    
public  voidsetGrouping(String grouping)
    
public  voidsetIgnoreCache(boolean ignoreCache)
    
public  voidsetImports(String imports)
    
public  voidsetLanguage(int language)
    
public  voidsetMaxResultCount(int value)
     Set the max results returned for this query.
public  voidsetOptionsParamIndex(int optionsParamIndex)
    
public  voidsetOrdering(String ordering)
    
public  voidsetRandomAccess(boolean randomAccess)
    
public  voidsetResult(String result)
    
public  voidsetResultBatchSize(int value)
    
public  voidsetSubClasses(boolean subClasses)
    
public  voidsetUnique(boolean unique)
    
public  voidsetVariables(String variables)
    
public  voidupdateCounts()
     This is called just before the query is executed.
public  voidwriteExternal(ObjectOutput s)
    

Field Detail
FALSE
final public static int FALSE(Code)



LANGUAGE_EJBQL
final public static int LANGUAGE_EJBQL(Code)



LANGUAGE_JDOQL
final public static int LANGUAGE_JDOQL(Code)



LANGUAGE_OQL
final public static int LANGUAGE_OQL(Code)



LANGUAGE_SQL
final public static int LANGUAGE_SQL(Code)



NOT_SET
final public static int NOT_SET(Code)



TRUE
final public static int TRUE(Code)




Constructor Detail
QueryDetails
public QueryDetails()(Code)



QueryDetails
public QueryDetails(ClassMetaData cmd, JdoQuery q)(Code)
Create from a query definition in the meta data.



QueryDetails
public QueryDetails(QueryDetails qParams)(Code)




Method Detail
clearExtentAndCol
public void clearExtentAndCol()(Code)
Clear the extent and col variables.



declareParameters
public void declareParameters(String params)(Code)



dump
public void dump()(Code)



enableParallelCollectionFetch
public static boolean enableParallelCollectionFetch(QueryDetails qp, FetchGroup fg)(Code)
Take into acount 'parallelCollectionFetch', 'randomAccess' and 'fg.canUseParallelFetch' to determine if parallel collection fetch should happen.



equals
public boolean equals(Object o)(Code)



fillFrom
public void fillFrom(QueryDetails qd)(Code)



getCacheable
public int getCacheable()(Code)
Return the cacheable tri-state (NOT_SET, FALSE, TRUE).



getCandidateClass
public Class getCandidateClass()(Code)



getCol
public Collection getCol()(Code)



getExtraEvictClasses
public int[] getExtraEvictClasses()(Code)



getFetchGroupIndex
public int getFetchGroupIndex()(Code)



getFilter
public String getFilter()(Code)



getGrouping
public String getGrouping()(Code)



getImports
public String getImports()(Code)



getLanguage
public int getLanguage()(Code)



getLanguageStr
public String getLanguageStr()(Code)



getMaxResultCount
public int getMaxResultCount()(Code)



getOptionsParamIndex
public int getOptionsParamIndex()(Code)



getOrdering
public String getOrdering()(Code)



getParamCount
public int getParamCount()(Code)
Get the number of parameters excluding the jdoGenieOptions parameter (if any). This returns -1 if the number of parameters is not known e.g. EJBQL query or single string JDOQL query.



getParamNames
public String[] getParamNames()(Code)
Get the parameter names or null if there are none. The length of this array may exceed getParamCount(). This array does not contain the jdoGenieOptions parameter (if any).



getParamTypes
public String[] getParamTypes()(Code)
Get the parameter types or null if there are none. The length of this array may exceed getParamCount(). This array does not contain the jdoGenieOptions parameter (if any).



getParameters
public String getParameters()(Code)
Get a comma list of all the parameters or null if none. This is a tempory fix until the code that uses this can be refactored to use the already parsed types and names.



getResult
public String getResult()(Code)



getResultBatchSize
public int getResultBatchSize()(Code)



getTotalParamCount
public int getTotalParamCount()(Code)
Get the total number of parameters including the jdoGenieOptions parameter (if any). This returns -1 if the number of parameters is not known e.g. EJBQL query or single string JDOQL query.



getUnique
public int getUnique()(Code)



getVariables
public String getVariables()(Code)



hasJdoGenieOptions
public boolean hasJdoGenieOptions()(Code)



hashCode
public int hashCode()(Code)



includeSubClasses
public boolean includeSubClasses()(Code)



isBounded
public boolean isBounded()(Code)



isCountOnSize
public boolean isCountOnSize()(Code)



isIgnoreCache
public boolean isIgnoreCache()(Code)



isRandomAccess
public boolean isRandomAccess()(Code)



isUseIgnoreCacheFromPM
public boolean isUseIgnoreCacheFromPM()(Code)
If true then any query created from these params should set its ignoreCache flag to the current setting for the PM.



parameterParsed
public void parameterParsed(int index, String type, String name)(Code)



prefetchAll
public boolean prefetchAll()(Code)
This will return true if the maxResults is smaller of equal to the batch size.

This method is used to determine if all the results can be fetched at once.




readExternal
public void readExternal(ObjectInput s) throws IOException, ClassNotFoundException(Code)



setBounded
public void setBounded(boolean value)(Code)



setCacheable
public void setCacheable(boolean on)(Code)



setCandidateClass
public void setCandidateClass(Class candidateClass)(Code)



setCol
public void setCol(Collection col)(Code)



setCountOnSize
public void setCountOnSize(boolean countOnSize)(Code)



setExtent
public void setExtent(Extent extent)(Code)



setExtraEvictClasses
public void setExtraEvictClasses(int[] extraEvictClasses)(Code)



setFetchGroupIndex
public void setFetchGroupIndex(int fetchGroupIndex)(Code)



setFilter
public void setFilter(String filter)(Code)



setGrouping
public void setGrouping(String grouping)(Code)



setIgnoreCache
public void setIgnoreCache(boolean ignoreCache)(Code)



setImports
public void setImports(String imports)(Code)



setLanguage
public void setLanguage(int language)(Code)



setMaxResultCount
public void setMaxResultCount(int value)(Code)
Set the max results returned for this query. Setting it to zero is the same as unsetting it(no limit).
Parameters:
  value -



setOptionsParamIndex
public void setOptionsParamIndex(int optionsParamIndex)(Code)



setOrdering
public void setOrdering(String ordering)(Code)



setRandomAccess
public void setRandomAccess(boolean randomAccess)(Code)



setResult
public void setResult(String result)(Code)



setResultBatchSize
public void setResultBatchSize(int value)(Code)



setSubClasses
public void setSubClasses(boolean subClasses)(Code)



setUnique
public void setUnique(boolean unique)(Code)



setVariables
public void setVariables(String variables)(Code)



updateCounts
public void updateCounts()(Code)
This is called just before the query is executed. It updates the batch and max result counts.



writeExternal
public void writeExternal(ObjectOutput s) throws IOException(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.