Home       Trees       Indices       Help   
PyXB hosted on Get PyXB: Python XML Schema Bindings at SourceForge.net. Fast, secure and Free Open Source software downloads
Package pyxb :: Package xmlschema :: Module structures :: Class AttributeDeclaration
[hide private]
[frames] | no frames]

Class AttributeDeclaration

source code

                       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 --+       |
                                        |       |
     utils.utility.PrivateTransient_mixin --+   |
                                            |   |
                               object --+   |   |
                                        |   |   |
                                  cscRoot --+   |
                                            |   |
                        _NamedComponent_mixin --+
                                                |
                               object --+       |
                                        |       |
                                  cscRoot --+   |
                                            |   |
       namespace.resolution._Resolvable_mixin --+
                                                |
                               object --+       |
                                        |       |
                                  cscRoot --+   |
                                            |   |
                             _Annotated_mixin --+
                                                |
                               object --+       |
                                        |       |
                                  cscRoot --+   |
                                            |   |
                       _ValueConstraint_mixin --+
                                                |
                               object --+       |
                                        |       |
                                  cscRoot --+   |
                                            |   |
                     _ScopedDeclaration_mixin --+
                                                |
                                               AttributeDeclaration

An XMLSchema Attribute Declaration component.

Instance Methods [hide private]
 
typeDefinition(self)
The simple type definition to which an attribute value must conform.		 source code
 
__init__(self, *args, **kw)
Initialize portions of a component.		 source code
 
__str__(self)
str(x)		 source code
 
isResolved(self)
Determine whether this named component is resolved.		 source code
 
_resolve(self)
Perform whatever steps are required to resolve this component.		 source code
 
_updateFromOther_csc(self, other)
Override fields in this instance with those from the other.		 source code
frozenset
_bindingRequires_vx(self, include_lax)
Attribute declarations require their type.		 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

Inherited from namespace._ComponentDependency_mixin: bindingRequires

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

Inherited from _NamedComponent_mixin: __getnewargs__, __getstate__, __setstate__, bindingNamespace, expandedName, isAnonymous, isDerivationConsistent, isNameEquivalent, isTypeEquivalent, name, targetNamespace

Inherited from _NamedComponent_mixin (private): _NamedComponent_mixin__needAnonymousSupport, _NamedComponent_mixin__pickleAsReference, _anonymousName, _bindsInNamespace, _picklesInArchive, _picklingReference, _prepareForArchive_csc, _schema, _setAnonymousName, _setBindingNamespace, _templateMap

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

Inherited from namespace.resolution._Resolvable_mixin (private): _queueForResolution

Inherited from _Annotated_mixin: annotation

Inherited from _Annotated_mixin (private): _annotationFromDOM

Inherited from _ValueConstraint_mixin: default, fixed, valueConstraint

Inherited from _ValueConstraint_mixin (private): _valueConstraintFromDOM

Inherited from _ScopedDeclaration_mixin: baseDeclaration, scope

Inherited from _ScopedDeclaration_mixin (private): _baseDeclaration, _scopeIsCompatible

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

Class Methods [hide private]
 
CreateBaseInstance(cls, name, schema, std=None)
Create an attribute declaration component for a specified namespace.		 source code
 
CreateFromDOM(cls, node, **kw)
Create an attribute declaration from the given DOM node.		 source code

Inherited from _ScopedDeclaration_mixin: IsValidScope, ScopeIsGlobal, ScopeIsIndeterminate

Static Methods [hide private]

Inherited from _NamedComponent_mixin: __new__

Class Variables [hide private]
  __typeDefinition = None
hash(x)
  __typeAttribute = 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 _NamedComponent_mixin (private): _NamedComponent_mixin__AnonymousCategory, _NamedComponent_mixin__PrivateTransient, _NamedComponent_mixin__anonymousName, _NamedComponent_mixin__bindingNamespace, _NamedComponent_mixin__name, _NamedComponent_mixin__schema, _NamedComponent_mixin__targetNamespace, _NamedComponent_mixin__templateMap

Inherited from namespace.resolution._Resolvable_mixin (private): _TraceResolution

Inherited from _Annotated_mixin (private): _Annotated_mixin__annotation

Inherited from _ValueConstraint_mixin: VC_default, VC_fixed, VC_na

Inherited from _ValueConstraint_mixin (private): _ValueConstraint_mixin__valueConstraint

Inherited from _ScopedDeclaration_mixin: SCOPE_global, XSCOPE_indeterminate

Inherited from _ScopedDeclaration_mixin (private): _ScopedDeclaration_mixin__baseDeclaration

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

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

source code 

Initialize portions of a component.

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__
(inherited documentation)

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)

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

source code 

Create an attribute declaration from the given DOM node.

wxs is a Schema instance within which the attribute is being declared.

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 into which the attribute declaration is placed. It can be SCOPE_global, a complex type definition, or XSCOPE_indeterminate if this is an anonymous declaration within an attribute group. It is a required parameter for this function.

isResolved(self)

source code 

Determine whether this named component is resolved.

Override this in the child class.

Overrides: namespace.resolution._Resolvable_mixin.isResolved
(inherited documentation)

_resolve(self)

source code 

Perform whatever steps are required to resolve this component.

Resolution is performed in the context of the namespace to which the component belongs. Invoking this method may fail to complete the resolution process if the component itself depends on unresolved components. The sole caller of this should be _NamespaceResolution_mixin.resolveDefinitions.

This method is permitted (nay, encouraged) to raise an exception if resolution requires interpreting a QName and the named component cannot be found.

Override this in the child class. In the prefix, if isResolved is true, return right away. If something prevents you from completing resolution, invoke self._queueForResolution() (so it is retried later) and immediately return self. Prior to leaving after successful resolution discard any cached dom node by setting self.__domNode=None.

Returns:
self, whether or not resolution succeeds.
Raises:
Overrides: namespace.resolution._Resolvable_mixin._resolve
(inherited documentation)

_updateFromOther_csc(self, other)

source code 

Override fields in this instance with those from the other.

This method is invoked only by Schema._addNamedComponent, and then only when a built-in type collides with a schema-defined type. Material like facets is not (currently) held in the built-in copy, so the DOM information is copied over to the built-in STD, which is subsequently re-resolved.

Returns self.

Overrides: _Annotated_mixin._updateFromOther_csc

_bindingRequires_vx(self, include_lax)

source code 

Attribute declarations require their type.

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

   Home       Trees       Indices       Help   
PyXB hosted on Get PyXB: Python XML Schema Bindings at SourceForge.net. Fast, secure and Free Open Source software downloads
Generated by Epydoc 3.0.1 on Wed Apr 17 03:13:55 2013 http://epydoc.sourceforge.net