Java Doc for ClassMetaData.java in  » J2EE » Jaffa » org » jaffa » persistence » engines » jdbcengine » configservice » 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 » J2EE » Jaffa » org.jaffa.persistence.engines.jdbcengine.configservice 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jaffa.persistence.engines.jdbcengine.configservice.ClassMetaData

ClassMetaData
public class ClassMetaData (Code)
This class holds all the meta deta pertaining to a particular persistent object



Constructor Summary
public  ClassMetaData()
     Constructs a new ClassMetaData object with an empty class name.
public  ClassMetaData(String classname)
     Constructs a new ClassMetaData object with the specified class name.

Method Summary
public  voidaddAttribute(String attName, String type)
     Add an attribute to this meta data object.
public  voidaddKeyField(String attName, String type, boolean autogen)
     Add a primary key field attribute to this meta data object.
public  voidaddMember(String attName, String memberName)
     Add a member for an attribute to this meta object.
public  voidaddSqlName(String attName, String sqlName)
     Add a new sql name for an attribute to this meta object.
public  voidaddSqlType(String attName, String type)
     Add sql type data for a particular attribute in this meta data object.
public  AccessibleObjectgetAccessor(String attributeName)
     Returns the accessor Field/Method for the specified attribute.
Parameters:
  attributeName - Name of the attribute for which accessor is required.
public  MapgetAccessors()
     Return a Map of the accessor Field/Method objects for the defined class where key is the name of the attribute and value is the accessor Field/Method object.
public  MapgetAllKeyFieldNames()
     Returns a Map where key is the name of a primary key attribute for the class and value is its corresponding Java type.
public  MapgetAttributes()
     Returns a Map of the non-primary-key attributes of the class where key is the name of the attribtue and value is its Java type.
public  StringgetClassName()
     Returns the fully-qualified class name of the class that this meta object represents.
public  AccessibleObjectgetMutator(String attributeName)
     Returns the mutator Field/Method for the specified attribute.
Parameters:
  attributeName - Name of the attribute for which mutator is required.
public  MapgetMutators()
     Return a Map of the mutator Field/Method objects for the defined class where key is the name of the attribute and value is the mutator Field/Method object.
public  MapgetNonAutoKeyFieldNames()
     Returns a Map where key is the name of a primary key attribute for the class and value is its corresponding Java type.
public  StringgetSqlName(String attributeName)
     Returns the name of the sql column in which the specified attribute is stored, as defined in the mapping file.
Parameters:
  attributeName - Name of the attribute for which the sql name is required.
public  StringgetSqlType(String attributeName)
     Returns the database sql type for the specified attribute, as defined in the mapping file.
Parameters:
  attributeName - Name of the attribute for which sql type is required.
public  StringgetTable()
     Return the database table name that the object represented by this meta object is to be stored in.
public  StringgetType(String attName)
     Returns the Java type of the specified attribute.
Parameters:
  attName - The name of the attribute to be checked.
public  URLgetXmlFileUrl()
     Returns the URL object that was parsed to obtain the meta data for this object.
public  voidsetClassName(String classname)
     Set the classname property of this meta data object.
public  voidsetTable(String table)
    
public  voidsetXmlFileUrl(URL xmlFileUrl)
     Set the xmlFileUrl property of this meta data object.
public  voidvalidate()
     Uses the Introspection service to ensure that the correct accessors and mutators exist for each attribtue specified in the mapping file.


Constructor Detail
ClassMetaData
public ClassMetaData()(Code)
Constructs a new ClassMetaData object with an empty class name.



ClassMetaData
public ClassMetaData(String classname)(Code)
Constructs a new ClassMetaData object with the specified class name.
Parameters:
  classname - The fully-qualified classname of the class this meta object is to represent.




Method Detail
addAttribute
public void addAttribute(String attName, String type)(Code)
Add an attribute to this meta data object.
Parameters:
  attName - The attribute to be added.
Parameters:
  type - The Java type of the attribute to be added.



addKeyField
public void addKeyField(String attName, String type, boolean autogen)(Code)
Add a primary key field attribute to this meta data object.
Parameters:
  attName - The name of the primary key attribute to be added.
Parameters:
  type - The Java type of the primary key attribute.
Parameters:
  autogen - Indicates if the key will be auto-generated.



addMember
public void addMember(String attName, String memberName)(Code)
Add a member for an attribute to this meta object.
Parameters:
  attName - The name of the attribute for which the member is to be added.
Parameters:
  memberName - The name of the member variable.



addSqlName
public void addSqlName(String attName, String sqlName)(Code)
Add a new sql name for an attribute to this meta object.
Parameters:
  attName - The name of the attribute for which the sql name is to be added.
Parameters:
  sqlName - The sql name of the attribute.



addSqlType
public void addSqlType(String attName, String type)(Code)
Add sql type data for a particular attribute in this meta data object.
Parameters:
  attName - The name of the attribute for which sql type is to be added.
Parameters:
  type - The sql type for the attribute.



getAccessor
public AccessibleObject getAccessor(String attributeName)(Code)
Returns the accessor Field/Method for the specified attribute.
Parameters:
  attributeName - Name of the attribute for which accessor is required. The accessor Field/Method for the attribute.



getAccessors
public Map getAccessors()(Code)
Return a Map of the accessor Field/Method objects for the defined class where key is the name of the attribute and value is the accessor Field/Method object. A Map of the accessor Field/Method objects for the defined class.



getAllKeyFieldNames
public Map getAllKeyFieldNames()(Code)
Returns a Map where key is the name of a primary key attribute for the class and value is its corresponding Java type.

Since 1.3 - This include both manual and auto genrated key fields, use getNonAutoKeyFieldNames() to get just the manual key fields. Map of the key attributes and their types.




getAttributes
public Map getAttributes()(Code)
Returns a Map of the non-primary-key attributes of the class where key is the name of the attribtue and value is its Java type. Map representing the non-primary-key attributes of the class.



getClassName
public String getClassName()(Code)
Returns the fully-qualified class name of the class that this meta object represents. Fully qualified class name of the class that this meta objectrepresents.



getMutator
public AccessibleObject getMutator(String attributeName)(Code)
Returns the mutator Field/Method for the specified attribute.
Parameters:
  attributeName - Name of the attribute for which mutator is required. The mutator Field/Method for the attribute.



getMutators
public Map getMutators()(Code)
Return a Map of the mutator Field/Method objects for the defined class where key is the name of the attribute and value is the mutator Field/Method object. A Map of the mutator Field/Method objects for the defined class.



getNonAutoKeyFieldNames
public Map getNonAutoKeyFieldNames()(Code)
Returns a Map where key is the name of a primary key attribute for the class and value is its corresponding Java type. Only the keys that are not auto generated by the database are returned, these are the keys that are valid when inserting a row, as auto gnerated keys should not be provided.
since:
   1.3 Map of the key attributes and their types.



getSqlName
public String getSqlName(String attributeName)(Code)
Returns the name of the sql column in which the specified attribute is stored, as defined in the mapping file.
Parameters:
  attributeName - Name of the attribute for which the sql name is required. The column name for the specified attribute.



getSqlType
public String getSqlType(String attributeName)(Code)
Returns the database sql type for the specified attribute, as defined in the mapping file.
Parameters:
  attributeName - Name of the attribute for which sql type is required. The sql type for the specified attribtue.



getTable
public String getTable()(Code)
Return the database table name that the object represented by this meta object is to be stored in. Database table name that this object is stored in.



getType
public String getType(String attName)(Code)
Returns the Java type of the specified attribute.
Parameters:
  attName - The name of the attribute to be checked. The Java type of the specified attribute.



getXmlFileUrl
public URL getXmlFileUrl()(Code)
Returns the URL object that was parsed to obtain the meta data for this object. The URL of the xml File that describes this object.



setClassName
public void setClassName(String classname)(Code)
Set the classname property of this meta data object.
Parameters:
  classname - The fully qualified class name of the class this metaobject represents.



setTable
public void setTable(String table)(Code)
Set the table property of this meta data object
Parameters:
  table - The database table name used to store this object



setXmlFileUrl
public void setXmlFileUrl(URL xmlFileUrl)(Code)
Set the xmlFileUrl property of this meta data object.
Parameters:
  xmlFileUrl - The File object used to describe this persistent object.



validate
public void validate()(Code)
Uses the Introspection service to ensure that the correct accessors and mutators exist for each attribtue specified in the mapping file. The runtime exception ClassMetaDataValidationRuntimeException is thrown in case any error occurs in the introspection, or if all accessors/mutators could not be located for all the attributes.



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.