XSModel Class Reference

Inheritance diagram for XSModel:

XMemory

List of all members.

Public Member Functions

Constructors
 XSModel (XMLGrammarPool *grammarPool, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
 The constructor to be used when a grammar pool contains all needed info.
 XSModel (XSModel *baseModel, GrammarResolver *grammarResolver, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
 The constructor to be used when the XSModel must represent all components in the union of an existing XSModel and a newly-created Grammar(s) from the GrammarResolver.
Destructor
 ~XSModel ()
XSModel methods
StringListgetNamespaces ()
 Convenience method.
XSNamespaceItemListgetNamespaceItems ()
 A set of namespace schema information information items ( of type XSNamespaceItem), one for each namespace name which appears as the target namespace of any schema component in the schema used for that assessment, and one for absent if any schema component in the schema had no target namespace.
XSNamedMap< XSObject > * getComponents (XSConstants::COMPONENT_TYPE objectType)
 [schema components]: a list of top-level components, i.e.
XSNamedMap< XSObject > * getComponentsByNamespace (XSConstants::COMPONENT_TYPE objectType, const XMLCh *compNamespace)
 Convenience method.
XSAnnotationListgetAnnotations ()
 [annotations]: a set of annotations.
XSElementDeclarationgetElementDeclaration (const XMLCh *name, const XMLCh *compNamespace)
 Convenience method.
XSAttributeDeclarationgetAttributeDeclaration (const XMLCh *name, const XMLCh *compNamespace)
 Convenience method.
XSTypeDefinitiongetTypeDefinition (const XMLCh *name, const XMLCh *compNamespace)
 Convenience method.
XSAttributeGroupDefinitiongetAttributeGroup (const XMLCh *name, const XMLCh *compNamespace)
 Convenience method.
XSModelGroupDefinitiongetModelGroupDefinition (const XMLCh *name, const XMLCh *compNamespace)
 Convenience method.
XSNotationDeclarationgetNotationDeclaration (const XMLCh *name, const XMLCh *compNamespace)
 Convenience method.
XSObjectgetXSObjectById (unsigned int compId, XSConstants::COMPONENT_TYPE compType)
 Optional.
XMLStringPool * getURIStringPool ()
 methods needed by implementation
XSNamespaceItemgetNamespaceItem (const XMLCh *const key)
XSObjectgetXSObject (void *key)
 Get the XSObject (i.e.

Protected Attributes

MemoryManager *const fMemoryManager
StringListfNamespaceStringList
XSNamespaceItemListfXSNamespaceItemList
RefVectorOf< XSObject > * fIdVector [XSConstants::MULTIVALUE_FACET]
XSNamedMap< XSObject > * fComponentMap [XSConstants::MULTIVALUE_FACET]
XMLStringPool * fURIStringPool
XSAnnotationListfXSAnnotationList
RefHashTableOf< XSNamespaceItem > * fHashNamespace
XSObjectFactory * fObjFactory
RefVectorOf< XSNamespaceItem > * fDeleteNamespace
XSModelfParent
bool fDeleteParent
bool fAddedS4SGrammar

Friends

class XSObjectFactory
class XSObject


Constructor & Destructor Documentation

XSModel::XSModel ( XMLGrammarPool grammarPool,
MemoryManager *const   manager = XMLPlatformUtils::fgMemoryManager 
)

The constructor to be used when a grammar pool contains all needed info.

Parameters:
grammarPool the grammar pool containing the underlying data structures
manager The configurable memory manager

XSModel::XSModel ( XSModel baseModel,
GrammarResolver *  grammarResolver,
MemoryManager *const   manager = XMLPlatformUtils::fgMemoryManager 
)

The constructor to be used when the XSModel must represent all components in the union of an existing XSModel and a newly-created Grammar(s) from the GrammarResolver.

Parameters:
baseModel the XSModel upon which this one is based
grammarResolver the grammar(s) whose components are to be merged
manager The configurable memory manager

XSModel::~XSModel (  ) 


Member Function Documentation

StringList * XSModel::getNamespaces (  ) 

Convenience method.

Returns a list of all namespaces that belong to this schema. The value null is not a valid namespace name, but if there are components that don't have a target namespace, null is included in this list.

XSNamespaceItemList * XSModel::getNamespaceItems (  ) 

A set of namespace schema information information items ( of type XSNamespaceItem), one for each namespace name which appears as the target namespace of any schema component in the schema used for that assessment, and one for absent if any schema component in the schema had no target namespace.

For more information see schema information.

XSNamedMap<XSObject>* XSModel::getComponents ( XSConstants::COMPONENT_TYPE  objectType  ) 

[schema components]: a list of top-level components, i.e.

element declarations, attribute declarations, etc.

Parameters:
objectType The type of the declaration, i.e. ELEMENT_DECLARATION, TYPE_DEFINITION and any other component type that may be a property of a schema component.
Returns:
A list of top-level definition of the specified type in objectType or null.

XSNamedMap<XSObject>* XSModel::getComponentsByNamespace ( XSConstants::COMPONENT_TYPE  objectType,
const XMLCh *  compNamespace 
)

Convenience method.

Returns a list of top-level component declarations that are defined within the specified namespace, i.e. element declarations, attribute declarations, etc.

Parameters:
objectType The type of the declaration, i.e. ELEMENT_DECLARATION.
compNamespace The namespace to which declaration belongs or null (for components with no target namespace).
Returns:
A list of top-level definitions of the specified type in objectType and defined in the specified namespace or null.

XSAnnotationList* XSModel::getAnnotations (  ) 

[annotations]: a set of annotations.

XSElementDeclaration* XSModel::getElementDeclaration ( const XMLCh *  name,
const XMLCh *  compNamespace 
)

Convenience method.

Returns a top-level element declaration.

Parameters:
name The name of the declaration.
compNamespace The namespace of the declaration, null if absent.
Returns:
A top-level element declaration or null if such declaration does not exist.

XSAttributeDeclaration* XSModel::getAttributeDeclaration ( const XMLCh *  name,
const XMLCh *  compNamespace 
)

Convenience method.

Returns a top-level attribute declaration.

Parameters:
name The name of the declaration.
compNamespace The namespace of the declaration, null if absent.
Returns:
A top-level attribute declaration or null if such declaration does not exist.

XSTypeDefinition* XSModel::getTypeDefinition ( const XMLCh *  name,
const XMLCh *  compNamespace 
)

Convenience method.

Returns a top-level simple or complex type definition.

Parameters:
name The name of the definition.
compNamespace The namespace of the declaration, null if absent.
Returns:
An XSTypeDefinition or null if such definition does not exist.

XSAttributeGroupDefinition* XSModel::getAttributeGroup ( const XMLCh *  name,
const XMLCh *  compNamespace 
)

Convenience method.

Returns a top-level attribute group definition.

Parameters:
name The name of the definition.
compNamespace The namespace of the declaration, null if absent.
Returns:
A top-level attribute group definition or null if such definition does not exist.

XSModelGroupDefinition* XSModel::getModelGroupDefinition ( const XMLCh *  name,
const XMLCh *  compNamespace 
)

Convenience method.

Returns a top-level model group definition.

Parameters:
name The name of the definition.
compNamespace The namespace of the declaration, null if absent.
Returns:
A top-level model group definition definition or null if such definition does not exist.

XSNotationDeclaration* XSModel::getNotationDeclaration ( const XMLCh *  name,
const XMLCh *  compNamespace 
)

Convenience method.

Returns a top-level notation declaration.

Parameters:
name The name of the declaration.
compNamespace The namespace of the declaration, null if absent.
Returns:
A top-level notation declaration or null if such declaration does not exist.

XSObject* XSModel::getXSObjectById ( unsigned int  compId,
XSConstants::COMPONENT_TYPE  compType 
)

Optional.

Return a component given a component type and a unique Id. May not be supported for all component types.

Parameters:
compId unique Id of the component within its type
compType type of the component
Returns:
the component of the given type with the given Id, or 0 if no such component exists or this is unsupported for this type of component.

XMLStringPool * XSModel::getURIStringPool (  ) 

methods needed by implementation

XSNamespaceItem* XSModel::getNamespaceItem ( const XMLCh *const   key  ) 

XSObject* XSModel::getXSObject ( void *  key  ) 

Get the XSObject (i.e.

XSElementDeclaration) that corresponds to to a schema grammar component (i.e. SchemaElementDecl)

Parameters:
key schema component object
Returns:
the corresponding XSObject


Friends And Related Function Documentation

friend class XSObjectFactory [friend]

friend class XSObject [friend]


Member Data Documentation

MemoryManager* const XSModel::fMemoryManager [protected]

StringList* XSModel::fNamespaceStringList [protected]

XSNamespaceItemList* XSModel::fXSNamespaceItemList [protected]

RefVectorOf<XSObject>* XSModel::fIdVector[XSConstants::MULTIVALUE_FACET] [protected]

XSNamedMap<XSObject>* XSModel::fComponentMap[XSConstants::MULTIVALUE_FACET] [protected]

XMLStringPool* XSModel::fURIStringPool [protected]

XSAnnotationList* XSModel::fXSAnnotationList [protected]

RefHashTableOf<XSNamespaceItem>* XSModel::fHashNamespace [protected]

XSObjectFactory* XSModel::fObjFactory [protected]

RefVectorOf<XSNamespaceItem>* XSModel::fDeleteNamespace [protected]

XSModel* XSModel::fParent [protected]

bool XSModel::fDeleteParent [protected]

bool XSModel::fAddedS4SGrammar [protected]


The documentation for this class was generated from the following file:
Generated on Thu Feb 19 11:35:46 2009 for Xerces-C++ by  doxygen 1.5.4