[188] | 1 | /*
|
---|
| 2 | * The Apache Software License, Version 1.1
|
---|
| 3 | *
|
---|
| 4 | * Copyright (c) 2003 The Apache Software Foundation. All rights
|
---|
| 5 | * reserved.
|
---|
| 6 | *
|
---|
| 7 | * Redistribution and use in source and binary forms, with or without
|
---|
| 8 | * modification, are permitted provided that the following conditions
|
---|
| 9 | * are met:
|
---|
| 10 | *
|
---|
| 11 | * 1. Redistributions of source code must retain the above copyright
|
---|
| 12 | * notice, this list of conditions and the following disclaimer.
|
---|
| 13 | *
|
---|
| 14 | * 2. Redistributions in binary form must reproduce the above copyright
|
---|
| 15 | * notice, this list of conditions and the following disclaimer in
|
---|
| 16 | * the documentation and/or other materials provided with the
|
---|
| 17 | * distribution.
|
---|
| 18 | *
|
---|
| 19 | * 3. The end-user documentation included with the redistribution,
|
---|
| 20 | * if any, must include the following acknowledgment:
|
---|
| 21 | * "This product includes software developed by the
|
---|
| 22 | * Apache Software Foundation (http://www.apache.org/)."
|
---|
| 23 | * Alternately, this acknowledgment may appear in the software itself,
|
---|
| 24 | * if and wherever such third-party acknowledgments normally appear.
|
---|
| 25 | *
|
---|
| 26 | * 4. The names "Xerces" and "Apache Software Foundation" must
|
---|
| 27 | * not be used to endorse or promote products derived from this
|
---|
| 28 | * software without prior written permission. For written
|
---|
| 29 | * permission, please contact apache\@apache.org.
|
---|
| 30 | *
|
---|
| 31 | * 5. Products derived from this software may not be called "Apache",
|
---|
| 32 | * nor may "Apache" appear in their name, without prior written
|
---|
| 33 | * permission of the Apache Software Foundation.
|
---|
| 34 | *
|
---|
| 35 | * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
|
---|
| 36 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
---|
| 37 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
---|
| 38 | * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
|
---|
| 39 | * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
---|
| 40 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
---|
| 41 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
---|
| 42 | * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
---|
| 43 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
---|
| 44 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
---|
| 45 | * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
---|
| 46 | * SUCH DAMAGE.
|
---|
| 47 | * ====================================================================
|
---|
| 48 | *
|
---|
| 49 | * This software consists of voluntary contributions made by many
|
---|
| 50 | * individuals on behalf of the Apache Software Foundation, and was
|
---|
| 51 | * originally based on software copyright (c) 1999, International
|
---|
| 52 | * Business Machines, Inc., http://www.ibm.com . For more information
|
---|
| 53 | * on the Apache Software Foundation, please see
|
---|
| 54 | * <http://www.apache.org/>.
|
---|
| 55 | */
|
---|
| 56 |
|
---|
| 57 | /*
|
---|
| 58 | * $Log: XSAnnotation.hpp,v $
|
---|
| 59 | * Revision 1.8 2003/12/01 23:23:26 neilg
|
---|
| 60 | * fix for bug 25118; thanks to Jeroen Witmond
|
---|
| 61 | *
|
---|
| 62 | * Revision 1.7 2003/11/28 14:55:11 neilg
|
---|
| 63 | * fix for compilation error on HPUX
|
---|
| 64 | *
|
---|
| 65 | * Revision 1.6 2003/11/27 21:29:05 neilg
|
---|
| 66 | * implement writeAnnotation; thanks to Dave Cargill
|
---|
| 67 | *
|
---|
| 68 | * Revision 1.5 2003/11/14 22:47:53 neilg
|
---|
| 69 | * fix bogus log message from previous commit...
|
---|
| 70 | *
|
---|
| 71 | * Revision 1.4 2003/11/14 22:33:30 neilg
|
---|
| 72 | * Second phase of schema component model implementation.
|
---|
| 73 | * Implement XSModel, XSNamespaceItem, and the plumbing necessary
|
---|
| 74 | * to connect them to the other components.
|
---|
| 75 | * Thanks to David Cargill.
|
---|
| 76 | *
|
---|
| 77 | * Revision 1.3 2003/11/11 22:48:13 knoaman
|
---|
| 78 | * Serialization of XSAnnotation.
|
---|
| 79 | *
|
---|
| 80 | * Revision 1.2 2003/11/06 19:28:11 knoaman
|
---|
| 81 | * PSVI support for annotations.
|
---|
| 82 | *
|
---|
| 83 | * Revision 1.1 2003/09/16 14:33:36 neilg
|
---|
| 84 | * PSVI/schema component model classes, with Makefile/configuration changes necessary to build them
|
---|
| 85 | *
|
---|
| 86 | */
|
---|
| 87 |
|
---|
| 88 | #if !defined(XSANNOTATION_HPP)
|
---|
| 89 | #define XSANNOTATION_HPP
|
---|
| 90 |
|
---|
| 91 | #include <xercesc/framework/psvi/XSObject.hpp>
|
---|
| 92 | #include <xercesc/internal/XSerializable.hpp>
|
---|
| 93 |
|
---|
| 94 | XERCES_CPP_NAMESPACE_BEGIN
|
---|
| 95 |
|
---|
| 96 | /**
|
---|
| 97 | * This class describes all properties of a Schema Annotation
|
---|
| 98 | * component.
|
---|
| 99 | * This is *always* owned by the validator /parser object from which
|
---|
| 100 | * it is obtained.
|
---|
| 101 | */
|
---|
| 102 |
|
---|
| 103 | // forward declarations
|
---|
| 104 | class DOMNode;
|
---|
| 105 | class ContentHandler;
|
---|
| 106 |
|
---|
| 107 | class XMLPARSER_EXPORT XSAnnotation : public XSerializable, public XSObject
|
---|
| 108 | {
|
---|
| 109 | public:
|
---|
| 110 |
|
---|
| 111 | // TargetType
|
---|
| 112 | enum ANNOTATION_TARGET {
|
---|
| 113 | /**
|
---|
| 114 | * The object type is <code>org.w3c.dom.Element</code>.
|
---|
| 115 | */
|
---|
| 116 | W3C_DOM_ELEMENT = 1,
|
---|
| 117 | /**
|
---|
| 118 | * The object type is <code>org.w3c.dom.Document</code>.
|
---|
| 119 | */
|
---|
| 120 | W3C_DOM_DOCUMENT = 2
|
---|
| 121 | };
|
---|
| 122 |
|
---|
| 123 | // Constructors and Destructor
|
---|
| 124 | // -----------------------------------------------------------------------
|
---|
| 125 | /** @name Constructors */
|
---|
| 126 | //@{
|
---|
| 127 |
|
---|
| 128 | /**
|
---|
| 129 | * The default constructor
|
---|
| 130 | *
|
---|
| 131 | * @param contents The string that is to be the content of this XSAnnotation
|
---|
| 132 | * @param manager The configurable memory manager
|
---|
| 133 | */
|
---|
| 134 | XSAnnotation
|
---|
| 135 | (
|
---|
| 136 | const XMLCh* const contents
|
---|
| 137 | , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
|
---|
| 138 | );
|
---|
| 139 |
|
---|
| 140 | //@};
|
---|
| 141 |
|
---|
| 142 | /** @name Destructor */
|
---|
| 143 | //@{
|
---|
| 144 | ~XSAnnotation();
|
---|
| 145 | //@}
|
---|
| 146 |
|
---|
| 147 | //---------------------
|
---|
| 148 | /** @name XSAnnotation methods */
|
---|
| 149 |
|
---|
| 150 | //@{
|
---|
| 151 |
|
---|
| 152 | /**
|
---|
| 153 | * Write contents of the annotation to the specified DOM object. In-scope
|
---|
| 154 | * namespace declarations for <code>annotation</code> element are added as
|
---|
| 155 | * attribute nodes of the serialized <code>annotation</code>.
|
---|
| 156 | * @param node A target pointer to the annotation target object, i.e.
|
---|
| 157 | * either <code>DOMDocument</code> or <code>DOMElement</code> cast as
|
---|
| 158 | * <code>DOMNode</code).
|
---|
| 159 | * @param targetType A target type.
|
---|
| 160 | */
|
---|
| 161 |
|
---|
| 162 | void writeAnnotation(DOMNode* node, ANNOTATION_TARGET targetType);
|
---|
| 163 |
|
---|
| 164 | /**
|
---|
| 165 | * Write contents of the annotation to the specified object.
|
---|
| 166 | * The corresponding events for all in-scope namespace declarations are
|
---|
| 167 | * sent via the specified document handler.
|
---|
| 168 | * @param handler A target pointer to the annotation target object, i.e.
|
---|
| 169 | * <code>ContentHandler</code>.
|
---|
| 170 | */
|
---|
| 171 | void writeAnnotation(ContentHandler* handler);
|
---|
| 172 |
|
---|
| 173 | /**
|
---|
| 174 | * A text representation of annotation.
|
---|
| 175 | */
|
---|
| 176 | const XMLCh *getAnnotationString() const;
|
---|
| 177 | XMLCh *getAnnotationString();
|
---|
| 178 |
|
---|
| 179 | //@}
|
---|
| 180 |
|
---|
| 181 | //----------------------------------
|
---|
| 182 | /** methods needed by implementation */
|
---|
| 183 | //@{
|
---|
| 184 | void setNext(XSAnnotation* const nextAnnotation);
|
---|
| 185 | XSAnnotation* getNext();
|
---|
| 186 | //@}
|
---|
| 187 |
|
---|
| 188 | /***
|
---|
| 189 | * Support for Serialization/De-serialization
|
---|
| 190 | ***/
|
---|
| 191 | DECL_XSERIALIZABLE(XSAnnotation)
|
---|
| 192 | XSAnnotation(MemoryManager* const manager);
|
---|
| 193 |
|
---|
| 194 | private:
|
---|
| 195 |
|
---|
| 196 | // -----------------------------------------------------------------------
|
---|
| 197 | // Unimplemented constructors and operators
|
---|
| 198 | // -----------------------------------------------------------------------
|
---|
| 199 | XSAnnotation(const XSAnnotation&);
|
---|
| 200 | XSAnnotation & operator=(const XSAnnotation &);
|
---|
| 201 |
|
---|
| 202 | protected:
|
---|
| 203 |
|
---|
| 204 | // -----------------------------------------------------------------------
|
---|
| 205 | // data members
|
---|
| 206 | // -----------------------------------------------------------------------
|
---|
| 207 | XMLCh* fContents;
|
---|
| 208 | XSAnnotation* fNext;
|
---|
| 209 | };
|
---|
| 210 |
|
---|
| 211 | inline const XMLCh *XSAnnotation::getAnnotationString() const
|
---|
| 212 | {
|
---|
| 213 | return fContents;
|
---|
| 214 | }
|
---|
| 215 |
|
---|
| 216 | inline XMLCh *XSAnnotation::getAnnotationString()
|
---|
| 217 | {
|
---|
| 218 | return fContents;
|
---|
| 219 | }
|
---|
| 220 |
|
---|
| 221 | XERCES_CPP_NAMESPACE_END
|
---|
| 222 |
|
---|
| 223 | #endif
|
---|