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


org.jpox.api.ApiAdapter

All known Subclasses:   org.jpox.jdo.JDOAdapter,
ApiAdapter
public interface ApiAdapter (Code)
Adapter to allow the JPOX core runtime to expose multiple APIs to clients.
version:
   $Revision: 1.24 $




Method Summary
 booleanallowDeleteOfNonPersistentObject()
     Whether the API allows deletion of a non-persistent object.
 booleanallowPersistOfDeletedObject()
     Whether the API allows (re-)persistence of a deleted object.
 booleanallowReadFieldOfDeletedObject()
     Whether the API allows reading a field of a deleted object.
 booleanclearLoadedFlagsOnDeleteObject()
     Whether the API requires clearing of the fields of an object when it is deleted.
 booleangetDefaultCascadeDeleteForField()
    
 booleangetDefaultCascadePersistForField()
    
 booleangetDefaultCascadeRefreshForField()
    
 booleangetDefaultCascadeUpdateForField()
    
 MapgetDefaultFactoryProperties()
    
 ObjectgetIdForObject(Object obj)
     Method to return the object identity for the passed persistable object.
 ClassgetKeyTypeForSingleFieldIdentityType(Class idType)
     Accessor for the type of the single field application-identity key given the single field identity type.
 LifeCycleStategetLifeCycleState(int stateType)
     Returns the LifeCycleState for the state constant.
 ObjectgetNewApplicationIdentityObjectId(Object pc, AbstractClassMetaData cmd)
     Method to create a new object identity for the passed object with the supplied MetaData.
 ObjectgetNewApplicationIdentityObjectId(Class cls, Object key)
     Method to return a new object identity for the specified class, and key (possibly toString() output).
 ObjectgetNewSingleFieldIdentity(Class idType, Class pcType, Object value)
     Utility to create a new SingleFieldIdentity using reflection when you know the type of the PersistenceCapable, and also which SingleFieldIdentity, and the value of the key.
Parameters:
  idType - Type of SingleFieldIdentity
Parameters:
  pcType - Type of the PersistenceCapable
Parameters:
  value - The value for the identity (the Long, or Int, or ...
 ObjectgetObjectId(StateManager sm)
     Accessor for the object id from the StateManager for this object.
 StringgetObjectState(Object obj)
     Accessor for the object state.
 ObjectgetPersistenceManager(Object obj)
     Accessor for the persistence manager for this object.
 StringgetSingleFieldIdentityClassNameForByte()
     Accessor for the class name to use for identities when there is a single Byte/byte field.
 StringgetSingleFieldIdentityClassNameForChar()
     Accessor for the class name to use for identities when there is a single Character/char field.
 StringgetSingleFieldIdentityClassNameForInt()
     Accessor for the class name to use for identities when there is a single Integer/int field.
 StringgetSingleFieldIdentityClassNameForLong()
     Accessor for the class name to use for identities when there is a single Long/long field.
 StringgetSingleFieldIdentityClassNameForObject()
     Accessor for the class name to use for identities when there is a single Object field.
 StringgetSingleFieldIdentityClassNameForShort()
     Accessor for the class name to use for identities when there is a single Short/short field.
 StringgetSingleFieldIdentityClassNameForString()
     Accessor for the class name to use for identities when there is a single String field.
 ClassgetTargetClassForSingleFieldIdentity(Object id)
     Accessor for the target class for the specified single field identity.
 StringgetTargetClassNameForSingleFieldIdentity(Object id)
     Accessor for the target class name for the specified single field identity.
 ObjectgetTargetKeyForSingleFieldIdentity(Object id)
     Accessor for the key object for the specified single field identity.
 ObjectgetVersion(StateManager sm)
     Accessor for the version from the StateManager for this object.
 ObjectgetVersionForObject(Object obj)
     Method to return the object version for the passed persistable object.
 booleanisDeleted(Object obj)
     Accessor for whether the passed object is deleted.
 booleanisDetachable(Object obj)
     Method to return if the passed object is detachable using this API.
 booleanisDetached(Object obj)
     Accessor for whether the passed object is detached.
 booleanisDirty(Object obj)
     Accessor for whether the passed object is dirty.
 booleanisLoaded(StateManager sm, int fieldNumber)
    
 booleanisNew(Object obj)
     Accessor for whether the passed object is new.
 booleanisPersistable(Object obj)
     Method to return if the passed object is persistable using this API.
 booleanisPersistable(Class cls)
     Utility method to check if the specified class is of a type that can be persisted for this API.
 booleanisPersistent(Object obj)
     Accessor for whether the passed object is persistent.
 booleanisSingleFieldIdentity(Object id)
     Accessor for whether the passed identity is a valid single-field application-identity for this API.
 booleanisSingleFieldIdentityClass(String className)
     Accessor for whether the passed class name is a valid single-field application-identity for this API.
 booleanisTransactional(Object obj)
     Accessor for whether the passed object is transactional.
 booleanisValidPrimaryKeyClass(Class pkClass, AbstractClassMetaData cmd, ClassLoaderResolver clr, int noOfPkFields)
     Utility to check if a primary-key class is valid.
 voidmakeFieldDirty(Object obj, String fieldName)
     Method to make the field dirty in the object.
 StateManagernewStateManager(ObjectManager om, AbstractClassMetaData acmd)
     Method to create a new StateManager for the ObjectManager and class.



Method Detail
allowDeleteOfNonPersistentObject
boolean allowDeleteOfNonPersistentObject()(Code)
Whether the API allows deletion of a non-persistent object. Whether you can call delete on an object not yet persisted



allowPersistOfDeletedObject
boolean allowPersistOfDeletedObject()(Code)
Whether the API allows (re-)persistence of a deleted object. Whether you can call persist on a deleted object



allowReadFieldOfDeletedObject
boolean allowReadFieldOfDeletedObject()(Code)
Whether the API allows reading a field of a deleted object. Whether you can read after deleting



clearLoadedFlagsOnDeleteObject
boolean clearLoadedFlagsOnDeleteObject()(Code)
Whether the API requires clearing of the fields of an object when it is deleted. Whether to clear loaded fields at delete



getDefaultCascadeDeleteForField
boolean getDefaultCascadeDeleteForField()(Code)
Method to return the default setting for cascading delete of a field default cascade delete setting.



getDefaultCascadePersistForField
boolean getDefaultCascadePersistForField()(Code)
Method to return the default setting for cascading persist of a field default persist cascade setting.



getDefaultCascadeRefreshForField
boolean getDefaultCascadeRefreshForField()(Code)
Method to return the default setting for cascading refresh of a field default cascade refresh setting.



getDefaultCascadeUpdateForField
boolean getDefaultCascadeUpdateForField()(Code)
Method to return the default setting for cascading update of a field default cascade update setting.



getDefaultFactoryProperties
Map getDefaultFactoryProperties()(Code)
Method to return a set of default properties for the factory (PMF, EMF, etc) The default properties (if any) for this API



getIdForObject
Object getIdForObject(Object obj)(Code)
Method to return the object identity for the passed persistable object. Returns null if it is not persistable, or has no identity.
Parameters:
  obj - The object The identity



getKeyTypeForSingleFieldIdentityType
Class getKeyTypeForSingleFieldIdentityType(Class idType)(Code)
Accessor for the type of the single field application-identity key given the single field identity type.
Parameters:
  idType - Single field identity type key type



getLifeCycleState
LifeCycleState getLifeCycleState(int stateType)(Code)
Returns the LifeCycleState for the state constant.
Parameters:
  stateType - the type as integer the type as LifeCycleState object



getNewApplicationIdentityObjectId
Object getNewApplicationIdentityObjectId(Object pc, AbstractClassMetaData cmd)(Code)
Method to create a new object identity for the passed object with the supplied MetaData. Only applies to application-identity cases.
Parameters:
  pc - The persistable object
Parameters:
  cmd - Its metadata The new identity object



getNewApplicationIdentityObjectId
Object getNewApplicationIdentityObjectId(Class cls, Object key)(Code)
Method to return a new object identity for the specified class, and key (possibly toString() output).
Parameters:
  cls - Persistable class
Parameters:
  key - form of the object id The object identity



getNewSingleFieldIdentity
Object getNewSingleFieldIdentity(Class idType, Class pcType, Object value)(Code)
Utility to create a new SingleFieldIdentity using reflection when you know the type of the PersistenceCapable, and also which SingleFieldIdentity, and the value of the key.
Parameters:
  idType - Type of SingleFieldIdentity
Parameters:
  pcType - Type of the PersistenceCapable
Parameters:
  value - The value for the identity (the Long, or Int, or ... etc). The single field identity
throws:
  JPOXException - if invalid input is received



getObjectId
Object getObjectId(StateManager sm)(Code)
Accessor for the object id from the StateManager for this object.
Parameters:
  sm - StateManager object id



getObjectState
String getObjectState(Object obj)(Code)
Accessor for the object state.
Parameters:
  obj - Object The state ("persistent-clean", "detached-dirty" etc)



getPersistenceManager
Object getPersistenceManager(Object obj)(Code)
Accessor for the persistence manager for this object. The returned object will be a JDO PersistenceManager (if using JDO), or an EntityManager (if using JPA), or null if not managed.
Parameters:
  obj - The object The persistence manager



getSingleFieldIdentityClassNameForByte
String getSingleFieldIdentityClassNameForByte()(Code)
Accessor for the class name to use for identities when there is a single Byte/byte field. Class name of identity class



getSingleFieldIdentityClassNameForChar
String getSingleFieldIdentityClassNameForChar()(Code)
Accessor for the class name to use for identities when there is a single Character/char field. Class name of identity class



getSingleFieldIdentityClassNameForInt
String getSingleFieldIdentityClassNameForInt()(Code)
Accessor for the class name to use for identities when there is a single Integer/int field. Class name of identity class



getSingleFieldIdentityClassNameForLong
String getSingleFieldIdentityClassNameForLong()(Code)
Accessor for the class name to use for identities when there is a single Long/long field. Class name of identity class



getSingleFieldIdentityClassNameForObject
String getSingleFieldIdentityClassNameForObject()(Code)
Accessor for the class name to use for identities when there is a single Object field. Class name of identity class



getSingleFieldIdentityClassNameForShort
String getSingleFieldIdentityClassNameForShort()(Code)
Accessor for the class name to use for identities when there is a single Short/short field. Class name of identity class



getSingleFieldIdentityClassNameForString
String getSingleFieldIdentityClassNameForString()(Code)
Accessor for the class name to use for identities when there is a single String field. Class name of identity class



getTargetClassForSingleFieldIdentity
Class getTargetClassForSingleFieldIdentity(Object id)(Code)
Accessor for the target class for the specified single field identity.
Parameters:
  id - The identity The target class



getTargetClassNameForSingleFieldIdentity
String getTargetClassNameForSingleFieldIdentity(Object id)(Code)
Accessor for the target class name for the specified single field identity.
Parameters:
  id - The identity The target class name



getTargetKeyForSingleFieldIdentity
Object getTargetKeyForSingleFieldIdentity(Object id)(Code)
Accessor for the key object for the specified single field identity.
Parameters:
  id - The identity The key object



getVersion
Object getVersion(StateManager sm)(Code)
Accessor for the version from the StateManager for this object.
Parameters:
  sm - StateManager



getVersionForObject
Object getVersionForObject(Object obj)(Code)
Method to return the object version for the passed persistable object. Returns null if it is not persistable, or not versioned.
Parameters:
  obj - The object The version



isDeleted
boolean isDeleted(Object obj)(Code)
Accessor for whether the passed object is deleted.
Parameters:
  obj - The object Whether it is deleted



isDetachable
boolean isDetachable(Object obj)(Code)
Method to return if the passed object is detachable using this API.
Parameters:
  obj - The object Whether it is detachable



isDetached
boolean isDetached(Object obj)(Code)
Accessor for whether the passed object is detached.
Parameters:
  obj - The object Whether it is detached



isDirty
boolean isDirty(Object obj)(Code)
Accessor for whether the passed object is dirty.
Parameters:
  obj - The object Whether it is dirty



isLoaded
boolean isLoaded(StateManager sm, int fieldNumber)(Code)
Accessor for whether a field is loaded for the object managed by the StateManager
Parameters:
  sm - StateManager
Parameters:
  fieldNumber - Number of the field Whether it is loaded



isNew
boolean isNew(Object obj)(Code)
Accessor for whether the passed object is new.
Parameters:
  obj - The object Whether it is new



isPersistable
boolean isPersistable(Object obj)(Code)
Method to return if the passed object is persistable using this API.
Parameters:
  obj - The object Whether it is persistable



isPersistable
boolean isPersistable(Class cls)(Code)
Utility method to check if the specified class is of a type that can be persisted for this API.
Parameters:
  cls - The class to check Whether the class is persistable using this API.



isPersistent
boolean isPersistent(Object obj)(Code)
Accessor for whether the passed object is persistent.
Parameters:
  obj - The object Whether it is persistent



isSingleFieldIdentity
boolean isSingleFieldIdentity(Object id)(Code)
Accessor for whether the passed identity is a valid single-field application-identity for this API. Whether it is valid



isSingleFieldIdentityClass
boolean isSingleFieldIdentityClass(String className)(Code)
Accessor for whether the passed class name is a valid single-field application-identity for this API.
Parameters:
  className - Name of the class Whether it is valid



isTransactional
boolean isTransactional(Object obj)(Code)
Accessor for whether the passed object is transactional.
Parameters:
  obj - The object Whether it is transactional



isValidPrimaryKeyClass
boolean isValidPrimaryKeyClass(Class pkClass, AbstractClassMetaData cmd, ClassLoaderResolver clr, int noOfPkFields)(Code)
Utility to check if a primary-key class is valid. Will throw a InvalidPrimaryKeyException if it is invalid, otherwise returning true.
Parameters:
  pkClass - The Primary Key class
Parameters:
  cmd - AbstractClassMetaData for the PersistenceCapable class
Parameters:
  clr - the ClassLoaderResolver
Parameters:
  noOfPkFields - Number of primary key fields Whether it is valid



makeFieldDirty
void makeFieldDirty(Object obj, String fieldName)(Code)
Method to make the field dirty in the object.
Parameters:
  obj - Object
Parameters:
  fieldName - Name of the field to make dirty



newStateManager
StateManager newStateManager(ObjectManager om, AbstractClassMetaData acmd)(Code)
Method to create a new StateManager for the ObjectManager and class.
Parameters:
  om - ObjectManager
Parameters:
  acmd - MetaData for the class/interface



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