2 * Copyright 2001-2007 Internet2
\r
4 * Licensed under the Apache License, Version 2.0 (the "License");
\r
5 * you may not use this file except in compliance with the License.
\r
6 * You may obtain a copy of the License at
\r
8 * http://www.apache.org/licenses/LICENSE-2.0
\r
10 * Unless required by applicable law or agreed to in writing, software
\r
11 * distributed under the License is distributed on an "AS IS" BASIS,
\r
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
13 * See the License for the specific language governing permissions and
\r
14 * limitations under the License.
\r
18 * @file xmltooling/XMLObjectBuilder.h
\r
20 * Factory interface for XMLObjects.
\r
23 #ifndef __xmltooling_xmlobjbuilder_h__
\r
24 #define __xmltooling_xmlobjbuilder_h__
\r
28 #include <xmltooling/QName.h>
\r
29 #include <xmltooling/XMLObject.h>
\r
30 #include <xmltooling/util/XMLHelper.h>
\r
32 #if defined (_MSC_VER)
\r
33 #pragma warning( push )
\r
34 #pragma warning( disable : 4250 4251 )
\r
37 namespace xmltooling {
\r
40 * A factory interface for obtaining XMLObjects.
\r
41 * Subclasses MAY supply additional factory methods.
\r
43 class XMLTOOL_API XMLObjectBuilder
\r
45 MAKE_NONCOPYABLE(XMLObjectBuilder);
\r
47 virtual ~XMLObjectBuilder() {}
\r
50 * Creates an empty XMLObject with a particular element name.
\r
51 * <p>The results are undefined if localName is NULL or empty.
\r
53 * @param nsURI namespace URI for element
\r
54 * @param localName local name of element
\r
55 * @param prefix prefix of element name
\r
56 * @param schemaType xsi:type of the object
\r
57 * @return the empty XMLObject
\r
59 virtual XMLObject* buildObject(
\r
60 const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL, const QName* schemaType=NULL
\r
64 * Creates an empty XMLObject with a particular element name.
\r
66 * @param q QName of element for object
\r
67 * @return the empty XMLObject
\r
69 XMLObject* buildFromQName(const QName& q) const {
\r
70 return buildObject(q.getNamespaceURI(),q.getLocalPart(),q.getPrefix());
\r
74 * Creates an unmarshalled XMLObject from a DOM Element.
\r
76 * @param element the unmarshalling source
\r
77 * @param bindDocument true iff the XMLObject should take ownership of the DOM Document
\r
78 * @return the unmarshalled XMLObject
\r
80 XMLObject* buildFromElement(xercesc::DOMElement* element, bool bindDocument=false) const {
\r
81 std::auto_ptr<XMLObject> ret(
\r
82 buildObject(element->getNamespaceURI(),element->getLocalName(),element->getPrefix(),XMLHelper::getXSIType(element))
\r
84 ret->unmarshall(element,bindDocument);
\r
85 return ret.release();
\r
89 * Creates an unmarshalled XMLObject from the root of a DOM Document.
\r
91 * @param doc the unmarshalling source
\r
92 * @param bindDocument true iff the XMLObject should take ownership of the DOM Document
\r
93 * @return the unmarshalled XMLObject
\r
95 XMLObject* buildFromDocument(xercesc::DOMDocument* doc, bool bindDocument=true) const {
\r
96 return buildFromElement(doc->getDocumentElement(),bindDocument);
\r
100 * Creates an unmarshalled XMLObject using the default build method, if a builder can be found.
\r
102 * @param element the unmarshalling source
\r
103 * @param bindDocument true iff the new XMLObject should take ownership of the DOM Document
\r
104 * @return the unmarshalled object or NULL if no builder is available
\r
106 static XMLObject* buildOneFromElement(xercesc::DOMElement* element, bool bindDocument=false) {
\r
107 const XMLObjectBuilder* b=getBuilder(element);
\r
108 return b ? b->buildFromElement(element,bindDocument) : NULL;
\r
112 * Retrieves an XMLObjectBuilder using the key it was registered with.
\r
114 * @param key the key used to register the builder
\r
115 * @return the builder or NULL
\r
117 static const XMLObjectBuilder* getBuilder(const QName& key) {
\r
118 std::map<QName,XMLObjectBuilder*>::const_iterator i=m_map.find(key);
\r
119 return (i==m_map.end()) ? NULL : i->second;
\r
123 * Retrieves an XMLObjectBuilder for a given DOM element.
\r
124 * If no match is found, the default builder is returned, if any.
\r
126 * @param element the element for which to locate a builder
\r
127 * @return the builder or NULL
\r
129 static const XMLObjectBuilder* getBuilder(const xercesc::DOMElement* element);
\r
132 * Retrieves the default XMLObjectBuilder for DOM elements
\r
134 * @return the default builder or NULL
\r
136 static const XMLObjectBuilder* getDefaultBuilder() {
\r
141 * Gets an immutable list of all the builders currently registered.
\r
143 * @return list of all the builders currently registered
\r
145 static const std::map<QName,XMLObjectBuilder*>& getBuilders() {
\r
150 * Registers a new builder for the given key.
\r
152 * @param builderKey the key used to retrieve this builder later
\r
153 * @param builder the builder
\r
155 static void registerBuilder(const QName& builderKey, XMLObjectBuilder* builder) {
\r
156 deregisterBuilder(builderKey);
\r
157 m_map[builderKey]=builder;
\r
161 * Registers a default builder
\r
163 * @param builder the default builder
\r
165 static void registerDefaultBuilder(XMLObjectBuilder* builder) {
\r
166 deregisterDefaultBuilder();
\r
171 * Deregisters a builder.
\r
173 * @param builderKey the key for the builder to be deregistered
\r
175 static void deregisterBuilder(const QName& builderKey) {
\r
176 delete getBuilder(builderKey);
\r
177 m_map.erase(builderKey);
\r
181 * Deregisters default builder.
\r
183 static void deregisterDefaultBuilder() {
\r
189 * Unregisters and destroys all registered builders.
\r
191 static void destroyBuilders();
\r
194 XMLObjectBuilder() {}
\r
197 static std::map<QName,XMLObjectBuilder*> m_map;
\r
198 static XMLObjectBuilder* m_default;
\r
203 #if defined (_MSC_VER)
\r
204 #pragma warning( pop )
\r
207 #endif /* __xmltooling_xmlobjbuilder_h__ */
\r