Java Doc for InterfaceManager.java in  » Database-ORM » XORM » org » xorm » 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 » XORM » org.xorm 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.xorm.InterfaceManager

InterfaceManager
class InterfaceManager implements PersistenceManager,I15d(Code)
Roughly equivalent to JDO PersistenceManager. Developers should always acquire an InterfaceManager as a javax.jdo.PersistenceManager. The implementation details are transparent to the use of the API. To use additional XORM features, the org.xorm.XORM static methods are provided.



Constructor Summary
 InterfaceManager(InterfaceManagerFactory factory, Options jdoOptions)
     Creates a new InterfaceManager.

Method Summary
 voidaddToCache(Row row)
    
 voidaddToCache(Collection rows)
    
public synchronized  voidclose()
     Marks this InterfaceManager as closed.
public  TransactioncurrentTransaction()
     Returns the transaction associated with this InterfaceManager.
public  voiddeletePersistent(Object object)
    
public  voiddeletePersistentAll(Collection collection)
    
public  voiddeletePersistentAll(Object[] array)
    
public  voidevict(Object object)
     This operation is not currently supported.
public  voidevictAll(Object[] array)
     This operation is not currently supported.
public  voidevictAll(Collection collection)
     This operation is not currently supported.
public  voidevictAll()
     This operation is not currently supported.
 intexecuteSizeQuery(Selector selector)
    
public  voidfinalize()
     When an InterfaceManager is garbage collected, ensure that any active transactions are closed.
public  ExtentgetExtent(Class clazz, boolean subclasses)
     Returns the Extent of the given class.
 RowgetFromCache(Table table, Object primaryKey)
    
public  booleangetIgnoreCache()
     Returns the value of the ignoreCache flag.
 InterfaceManagerFactorygetInterfaceManagerFactory()
    
public  booleangetMultithreaded()
     Returns the value of the multithreaded flag, which XORM blithely ignores.
public  ObjectgetObjectById(Object object, boolean validate)
    
public  ObjectgetObjectId(Object object)
     Attempts to identify the primaryKey for the object.
public  ClassgetObjectIdClass(Class clazz)
     If the class parameter is not mapped in a *.jdo file, returns null.
 ObjectStategetObjectState(Object object)
     The incoming object may be an instance of either a reference-enhanced JDO class or a dynamically enhanced cglib-generated class.
public  PersistenceManagerFactorygetPersistenceManagerFactory()
    
public  ObjectgetTransactionalObjectId(Object object)
     At present, this is the same as getObjectId().
public  ObjectgetUserObject()
     Retrieves the user-associated object.
public  booleanisClosed()
     Returns true if this manager object has been closed.
 Objectlookup(Class clazz, Object primaryKey)
     Retrieves an object from the cache or from persistent storage that is of the given type and has the matching object ID.
 Objectlookup(ClassMapping classMapping, Object primaryKey)
     This is the primary method by which an object is acquired.
 RowlookupRow(ClassMapping classMapping, Object primaryKey)
     Retrieve a datastore row given its primary key. This method first checks the local cache, then calls DatastoreDriver.read().
public  voidmakeNontransactional(Object object)
    
public  voidmakeNontransactionalAll(Collection collection)
    
public  voidmakeNontransactionalAll(Object[] array)
    
public  voidmakePersistent(Object object)
     Marks an object as persistent so it may be saved to the datastore.
public  voidmakePersistentAll(Collection collection)
     Marks all items within a collection of objects as persistent.
public  voidmakePersistentAll(Object[] array)
     Marks all items within an array of objects as persistent.
public  voidmakeTransactional(Object object)
    
public  voidmakeTransactionalAll(Collection collection)
    
public  voidmakeTransactionalAll(Object[] array)
    
public  voidmakeTransient(Object object)
    
public  voidmakeTransientAll(Collection collection)
    
public  voidmakeTransientAll(Object[] array)
    
public  ObjectnewObjectIdInstance(Class clazz, String arg)
     Returns a new objectId corresponding to the given class and String parameter.
public  QuerynewQuery(Class clazz, String filter)
     Returns a query built using JDOQL.
public  QuerynewQuery(Class clazz)
     Returns a query for the specified class.
public  QuerynewQuery(Extent extent)
     Returns a query for the specified extent.
public  QuerynewQuery(Extent extent, String filter)
     Returns a query for the specified extent.
public  QuerynewQuery()
     Creates a new query that the user must set values on using the Query interface.
public  QuerynewQuery(Object compiled)
     Constructs a query by copying data from a previous query.
public  QuerynewQuery(String language, Object query)
     Known languages are "javax.jdo.query.JDOQL" (which takes a String), "org.xorm.query.CodeQuery" (use CodeQuery.LANGUAGE), and QueryLanguage.LANGUAGE.
public  QuerynewQuery(Class clazz, Collection extent)
     This operation is not currently supported.
public  QuerynewQuery(Class clazz, Collection extent, String filter)
     This operation is not currently supported.
public  voidrefresh(Object object)
     Reloads the fields of the object from the datastore.
public  voidrefreshAll(Object[] array)
     Calls refresh() on all objects in the array.
public  voidrefreshAll(Collection collection)
     Calls refresh() on all objects in the collection.
public  voidrefreshAll()
     Refreshes all objects in the transaction.
 voidrefreshColumns(Row row, DataFetchGroup dfg)
     Refreshes particular fields of a Row from the datastore.
 voidremoveFromCache(Row row)
    
public  voidretrieve(Object object)
     This operation is not currently supported.
public  voidretrieveAll(Collection collection)
     This operation is not currently supported.
public  voidretrieveAll(Collection collection, boolean dfgOnly)
     This operation is not currently supported.
public  voidretrieveAll(Object[] array)
     This operation is not currently supported.
public  voidretrieveAll(Object[] array, boolean dfgOnly)
     This operation is not currently supported.
 CollectionselectRows(Selector selector)
     Selects the rows from the datastore matching the selection criteria. If no transaction is in progress, but nontransactionalRead is enabled, begins and ends a datastore transaction in order to perform the query.
public  voidsetIgnoreCache(boolean ignoreCache)
     Sets the value of the ignoreCache flag.
public  voidsetMultithreaded(boolean multithreaded)
     Indicates that this PersistenceManager will be used in a multithreaded context.
public  voidsetUserObject(Object userObject)
     Allows the user to associate an arbitrary object with this InterfaceManager.


Constructor Detail
InterfaceManager
InterfaceManager(InterfaceManagerFactory factory, Options jdoOptions)(Code)
Creates a new InterfaceManager. This method is called from the InterfaceManagerFactory.




Method Detail
addToCache
void addToCache(Row row)(Code)



addToCache
void addToCache(Collection rows)(Code)



close
public synchronized void close()(Code)
Marks this InterfaceManager as closed. Closing an InterfaceManager ensures that any datastore resources being used will be disconnected. After a call to close(), all methods of the PersistenceManager interface (with the exception of isClosed()) will throw JDOFatalUserException. Calling close() while a Transaction is active will throw a JDOUserException.



currentTransaction
public Transaction currentTransaction()(Code)
Returns the transaction associated with this InterfaceManager. Merely retrieving the transaction does not change its state; you must call begin(), commit(), etc.



deletePersistent
public void deletePersistent(Object object)(Code)



deletePersistentAll
public void deletePersistentAll(Collection collection)(Code)



deletePersistentAll
public void deletePersistentAll(Object[] array)(Code)



evict
public void evict(Object object)(Code)
This operation is not currently supported.



evictAll
public void evictAll(Object[] array)(Code)
This operation is not currently supported.



evictAll
public void evictAll(Collection collection)(Code)
This operation is not currently supported.



evictAll
public void evictAll()(Code)
This operation is not currently supported.



executeSizeQuery
int executeSizeQuery(Selector selector)(Code)



finalize
public void finalize()(Code)
When an InterfaceManager is garbage collected, ensure that any active transactions are closed.



getExtent
public Extent getExtent(Class clazz, boolean subclasses)(Code)
Returns the Extent of the given class. Subclasses are not supported yet.



getFromCache
Row getFromCache(Table table, Object primaryKey)(Code)



getIgnoreCache
public boolean getIgnoreCache()(Code)
Returns the value of the ignoreCache flag. Not that it will do you much good.



getInterfaceManagerFactory
InterfaceManagerFactory getInterfaceManagerFactory()(Code)



getMultithreaded
public boolean getMultithreaded()(Code)
Returns the value of the multithreaded flag, which XORM blithely ignores.



getObjectById
public Object getObjectById(Object object, boolean validate)(Code)



getObjectId
public Object getObjectId(Object object)(Code)
Attempts to identify the primaryKey for the object. Returns null if the object is not PersistenceCapable.



getObjectIdClass
public Class getObjectIdClass(Class clazz)(Code)
If the class parameter is not mapped in a *.jdo file, returns null. Otherwise returns org.xorm.ObjectId.class.



getObjectState
ObjectState getObjectState(Object object)(Code)
The incoming object may be an instance of either a reference-enhanced JDO class or a dynamically enhanced cglib-generated class.



getPersistenceManagerFactory
public PersistenceManagerFactory getPersistenceManagerFactory()(Code)



getTransactionalObjectId
public Object getTransactionalObjectId(Object object)(Code)
At present, this is the same as getObjectId(). Changing an ObjectId is not supported.



getUserObject
public Object getUserObject()(Code)
Retrieves the user-associated object.



isClosed
public boolean isClosed()(Code)
Returns true if this manager object has been closed.



lookup
Object lookup(Class clazz, Object primaryKey)(Code)
Retrieves an object from the cache or from persistent storage that is of the given type and has the matching object ID. Called from getObjectById and from RelationshipProxy.iterator()



lookup
Object lookup(ClassMapping classMapping, Object primaryKey)(Code)
This is the primary method by which an object is acquired. This method may return a hollow object that has not been validated. Called from lookup(Class, Object) and from InterfaceInvocationHandler .invokeGet().



lookupRow
Row lookupRow(ClassMapping classMapping, Object primaryKey)(Code)
Retrieve a datastore row given its primary key. This method first checks the local cache, then calls DatastoreDriver.read(). If no matching row is found, JDOObjectNotFoundException is thrown. Called from lookup() and from InterfaceInvocationHandler.refresh().



makeNontransactional
public void makeNontransactional(Object object)(Code)



makeNontransactionalAll
public void makeNontransactionalAll(Collection collection)(Code)



makeNontransactionalAll
public void makeNontransactionalAll(Object[] array)(Code)



makePersistent
public void makePersistent(Object object)(Code)
Marks an object as persistent so it may be saved to the datastore.



makePersistentAll
public void makePersistentAll(Collection collection)(Code)
Marks all items within a collection of objects as persistent.



makePersistentAll
public void makePersistentAll(Object[] array)(Code)
Marks all items within an array of objects as persistent.



makeTransactional
public void makeTransactional(Object object)(Code)



makeTransactionalAll
public void makeTransactionalAll(Collection collection)(Code)



makeTransactionalAll
public void makeTransactionalAll(Object[] array)(Code)



makeTransient
public void makeTransient(Object object)(Code)



makeTransientAll
public void makeTransientAll(Collection collection)(Code)



makeTransientAll
public void makeTransientAll(Object[] array)(Code)



newObjectIdInstance
public Object newObjectIdInstance(Class clazz, String arg)(Code)
Returns a new objectId corresponding to the given class and String parameter.



newQuery
public Query newQuery(Class clazz, String filter)(Code)
Returns a query built using JDOQL.



newQuery
public Query newQuery(Class clazz)(Code)
Returns a query for the specified class. Without user modification, when executed, returns all instances of the class.



newQuery
public Query newQuery(Extent extent)(Code)
Returns a query for the specified extent. Without user modification, when executed, returns all instances of the class. Note that XORM does not support subclasses at this time.



newQuery
public Query newQuery(Extent extent, String filter)(Code)
Returns a query for the specified extent. Without user modification, when executed, returns all instances of the class that match the query filter (JDOQL expression). Note that XORM does not support subclasses at this time.



newQuery
public Query newQuery()(Code)
Creates a new query that the user must set values on using the Query interface.



newQuery
public Query newQuery(Object compiled)(Code)
Constructs a query by copying data from a previous query.



newQuery
public Query newQuery(String language, Object query)(Code)
Known languages are "javax.jdo.query.JDOQL" (which takes a String), "org.xorm.query.CodeQuery" (use CodeQuery.LANGUAGE), and QueryLanguage.LANGUAGE.



newQuery
public Query newQuery(Class clazz, Collection extent)(Code)
This operation is not currently supported.



newQuery
public Query newQuery(Class clazz, Collection extent, String filter)(Code)
This operation is not currently supported.



refresh
public void refresh(Object object)(Code)
Reloads the fields of the object from the datastore.



refreshAll
public void refreshAll(Object[] array)(Code)
Calls refresh() on all objects in the array.



refreshAll
public void refreshAll(Collection collection)(Code)
Calls refresh() on all objects in the collection.



refreshAll
public void refreshAll()(Code)
Refreshes all objects in the transaction.



refreshColumns
void refreshColumns(Row row, DataFetchGroup dfg)(Code)
Refreshes particular fields of a Row from the datastore. This method does not affect the cache.



removeFromCache
void removeFromCache(Row row)(Code)



retrieve
public void retrieve(Object object)(Code)
This operation is not currently supported.



retrieveAll
public void retrieveAll(Collection collection)(Code)
This operation is not currently supported.



retrieveAll
public void retrieveAll(Collection collection, boolean dfgOnly)(Code)
This operation is not currently supported.



retrieveAll
public void retrieveAll(Object[] array)(Code)
This operation is not currently supported.



retrieveAll
public void retrieveAll(Object[] array, boolean dfgOnly)(Code)
This operation is not currently supported.



selectRows
Collection selectRows(Selector selector)(Code)
Selects the rows from the datastore matching the selection criteria. If no transaction is in progress, but nontransactionalRead is enabled, begins and ends a datastore transaction in order to perform the query. Before returning the collection of rows, this method adds the query results and any extra rows read by the driver to the cache.



setIgnoreCache
public void setIgnoreCache(boolean ignoreCache)(Code)
Sets the value of the ignoreCache flag. Currently this suggestion is given little attention.



setMultithreaded
public void setMultithreaded(boolean multithreaded)(Code)
Indicates that this PersistenceManager will be used in a multithreaded context. Currently this flag is not being used.



setUserObject
public void setUserObject(Object userObject)(Code)
Allows the user to associate an arbitrary object with this InterfaceManager.



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.