Xerces-C++  3.1.3
Public Types | Public Member Functions | Protected Attributes | List of all members
XSAnnotation Class Reference
Inheritance diagram for XSAnnotation:
XSObject XMemory

Public Types

enum  ANNOTATION_TARGET { W3C_DOM_ELEMENT = 1, W3C_DOM_DOCUMENT = 2 }
 

Public Member Functions

 XSAnnotation (MemoryManager *const manager)
 
Constructors
 XSAnnotation (const XMLCh *const contents, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
 The default constructor. More...
 
Destructor
 ~XSAnnotation ()
 
XSAnnotation methods
void writeAnnotation (DOMNode *node, ANNOTATION_TARGET targetType)
 Write contents of the annotation to the specified DOM object. More...
 
void writeAnnotation (ContentHandler *handler)
 Write contents of the annotation to the specified object. More...
 
const XMLChgetAnnotationString () const
 A text representation of annotation. More...
 
XMLChgetAnnotationString ()
 
void setNext (XSAnnotation *const nextAnnotation)
 methods needed by implementation More...
 
XSAnnotationgetNext ()
 
void getLineCol (XMLFileLoc &line, XMLFileLoc &col) const
 Getter. More...
 
const XMLChgetSystemId () const
 
void setLineCol (XMLFileLoc line, XMLFileLoc col)
 Setter. More...
 
void setSystemId (const XMLCh *const systemId)
 
- Public Member Functions inherited from XSObject
 XSObject (XSConstants::COMPONENT_TYPE compType, XSModel *const xsModel, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
 The default constructor. More...
 
virtual ~XSObject ()
 
XSConstants::COMPONENT_TYPE getType () const
 The type of this object, i.e. More...
 
virtual const XMLChgetName () const
 The name of type NCName of this declaration as defined in XML Namespaces. More...
 
virtual const XMLChgetNamespace ()
 The [target namespace] of this object, or null if it is unspecified. More...
 
virtual XSNamespaceItemgetNamespaceItem ()
 A namespace schema information item corresponding to the target namespace of the component, if it's globally declared; or null otherwise. More...
 
virtual XMLSize_t getId () const
 Optional. More...
 
void setId (XMLSize_t id)
 methods needed by implementation More...
 
- Public Member Functions inherited from XMemory
void * operator new (size_t size)
 This method overrides operator new. More...
 
void * operator new (size_t size, MemoryManager *memMgr)
 This method defines a custom operator new, that will use the provided memory manager to perform the allocation. More...
 
void * operator new (size_t size, void *ptr)
 This method overrides placement operator new. More...
 
void operator delete (void *p)
 This method overrides operator delete. More...
 
void operator delete (void *p, MemoryManager *memMgr)
 This method provides a matching delete for the custom operator new. More...
 
void operator delete (void *p, void *ptr)
 This method provides a matching delete for the placement new. More...
 

Protected Attributes

XMLChfContents
 
XSAnnotationfNext
 
- Protected Attributes inherited from XSObject
XSConstants::COMPONENT_TYPE fComponentType
 
XSModelfXSModel
 
MemoryManagerfMemoryManager
 
XMLSize_t fId
 

Additional Inherited Members

- Protected Member Functions inherited from XMemory
 XMemory ()
 Protected default constructor. More...
 

Member Enumeration Documentation

Enumerator
W3C_DOM_ELEMENT 

The object type is org.w3c.dom.Element.

W3C_DOM_DOCUMENT 

The object type is org.w3c.dom.Document.

Constructor & Destructor Documentation

XSAnnotation::XSAnnotation ( const XMLCh *const  contents,
MemoryManager *const  manager = XMLPlatformUtils::fgMemoryManager 
)

The default constructor.

Parameters
contentsThe string that is to be the content of this XSAnnotation
managerThe configurable memory manager
XSAnnotation::~XSAnnotation ( )
XSAnnotation::XSAnnotation ( MemoryManager *const  manager)

Member Function Documentation

const XMLCh * XSAnnotation::getAnnotationString ( ) const

A text representation of annotation.

XMLCh * XSAnnotation::getAnnotationString ( )
void XSAnnotation::getLineCol ( XMLFileLoc line,
XMLFileLoc col 
) const

Getter.

XSAnnotation* XSAnnotation::getNext ( )
const XMLCh * XSAnnotation::getSystemId ( ) const
void XSAnnotation::setLineCol ( XMLFileLoc  line,
XMLFileLoc  col 
)

Setter.

void XSAnnotation::setNext ( XSAnnotation *const  nextAnnotation)

methods needed by implementation

void XSAnnotation::setSystemId ( const XMLCh *const  systemId)
void XSAnnotation::writeAnnotation ( DOMNode node,
ANNOTATION_TARGET  targetType 
)

Write contents of the annotation to the specified DOM object.

In-scope namespace declarations for annotation element are added as attribute nodes of the serialized annotation.

Parameters
nodeA target pointer to the annotation target object, i.e. either DOMDocument or DOMElement cast as DOMNode.
targetTypeA target type.
void XSAnnotation::writeAnnotation ( ContentHandler handler)

Write contents of the annotation to the specified object.

The corresponding events for all in-scope namespace declarations are sent via the specified document handler.

Parameters
handlerA target pointer to the annotation target object, i.e. ContentHandler.

Member Data Documentation

XMLCh* XSAnnotation::fContents
protected
XSAnnotation* XSAnnotation::fNext
protected

The documentation for this class was generated from the following file: