|  | 
 XSElementDeclaration Class ReferenceThis class describes all properties of a Schema Element Declaration component.  
More...
Inheritance diagram for XSElementDeclaration:  [legend]List of all members. 
|  |  | 
 Public Member Functions |  |  |  |  | XSElementDeclaration (SchemaElementDecl *const schemaElementDecl, XSTypeDefinition *const typeDefinition, XSElementDeclaration *const substitutionGroupAffiliation, XSAnnotation *const annot, XSNamedMap< XSIDCDefinition > *const identityConstraints, XSModel *const xsModel, XSConstants::SCOPE elemScope=XSConstants::SCOPE_ABSENT, XSComplexTypeDefinition *const enclosingTypeDefinition=0, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager) |  |  | The default constructor. 
 |  |  |  |  | ~XSElementDeclaration () |  |  |  | const XMLCh * | getName () |  |  | The name of type NCNameof this declaration as defined in XML Namespaces.
 |  | const XMLCh * | getNamespace () |  |  | The [target namespace] of this object, or nullif it is unspecified.
 |  | XSNamespaceItem * | getNamespaceItem () |  |  | A namespace schema information item corresponding to the target namespace of the component, if it's globally declared; or null otherwise. 
 |  |  |  | XSTypeDefinition * | getTypeDefinition () const |  |  | [type definition]: either a simple type definition or a complex type definition. 
 |  | XSConstants::SCOPE | getScope () const |  |  | Optional. 
 |  | XSComplexTypeDefinition * | getEnclosingCTDefinition () const |  |  | The complex type definition for locally scoped declarations (see scope).
 |  | XSConstants::VALUE_CONSTRAINT | getConstraintType () const |  |  | [Value constraint]: one of VC_NONE, VC_DEFAULT, VC_FIXED.
 |  | const XMLCh * | getConstraintValue () |  |  | [Value constraint]: the actual value with respect to the [type definition]. 
 |  | bool | getNillable () const |  |  | If nillable is true, then an element may also be valid if it carries the namespace qualified attribute with local name nilfrom namespacehttp://www.w3.org/2001/XMLSchema-instanceand valuetrue(xsi:nil) even if it has no text or element content despite acontent typewhich would otherwise require content.
 |  | XSNamedMap< XSIDCDefinition > * | getIdentityConstraints () |  |  | identity-constraint definitions: a set of constraint definitions. 
 |  | XSElementDeclaration * | getSubstitutionGroupAffiliation () const |  |  | [substitution group affiliation]: optional. 
 |  | bool | isSubstitutionGroupExclusion (XSConstants::DERIVATION_TYPE exclusion) |  |  | Convenience method. 
 |  | short | getSubstitutionGroupExclusions () const |  |  | [substitution group exclusions]: the returned value is a bit combination of the subset of { DERIVATION_EXTENSION, DERIVATION_RESTRICTION} orDERIVATION_NONE.
 |  | bool | isDisallowedSubstitution (XSConstants::DERIVATION_TYPE disallowed) |  |  | Convenience method. 
 |  | short | getDisallowedSubstitutions () const |  |  | [disallowed substitutions]: the returned value is a bit combination of the subset of { DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION} corresponding to substitutions disallowed by thisXSElementDeclarationorDERIVATION_NONE.
 |  | bool | getAbstract () const |  |  | {abstract} A boolean. 
 |  | XSAnnotation * | getAnnotation () const |  |  | Optional. 
 |  |  |  | void | setTypeDefinition (XSTypeDefinition *typeDefinition) |  | 
 Protected Attributes |  | short | fDisallowedSubstitutions |  | short | fSubstitutionGroupExclusions |  | XSConstants::SCOPE | fScope |  | SchemaElementDecl * | fSchemaElementDecl |  | XSTypeDefinition * | fTypeDefinition |  | XSComplexTypeDefinition * | fEnclosingTypeDefinition |  | XSElementDeclaration * | fSubstitutionGroupAffiliation |  | XSAnnotation * | fAnnotation |  | XSNamedMap< XSIDCDefinition > * | fIdentityConstraints |  | 
 Friends |  | class | XSObjectFactory |  
 Detailed DescriptionThis class describes all properties of a Schema Element Declaration component.
This is *always* owned by the validator /parser object from which it is obtained. 
 
 
 Constructor & Destructor Documentation
 
  
    |  | 
The default constructor. 
 
 Parameters:
  
    |  | schemaElementDecl |  |  |  | typeDefinition |  |  |  | substitutionGroupAffiliation |  |  |  | annot |  |  |  | identityConstraints |  |  |  | xsModel |  |  |  | elemScope |  |  |  | enclosingTypeDefinition |  |  |  | manager | The configurable memory manager | 
 |  
 
 Member Function Documentation
 
  
    | 
        
          | bool XSElementDeclaration::getAbstract | ( |  | ) | const |  |  
 
  
    | 
        
          | XSAnnotation * XSElementDeclaration::getAnnotation | ( |  | ) | const |  |  
 
  
    |  | 
[Value constraint]: one of VC_NONE, VC_DEFAULT, VC_FIXED. 
     |  
 
  
    | 
        
          | const XMLCh* XSElementDeclaration::getConstraintValue | ( |  | ) |  |  |  
  
    |  | 
[Value constraint]: the actual value with respect to the [type definition]. 
 
     |  
 
  
    | 
        
          | short XSElementDeclaration::getDisallowedSubstitutions | ( |  | ) | const |  |  
  
    |  | 
[disallowed substitutions]: the returned value is a bit combination of the subset of { DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION} corresponding to substitutions disallowed by thisXSElementDeclarationorDERIVATION_NONE. 
     |  
 
  
    |  | 
The complex type definition for locally scoped declarations (see scope). 
     |  
 
  
    |  | 
identity-constraint definitions: a set of constraint definitions. 
 
     |  
 
  
    | 
        
          | const XMLCh* XSElementDeclaration::getName | ( |  | ) |  [virtual] |  |  
  
    |  | 
The name of type NCNameof this declaration as defined in XML Namespaces. 
 
Reimplemented from XSObject.     |  
 
  
    | 
        
          | const XMLCh* XSElementDeclaration::getNamespace | ( |  | ) |  [virtual] |  |  
  
    |  | 
The [target namespace] of this object, or nullif it is unspecified. 
 
Reimplemented from XSObject.     |  
 
  
    |  | 
A namespace schema information item corresponding to the target namespace of the component, if it's globally declared; or null otherwise. 
 
 
Reimplemented from XSObject.     |  
 
  
    | 
        
          | bool XSElementDeclaration::getNillable | ( |  | ) | const |  |  
  
    |  | 
If nillable is true, then an element may also be valid if it carries the namespace qualified attribute with local name nilfrom namespacehttp://www.w3.org/2001/XMLSchema-instanceand valuetrue(xsi:nil) even if it has no text or element content despite acontent typewhich would otherwise require content. 
     |  
 
  
    |  | 
Optional. 
 
One of SCOPE_GLOBAL,SCOPE_LOCAL, orSCOPE_ABSENT. If the scope is local, then theenclosingCTDefinitionis present. |  
 
  
    |  | 
[substitution group affiliation]: optional. 
 
A top-level element definition.      |  
 
  
    | 
        
          | short XSElementDeclaration::getSubstitutionGroupExclusions | ( |  | ) | const |  |  
  
    |  | 
[substitution group exclusions]: the returned value is a bit combination of the subset of { DERIVATION_EXTENSION, DERIVATION_RESTRICTION} orDERIVATION_NONE. 
     |  
 
  
    |  | 
[type definition]: either a simple type definition or a complex type definition. 
 
     |  
 
  
    |  | 
Convenience method. 
 
Check if disallowedis a disallowed substitution for this element declaration. Parameters:
  
    |  | disallowed | { DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION} orDERIVATION_NONE. Represents a block set for the element. | 
 Returns:True if disallowedis a part of the substitution group exclusion subset.
 |  
 
  
    |  | 
Convenience method. 
 
Check if exclusionis a substitution group exclusion for this element declaration. Parameters:
  
    |  | exclusion | DERIVATION_EXTENSION, DERIVATION_RESTRICTIONorDERIVATION_NONE. Represents final set for the element. | 
 Returns:True if exclusionis a part of the substitution group exclusion subset.
 |  
 
  
    | 
        
          | void XSElementDeclaration::setTypeDefinition | ( | XSTypeDefinition * | typeDefinition | ) |  |  |  
 Friends And Related Function Documentation
 
  
    | 
        
          | friend class XSObjectFactory  [friend] |  |  
 Member Data Documentation
 
 
 
 
 
 
 
 
 The documentation for this class was generated from the following file:
 |