Package pyxb :: Package xmlschema :: Module structures :: Class Annotation |
[hide private]
[frames] | no frames]

# type Annotation

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 --+
                                                    |
                                                   Annotation

An XMLSchema Annotation component.

Instance Methods | [hide private]
applicationInformation(self) | source code
userInformation(self) | source code
__init__(self, **kw) Initialize portions of a component. | source code
asDocString(self) Return the text in a form suitable for embedding in a triple-double-quoted docstring. | source code
text(self) | source code
__str__(self) Return the catenation of all user information elements in the annotation as a single unicode string. | 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._ComponentDependency_mixin` (private): `_bindingRequires_vx` 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`

Class Methods | [hide private]
CreateFromDOM(cls, node, **kw) | source code

Class Variables | [hide private]
| __applicationInformation = `None`
| __userInformation = `None`
| __attributes = `None`
| __RemoveMultiQuote_re = `re.compile(r'""`+`')`
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`

Method Details | [hide private]

### __init__(self, **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: cscRoot.__init__

### asDocString(self) | source code
Return the text in a form suitable for embedding in a triple-double-quoted docstring. Any sequence of two or more double quotes is replaced by a sequence of single quotes that is the same length. Following this, spaces are added at the start and the end as necessary to ensure a double quote does not appear in those positions.

### __str__(self) (Informal representation operator) | source code
Return the catenation of all user information elements in the annotation as a single unicode string. Returns the empty string if there are no user information elements. Overrides: object.__str__