Java Doc for ObjectReferenceDescriptor.java in  » Database-ORM » db-ojb » org » apache » ojb » broker » 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 » Database ORM » db ojb » org.apache.ojb.broker.metadata 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.ojb.broker.metadata.DescriptorBase
      org.apache.ojb.broker.metadata.AttributeDescriptorBase
         org.apache.ojb.broker.metadata.ObjectReferenceDescriptor

All known Subclasses:   org.apache.ojb.broker.metadata.CollectionDescriptor,  org.apache.ojb.broker.metadata.SuperReferenceDescriptor,
ObjectReferenceDescriptor
public class ObjectReferenceDescriptor extends AttributeDescriptorBase implements XmlCapable(Code)
Describes a Field containing a reference to another class. Provides handling for foreign keys etc.
Note: Be careful when use references of this class or caching instances of this class, because instances could become invalid (see MetadataManager ).
author:
   Thomas Mahler


Field Summary
final public static  intCASCADE_LINK
    
final public static  intCASCADE_NONE
    
final public static  intCASCADE_OBJECT
    

Constructor Summary
public  ObjectReferenceDescriptor(ClassDescriptor descriptor)
    

Method Summary
public  voidaddForeignKeyField(int newId)
    
public  voidaddForeignKeyField(String newField)
    
public  StringgetCascadeAsString(int cascade)
    
public  booleangetCascadeDelete()
    
protected  intgetCascadeDeleteValue(String cascade)
    
public  booleangetCascadeRetrieve()
    
public  booleangetCascadeStore()
    
protected  intgetCascadeStoreValue(String cascade)
    
public  intgetCascadingDelete()
    
public  intgetCascadingStore()
    
public  FieldDescriptor[]getForeignKeyFieldDescriptors(ClassDescriptor cld)
    
public  VectorgetForeignKeyFields()
    
public  Object[]getForeignKeyValues(Object obj, ClassDescriptor mif)
     Returns an Object array of all FK field values of the specified object.
public  ClassgetItemClass()
    
public  StringgetItemClassName()
    
public  ClassgetItemProxyClass()
    
public  booleangetOtmDependent()
    
public  intgetProxyPrefetchingLimit()
    
public  booleanhasConstraint()
     Returns true if a foreign key constraint to the referenced object is declared, else false is returned.
public  booleanisLazy()
     Gets the lazy.
public  booleanisRefresh()
     Gets the refresh.
public  booleanisSuperReferenceDescriptor()
     Returns true if this descriptor was used to describe a reference to a super class of an object.
public  voidsetCascadeDelete(boolean cascade)
    
public  voidsetCascadeRetrieve(boolean b)
    
public  voidsetCascadeStore(boolean cascade)
    
public  voidsetCascadingDelete(int cascade)
    
public  voidsetCascadingDelete(String value)
    
public  voidsetCascadingStore(int cascade)
    
public  voidsetCascadingStore(String value)
    
public  voidsetConstraint(boolean constraint)
     Set a foreign key constraint flag for this reference - see ObjectReferenceDescriptor.hasConstraint()
Parameters:
  constraint - If set true, signals a foreign key constraint in database.
public  voidsetForeignKeyFields(Vector vec)
    
public  voidsetItemClass(Class c)
    
public  voidsetLazy(boolean lazy)
     Sets the lazy.
public  voidsetOtmDependent(boolean b)
    
public  voidsetProxyPrefetchingLimit(int proxyPrefetchingLimit)
    
public  voidsetRefresh(boolean refresh)
     Sets the refresh.
public  StringtoString()
    
public  StringtoXML()
    

Field Detail
CASCADE_LINK
final public static int CASCADE_LINK(Code)



CASCADE_NONE
final public static int CASCADE_NONE(Code)



CASCADE_OBJECT
final public static int CASCADE_OBJECT(Code)




Constructor Detail
ObjectReferenceDescriptor
public ObjectReferenceDescriptor(ClassDescriptor descriptor)(Code)




Method Detail
addForeignKeyField
public void addForeignKeyField(int newId)(Code)
add a foreign key field ID



addForeignKeyField
public void addForeignKeyField(String newField)(Code)
add a foreign key field



getCascadeAsString
public String getCascadeAsString(int cascade)(Code)



getCascadeDelete
public boolean getCascadeDelete()(Code)
ObjectReferenceDescriptor.getCascadingDelete



getCascadeDeleteValue
protected int getCascadeDeleteValue(String cascade)(Code)



getCascadeRetrieve
public boolean getCascadeRetrieve()(Code)



getCascadeStore
public boolean getCascadeStore()(Code)
ObjectReferenceDescriptor.getCascadingStore



getCascadeStoreValue
protected int getCascadeStoreValue(String cascade)(Code)



getCascadingDelete
public int getCascadingDelete()(Code)



getCascadingStore
public int getCascadingStore()(Code)



getForeignKeyFieldDescriptors
public FieldDescriptor[] getForeignKeyFieldDescriptors(ClassDescriptor cld)(Code)



getForeignKeyFields
public Vector getForeignKeyFields()(Code)



getForeignKeyValues
public Object[] getForeignKeyValues(Object obj, ClassDescriptor mif) throws PersistenceBrokerException(Code)
Returns an Object array of all FK field values of the specified object. If the specified object is an unmaterialized Proxy, it will be materialized to read the FK values.
throws:
  MetadataException - if an error occours while accessing ForeingKey values on obj



getItemClass
public Class getItemClass()(Code)



getItemClassName
public String getItemClassName()(Code)
the fully qualified name of the item class for this descriptor.



getItemProxyClass
public Class getItemProxyClass() throws PersistenceBrokerException(Code)



getOtmDependent
public boolean getOtmDependent()(Code)



getProxyPrefetchingLimit
public int getProxyPrefetchingLimit()(Code)



hasConstraint
public boolean hasConstraint()(Code)
Returns true if a foreign key constraint to the referenced object is declared, else false is returned.



isLazy
public boolean isLazy()(Code)
Gets the lazy. Returns a boolean



isRefresh
public boolean isRefresh()(Code)
Gets the refresh. Returns a boolean



isSuperReferenceDescriptor
public boolean isSuperReferenceDescriptor()(Code)
Returns true if this descriptor was used to describe a reference to a super class of an object. always false for this instance.



setCascadeDelete
public void setCascadeDelete(boolean cascade)(Code)
ObjectReferenceDescriptor.setCascadingDelete(int)



setCascadeRetrieve
public void setCascadeRetrieve(boolean b)(Code)



setCascadeStore
public void setCascadeStore(boolean cascade)(Code)
ObjectReferenceDescriptor.setCascadingStore(int)



setCascadingDelete
public void setCascadingDelete(int cascade)(Code)



setCascadingDelete
public void setCascadingDelete(String value)(Code)



setCascadingStore
public void setCascadingStore(int cascade)(Code)



setCascadingStore
public void setCascadingStore(String value)(Code)



setConstraint
public void setConstraint(boolean constraint)(Code)
Set a foreign key constraint flag for this reference - see ObjectReferenceDescriptor.hasConstraint()
Parameters:
  constraint - If set true, signals a foreign key constraint in database.



setForeignKeyFields
public void setForeignKeyFields(Vector vec)(Code)



setItemClass
public void setItemClass(Class c)(Code)
sets the item class
Parameters:
  c - the items class object



setLazy
public void setLazy(boolean lazy)(Code)
Sets the lazy.
Parameters:
  lazy - The lazy to set



setOtmDependent
public void setOtmDependent(boolean b)(Code)



setProxyPrefetchingLimit
public void setProxyPrefetchingLimit(int proxyPrefetchingLimit)(Code)



setRefresh
public void setRefresh(boolean refresh)(Code)
Sets the refresh.
Parameters:
  refresh - The refresh to set



toString
public String toString()(Code)



toXML
public String toXML()(Code)



Fields inherited from org.apache.ojb.broker.metadata.AttributeDescriptorBase
protected ClassDescriptor m_ClassDescriptor(Code)(Java Doc)
protected PersistentField m_PersistentField(Code)(Java Doc)

Methods inherited from org.apache.ojb.broker.metadata.AttributeDescriptorBase
public String getAttributeName()(Code)(Java Doc)
public ClassDescriptor getClassDescriptor()(Code)(Java Doc)
public PersistentField getPersistentField()(Code)(Java Doc)
public void setClassDescriptor(ClassDescriptor classDescriptor)(Code)(Java Doc)
public void setPersistentField(Class c, String fieldname)(Code)(Java Doc)
public void setPersistentField(PersistentField pf)(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Fields inherited from org.apache.ojb.broker.metadata.DescriptorBase
final static long serialVersionUID(Code)(Java Doc)

Methods inherited from org.apache.ojb.broker.metadata.DescriptorBase
public void addAttribute(String attributeName, String attributeValue)(Code)(Java Doc)
public String getAttribute(String attributeName, String defaultValue)(Code)(Java Doc)
public String getAttribute(String attributeName)(Code)(Java Doc)
public String[] getAttributeNames()(Code)(Java Doc)
public Map getAttributes()(Code)(Java Doc)
public String toString()(Code)(Java Doc)

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.