Java Doc for JDOQuery.java in  » Database-ORM » JPOX » org » jpox » 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 » Database ORM » JPOX » org.jpox.jdo 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jpox.jdo.JDOQuery

JDOQuery
public class JDOQuery implements Query(Code)
Wrapper for JDO Query class. Stores the PM the query is exected against, the internal JPOX query, and the query language. The language is stored since it is referenced by the JDO API and so we dont have to embody knowledge of which internal query type is for which language (could be moved to the internal query).
version:
   $Revision: 1.4 $


Field Summary
 JDOFetchPlanfetchPlan
     JDO Fetch Plan.
 Stringlanguage
     Query language.
transient  PersistenceManagerpm
     PersistenceManager for the query.
 org.jpox.store.query.Queryquery
     Underlying query that will be executed by JPOX.

Constructor Summary
public  JDOQuery(PersistenceManager pm, org.jpox.store.query.Query query, String language)
     Constructor for a query used by JDO.

Method Summary
public  voidaddExtension(String key, Object value)
     Method to add an extension to the query.
public  voidaddSubquery(Query sub, String variableDecl, String candidateExpr)
     Add a subquery to this query.
public  voidaddSubquery(Query sub, String variableDecl, String candidateExpr, String parameter)
     Add a subquery to this query.
public  voidaddSubquery(Query sub, String variableDecl, String candidateExpr, String[] parameters)
     Add a subquery to this query.
public  voidaddSubquery(Query sub, String variableDecl, String candidateExpr, Map parameters)
     Add a subquery to this query.
public  voidclose(Object queryResult)
     Close the query result.
public  voidcloseAll()
     Close all query results for this query.
public  voidcompile()
     Compile the query.
public  voiddeclareImports(String imports)
     Declare any imports for the query.
public  voiddeclareParameters(String parameters)
     Declare any parameters for the query.
public  voiddeclareVariables(String variables)
     Declare any variables for the query.
public  longdeletePersistentAll()
     Execute the query deleting all instances found.
public  longdeletePersistentAll(Object[] parameters)
     Execute the query deleting all instances found.
public  longdeletePersistentAll(Map parameters)
     Execute the query deleting all instances found.
public  Objectexecute()
     Execute the query.
public  Objectexecute(Object p1)
     Execute the query.
public  Objectexecute(Object p1, Object p2)
     Execute the query.
public  Objectexecute(Object p1, Object p2, Object p3)
     Execute the query.
public  ObjectexecuteWithArray(Object[] parameterValues)
     Execute the query.
public  ObjectexecuteWithMap(Map parameters)
     Execute the query.
public  FetchPlangetFetchPlan()
     Accessor for the fetch plan to use.
public  booleangetIgnoreCache()
    
public  org.jpox.store.query.QuerygetInternalQuery()
     Accessor for the internal query.
public  StringgetLanguage()
     Accessor for the query language.
public  PersistenceManagergetPersistenceManager()
     Accessor for the PersistenceManager.
public  booleanisUnmodifiable()
     Accessor for whether the query is modifiable.
public  voidsetCandidates(Extent extent)
     Set the candidates for the query.
public  voidsetCandidates(Collection pcs)
     Set the candidates for the query.
public  voidsetClass(Class candidateClass)
     Set the candidate class for the query.
public  voidsetExtensions(Map extensions)
     Set the extensions for the query.
public  voidsetFilter(String filter)
     Set the filter for the query.
public  voidsetGrouping(String grouping)
     Set the grouping for the query.
public  voidsetIgnoreCache(boolean ignoreCache)
     Set the ignore cache setting for the query.
public  voidsetOrdering(String ordering)
     Set the ordering for the query.
public  voidsetRange(String range)
     Set the range for the query.
public  voidsetRange(long fromIncl, long toExcl)
     Set the range for the query.
public  voidsetResult(String result)
     Set the result for the query.
public  voidsetResultClass(Class result_cls)
     Set the result class for the query.
public  voidsetUnique(boolean unique)
     Set whether to expect a unique result.
public  voidsetUnmodifiable()
     Set the query to be unmodifiable.
public  StringtoString()
     Convenience method to return the query in string form.

Field Detail
fetchPlan
JDOFetchPlan fetchPlan(Code)
JDO Fetch Plan.



language
String language(Code)
Query language.



pm
transient PersistenceManager pm(Code)
PersistenceManager for the query.



query
org.jpox.store.query.Query query(Code)
Underlying query that will be executed by JPOX.




Constructor Detail
JDOQuery
public JDOQuery(PersistenceManager pm, org.jpox.store.query.Query query, String language)(Code)
Constructor for a query used by JDO.
Parameters:
  pm - PersistenceManager
Parameters:
  query - Underlying query
Parameters:
  language - Query language




Method Detail
addExtension
public void addExtension(String key, Object value)(Code)
Method to add an extension to the query.
Parameters:
  key - Key for the extension
Parameters:
  value - Value for the extension



addSubquery
public void addSubquery(Query sub, String variableDecl, String candidateExpr)(Code)
Add a subquery to this query.
Parameters:
  sub - the subquery to add to this Query
Parameters:
  variableDecl - the name of the variable in the outer query to bind the results of the subquery
Parameters:
  candidateExpr - the candidate collection of the subquery as an expression using terms of the outer query
since:
   1.2



addSubquery
public void addSubquery(Query sub, String variableDecl, String candidateExpr, String parameter)(Code)
Add a subquery to this query. The String version of the method binds the named expression to the parameter implictly or explicitly declared in the subquery.
Parameters:
  sub - the subquery to add to this Query
Parameters:
  variableDecl - the name of the variable to be used in this Query
Parameters:
  candidateExpr - the candidate collection to apply to the subquery
Parameters:
  parameter - the expression from the outer query to bind the parameter in the subquery
since:
   1.2



addSubquery
public void addSubquery(Query sub, String variableDecl, String candidateExpr, String[] parameters)(Code)
Add a subquery to this query. The String version of the method binds the named expression to the parameter implictly or explicitly declared in the subquery.
Parameters:
  sub - the subquery to add to this Query
Parameters:
  variableDecl - the name of the variable to be used in this Query
Parameters:
  candidateExpr - the candidate collection to apply to the subquery
Parameters:
  parameters - the expressions from the outer query to bind the parameter in the subquery
since:
   1.2



addSubquery
public void addSubquery(Query sub, String variableDecl, String candidateExpr, Map parameters)(Code)
Add a subquery to this query. The String version of the method binds the named expression to the parameter implictly or explicitly declared in the subquery.
Parameters:
  sub - the subquery to add to this Query
Parameters:
  variableDecl - the name of the variable to be used in this Query
Parameters:
  candidateExpr - the candidate collection to apply to the subquery
Parameters:
  parameters - the expressions from the outer query to bind the parameter in the subquery
since:
   1.2



close
public void close(Object queryResult)(Code)
Close the query result.
Parameters:
  queryResult - Query result



closeAll
public void closeAll()(Code)
Close all query results for this query.



compile
public void compile()(Code)
Compile the query.



declareImports
public void declareImports(String imports)(Code)
Declare any imports for the query.
Parameters:
  imports - The imports



declareParameters
public void declareParameters(String parameters)(Code)
Declare any parameters for the query.
Parameters:
  parameters - The parameters



declareVariables
public void declareVariables(String variables)(Code)
Declare any variables for the query.
Parameters:
  variables - The variables



deletePersistentAll
public long deletePersistentAll()(Code)
Execute the query deleting all instances found. Number of deleted instances



deletePersistentAll
public long deletePersistentAll(Object[] parameters)(Code)
Execute the query deleting all instances found.
Parameters:
  parameters - Parameters to use when executing Number of deleted instances



deletePersistentAll
public long deletePersistentAll(Map parameters)(Code)
Execute the query deleting all instances found.
Parameters:
  parameters - Parameters to use when executing Number of deleted instances



execute
public Object execute()(Code)
Execute the query. The results



execute
public Object execute(Object p1)(Code)
Execute the query.
Parameters:
  p1 - First param value The results



execute
public Object execute(Object p1, Object p2)(Code)
Execute the query.
Parameters:
  p1 - First param value
Parameters:
  p2 - Second param value The results



execute
public Object execute(Object p1, Object p2, Object p3)(Code)
Execute the query.
Parameters:
  p1 - First param value
Parameters:
  p2 - Second param value
Parameters:
  p3 - Third param value The results



executeWithArray
public Object executeWithArray(Object[] parameterValues)(Code)
Execute the query.
Parameters:
  parameterValues - Param values The results



executeWithMap
public Object executeWithMap(Map parameters)(Code)
Execute the query.
Parameters:
  parameters - Param values The results



getFetchPlan
public FetchPlan getFetchPlan()(Code)
Accessor for the fetch plan to use. The fetch plan



getIgnoreCache
public boolean getIgnoreCache()(Code)
Accessor for the ignore cache setting Ignore cache



getInternalQuery
public org.jpox.store.query.Query getInternalQuery()(Code)
Accessor for the internal query. Internal query



getLanguage
public String getLanguage()(Code)
Accessor for the query language. Query language



getPersistenceManager
public PersistenceManager getPersistenceManager()(Code)
Accessor for the PersistenceManager. PM



isUnmodifiable
public boolean isUnmodifiable()(Code)
Accessor for whether the query is modifiable. Whether it is modifiable



setCandidates
public void setCandidates(Extent extent)(Code)
Set the candidates for the query.
Parameters:
  extent - Extent defining the candidates



setCandidates
public void setCandidates(Collection pcs)(Code)
Set the candidates for the query.
Parameters:
  pcs - PC candidates



setClass
public void setClass(Class candidateClass)(Code)
Set the candidate class for the query.
Parameters:
  candidateClass - Candidate class



setExtensions
public void setExtensions(Map extensions)(Code)
Set the extensions for the query.
Parameters:
  extensions - The extensions



setFilter
public void setFilter(String filter)(Code)
Set the filter for the query.
Parameters:
  filter - The query filter



setGrouping
public void setGrouping(String grouping)(Code)
Set the grouping for the query.
Parameters:
  grouping - The grouping



setIgnoreCache
public void setIgnoreCache(boolean ignoreCache)(Code)
Set the ignore cache setting for the query.
Parameters:
  ignoreCache - The ignore cache setting



setOrdering
public void setOrdering(String ordering)(Code)
Set the ordering for the query.
Parameters:
  ordering - The ordering



setRange
public void setRange(String range)(Code)
Set the range for the query.
Parameters:
  range - The range specification



setRange
public void setRange(long fromIncl, long toExcl)(Code)
Set the range for the query.
Parameters:
  fromIncl - From range inclusive
Parameters:
  toExcl - To range exclusive



setResult
public void setResult(String result)(Code)
Set the result for the query.
Parameters:
  result - Result clause



setResultClass
public void setResultClass(Class result_cls)(Code)
Set the result class for the query.
Parameters:
  result_cls - Result class



setUnique
public void setUnique(boolean unique)(Code)
Set whether to expect a unique result.
Parameters:
  unique - Whether results are unique



setUnmodifiable
public void setUnmodifiable()(Code)
Set the query to be unmodifiable.



toString
public String toString()(Code)
Convenience method to return the query in string form. Stringifier method



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.