Java Doc for XmlObjectFactory.java in  » UML » AndroMDA-3.2 » org » andromda » core » common » 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 » UML » AndroMDA 3.2 » org.andromda.core.common 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.andromda.core.common.XmlObjectFactory

XmlObjectFactory
public class XmlObjectFactory (Code)

Creates and returns Objects based on a set of Apache Digester rules in a consistent manner, providing validation in the process.

This XML object factory allows us to define a consistent/clean of configuring java objects from XML configuration files (i.e. it uses the class name of the java object to find what rule file and what XSD file to use). It also allows us to define a consistent way in which schema validation is performed.

It seperates each concern into one file, for example: to configure and perform validation on the MetafacadeMappings class, we need 3 files 1.) the java object (MetafacadeMappings.java), 2.) the rules file which tells the apache digester how to populate the java object from the XML configuration file (MetafacadeMappings-Rules.xml), and 3.) the XSD schema validation file (MetafacadeMappings.xsd). Note that each file is based on the name of the java object: 'java object name'.xsd and 'java object name'-Rules.xml'. After you have these three files then you just need to call the method #getInstance(java.net.URL objectClass) in this class from the java object you want to configure. This keeps the dependency to digester (or whatever XML configuration tool we are using at the time) to this single file.

In order to add/modify an existing element/attribute in your configuration file, first make the modification in your java object, then modify it's rules file to instruct the digester on how to configure your new attribute/method in the java object, and then modify your XSD file to provide correct validation for this new method/attribute. Please see the org.andromda.core.metafacade.MetafacadeMappings* files for an example on how to do this.


author:
   Chad Brandon

Inner Class :final static class XmlObjectValidator implements org.xml.sax.ErrorHandler

Field Summary
protected  StringJAXP_SCHEMA_LANGUAGE
     The JAXP 1.2 property to set up the schemaLanguage used.
final protected static  StringJAXP_SCHEMA_SOURCE
     The JAXP 1.2 property required to set up the schema location.
final protected static  Loggerlogger
     The class logger.


Method Summary
public static  XmlObjectFactorygetInstance(Class objectClass)
     Gets an instance of this XmlObjectFactory using the digester rules belonging to the objectClass.
Parameters:
  objectClass - the Class of the object from which to configure this factory.
public  ObjectgetObject(URL objectXml)
     Returns a configured Object based on the objectXml configuration file
Parameters:
  objectXml - the path to the Object XML config file.
public  ObjectgetObject(Reader objectXml)
     Returns a configured Object based on the objectXml configuration reader.
Parameters:
  objectXml - the path to the Object XML config file.
public  ObjectgetObject(String objectXml)
     Returns a configured Object based on the objectXml configuration file passed in as a String.
Parameters:
  objectXml - the path to the Object XML config file.
public  ObjectgetObject(String objectXml, URL resource)
     Returns a configured Object based on the objectXml configuration file passed in as a String.
Parameters:
  objectXml - the path to the Object XML config file.
Parameters:
  resource - the resource from which the objectXml was retrieved (this is needed to resolveany relative references; like XML entities).
public static  voidsetDefaultValidating(boolean validating)
     Allows us to set default validation to true/false for all instances of objects instantiated by this factory.
public  voidsetValidating(boolean validating)
     Sets whether or not the XmlObjectFactory should be validating, default is true.

Field Detail
JAXP_SCHEMA_LANGUAGE
protected String JAXP_SCHEMA_LANGUAGE(Code)
The JAXP 1.2 property to set up the schemaLanguage used.



JAXP_SCHEMA_SOURCE
final protected static String JAXP_SCHEMA_SOURCE(Code)
The JAXP 1.2 property required to set up the schema location.



logger
final protected static Logger logger(Code)
The class logger. Note: visibility is protected to improve access within XmlObjectValidator





Method Detail
getInstance
public static XmlObjectFactory getInstance(Class objectClass)(Code)
Gets an instance of this XmlObjectFactory using the digester rules belonging to the objectClass.
Parameters:
  objectClass - the Class of the object from which to configure this factory. the XmlObjectFactoy instance.



getObject
public Object getObject(URL objectXml)(Code)
Returns a configured Object based on the objectXml configuration file
Parameters:
  objectXml - the path to the Object XML config file. Object the created instance.



getObject
public Object getObject(Reader objectXml)(Code)
Returns a configured Object based on the objectXml configuration reader.
Parameters:
  objectXml - the path to the Object XML config file. Object the created instance.



getObject
public Object getObject(String objectXml)(Code)
Returns a configured Object based on the objectXml configuration file passed in as a String.
Parameters:
  objectXml - the path to the Object XML config file. Object the created instance.



getObject
public Object getObject(String objectXml, URL resource)(Code)
Returns a configured Object based on the objectXml configuration file passed in as a String.
Parameters:
  objectXml - the path to the Object XML config file.
Parameters:
  resource - the resource from which the objectXml was retrieved (this is needed to resolveany relative references; like XML entities). Object the created instance.



setDefaultValidating
public static void setDefaultValidating(boolean validating)(Code)
Allows us to set default validation to true/false for all instances of objects instantiated by this factory. This is necessary in some cases where the underlying parser doesn't support schema validation (such as when performing JUnit tests)
Parameters:
  validating - true/false



setValidating
public void setValidating(boolean validating)(Code)
Sets whether or not the XmlObjectFactory should be validating, default is true. If it IS set to be validating, then there needs to be a schema named objectClass.xsd in the same package as the objectClass that this factory was created from.
Parameters:
  validating - true/false



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.