Package pyxb :: Package xmlschema :: Module structures :: Class ModelGroup

Class ModelGroup

                               object --+        
                                        |        
                                  cscRoot --+    
                                            |    
                          _ParticleTree_mixin --+
                                                |
                       object --+               |
                                |               |
                          cscRoot --+           |
                                    |           |
 utils.utility.PrivateTransient_mixin --+       |
                                        |       |
                           object --+   |       |
                                    |   |       |
                              cscRoot --+       |
                                        |       |
     namespace._ComponentDependency_mixin --+   |
                                            |   |
                           object --+       |   |
                                    |       |   |
                              cscRoot --+   |   |
                                        |   |   |
namespace.archive._ArchivableObject_mixin --+   |
                                            |   |
                           object --+       |   |
                                    |       |   |
                              cscRoot --+   |   |
                                        |   |   |
     utils.utility.PrivateTransient_mixin --+   |
                                            |   |
                           object --+       |   |
                                    |       |   |
                              cscRoot --+   |   |
                                        |   |   |
            utils.utility.Locatable_mixin --+   |
                                            |   |
                       _SchemaComponent_mixin --+
                                                |
                               object --+       |
                                        |       |
                                  cscRoot --+   |
                                            |   |
                             _Annotated_mixin --+
                                                |
                                               ModelGroup

An XMLSchema Model Group component.

Instance Methods

[hide private]

compositor(self)

source code

compositorToString(self)
Return a string representing the compositor value.

source code

particles(self)

source code

isAdaptable(self, ctd)
A model group has an unresolvable particle if any of its particles is unresolvable.

source code

effectiveTotalRange(self, particle)
Return the minimum and maximum of the number of elements that can appear in a sequence matched by this particle.

source code

modelGroupDefinition(self)
The ModelGroupDefinition that names this group, or None if it is unnamed.

source code

__init__(self, compositor, particles, *args, **kw)
Create a new model group.

source code

hasWildcardElement(self)
Return True if the model includes a wildcard amongst its particles.

source code

frozenset

_bindingRequires_vx(self, include_lax)
Placeholder for subclass method that identifies the necessary components.

source code

_adaptForScope(self, owner, ctd)

source code

_walkParticleTree(self, visit, arg)
Mix-in supporting walks of Particle trees.

source code

__str__(self)
str(x)

source code

Inherited from _SchemaComponent_mixin: bestNCName, facStateSortKey, hasBinding, isTypeDefinition, isUrTypeDefinition, nameInBinding, owner, schemaOrderSortKey, setNameInBinding

Inherited from _SchemaComponent_mixin (private): _clearNamespaceContext, _clone, _cloneSource, _clones, _dissociateFromNamespace, _namespaceContext, _resetClone_csc, _scope, _scopeIsGlobal, _scopeIsIndeterminate, _setFacStateSortKey, _setOwner, _setScope, _updateFromOther_csc

Inherited from namespace._ComponentDependency_mixin: bindingRequires

Inherited from namespace.archive._ArchivableObject_mixin (private): _allowUpdateFromOther, _objectOrigin, _prepareForArchive, _setObjectOrigin, _updateFromOther

Inherited from utils.utility.PrivateTransient_mixin: __getstate__

Inherited from utils.utility.Locatable_mixin (private): _location, _setLocation

Inherited from _Annotated_mixin: annotation

Inherited from _Annotated_mixin (private): _annotationFromDOM

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Methods

[hide private]

CompositorToString(cls, compositor)
Map a compositor value to a string.

source code

CreateFromDOM(cls, node, **kw)
Create a model group from the given DOM node.

source code

IsGroupMemberNode(cls, node)

source code

Class Variables

[hide private]

C_INVALID = 0

C_ALL = 1

C_CHOICE = 2

C_SEQUENCE = 3

__compositor = 0

__particles = None
hash(x)

__modelGroupDefinition = None
hash(x)

Inherited from _SchemaComponent_mixin (private): _SchemaComponent_mixin__PrivateTransient, _SchemaComponent_mixin__cloneSource, _SchemaComponent_mixin__clones, _SchemaComponent_mixin__facStateSortKey, _SchemaComponent_mixin__nameInBinding, _SchemaComponent_mixin__namespaceContext, _SchemaComponent_mixin__ownedComponents, _SchemaComponent_mixin__owner, _SchemaComponent_mixin__schemaOrderSortKey, _SchemaComponent_mixin__scope

Inherited from namespace._ComponentDependency_mixin (private): _ComponentDependency_mixin__PrivateTransient, _ComponentDependency_mixin__bindingRequires

Inherited from namespace.archive._ArchivableObject_mixin (private): _ArchivableObject_mixin__objectOrigin

Inherited from _Annotated_mixin (private): _Annotated_mixin__annotation

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

isAdaptable(self, ctd)

source code

A model group has an unresolvable particle if any of its particles is unresolvable. Duh.

effectiveTotalRange(self, particle)

source code

Return the minimum and maximum of the number of elements that can appear in a sequence matched by this particle.

See http://www.w3.org/TR/xmlschema-1/#cos-seq-range

init(self, compositor, particles, *args, **kw)
(Constructor)

source code

Create a new model group.

compositor must be a legal compositor value (one of C_ALL, C_CHOICE, C_SEQUENCE).

particles must be a list of zero or more Particle instances.

scope is the _ScopeDeclaration_mixin context into which new declarations are recorded. It can be SCOPE_global, a complex type definition, or None if this is (or is within) a named model group.

model_group_definition is an instance of ModelGroupDefinition if this is a named model group. It defaults to None indicating a local group.

Parameters:

scope - The scope in which the component is defined
namespace_context - The NamespaceContext to use within this component
node - If no namespace_context is provided, a DOM node must be provided from which a namespace context can be identified.
owner - Reference to the component that owns this one (the immediately enclosing component). Is None in the case of top-level components.
schema - Reference to the Schema component to which the component belongs. Required for every component except Schema, Annotation, and Wildcard.

Overrides: object.__init__

_bindingRequires_vx(self, include_lax)

source code

Placeholder for subclass method that identifies the necessary components.

Returns: frozenset

The component instances on which this component depends

Raises:

LogicError - A subclass failed to implement this method

Overrides: namespace._ComponentDependency_mixin._bindingRequires_vx

(inherited documentation)

CreateFromDOM(cls, node, **kw)
Class Method

source code

Create a model group from the given DOM node.

wxs is a Schema instance within which the model group is being defined.

node is a DOM element. The name must be one of ( 'all', 'choice', 'sequence' ), and the node must be in the XMLSchema namespace.

scope is the _ScopeDeclaration_mxin context that is assigned to declarations that appear within the model group. It can be None, indicating no scope defined, or a complex type definition.

_walkParticleTree(self, visit, arg)

source code

Mix-in supporting walks of Particle trees.

This invokes a provided function on each node in a tree defining the content model of a particle, both on the way down the tree and on the way back up. A standard implementation would be:

 def _walkParticleTree (self, visit, arg):
   visit(self, True, arg)
   self.__term.walkParticleTree(visit, arg)
   visit(self, False, arg)

Parameters:

visit - A callable with parameters node, entering, arg where node is an instance of a class inheriting _ParticleTree_mixin, entering indicates tree transition status, and arg is a caller-provided state parameter. entering is True if node has particle children and the call is before they are visited; None if the node has no particle children; and False if node has particle children and they have been visited.
arg - The caller-provided state parameter to be passed along with the node and entry/exit status in the invocation of visit.

Overrides: _ParticleTree_mixin._walkParticleTree

(inherited documentation)

str(self)
(Informal representation operator)

source code

str(x)

Overrides: object.__str__: (inherited documentation)

Class ModelGroup

isAdaptable(self, ctd)

effectiveTotalRange(self, particle)

__init__(self, compositor, particles, *args, **kw) (Constructor)

_bindingRequires_vx(self, include_lax)

CreateFromDOM(cls, node, **kw) Class Method

_walkParticleTree(self, visit, arg)

__str__(self) (Informal representation operator)

init(self, compositor, particles, *args, **kw)
(Constructor)

CreateFromDOM(cls, node, **kw)
Class Method

str(self)
(Informal representation operator)