Class Poco::XSD::Types::Element

File Information

Library: XSD/Types
Package: XSDElements
Header: Poco/XSD/Types/Element.h

Description

This class represents an element definition in an XML Schema.

Inheritance

Direct Base Classes: OrderContent

All Base Classes: Poco::RefCountedObject, AnnotatedObject, Content, OrderContent, Visitable

Known Derived Classes: ElementTypeRef, ElementRef, AbstractElementImpl, ElementImpl

Member Summary

Member Functions: fixup, getAbstract, getBlockExtension, getBlockRestriction, getBlockSubstitution, getDefault, getFinalExtension, getFinalRestriction, getFixed, getNillable, getQualified, getSubstitutionGroup, hasDefault, hasFixed, hasSubstitutionGroup, iterator, name, nameSpace, setAbstract, setBlockAll, setBlockExtension, setBlockRestriction, setBlockSubstitution, setDefault, setFinalAll, setFinalExtension, setFinalRestriction, setFixed, setName, setNillable, setQualified, setSubstitutionGroup, type

Inherited Functions: accept, addAnnotation, duplicate, fixup, getAnnotations, getId, getMaxOccurs, getMinOccurs, id, iterator, referenceCount, release, setId, setMaxOccurs, setMinOccurs, types

Types Aliases

Ptr

using Ptr = Poco::AutoPtr < Element >;

Constructors

Element

Element();

Creates the Element.

Element

Element(
    const std::string & id,
    Poco::UInt32 minOccurs,
    Poco::UInt32 maxOccurs
);

Creates the Element.

Destructor

~Element

virtual ~Element();

Destroys the Element.

Member Functions

fixup

virtual void fixup() = 0;

Fixes the element definition. Should be called once for each element after the whole XSD file was parsed.

See also: Poco::XSD::Types::Content::fixup()

getAbstract

virtual bool getAbstract() const = 0;

getBlockExtension

virtual bool getBlockExtension() const = 0;

getBlockRestriction

virtual bool getBlockRestriction() const = 0;

getBlockSubstitution

virtual bool getBlockSubstitution() const = 0;

getDefault

virtual const std::string & getDefault() const = 0;

Returns the default value of the element. Empty if no one exists.

getFinalExtension

virtual bool getFinalExtension() const = 0;

getFinalRestriction

virtual bool getFinalRestriction() const = 0;

getFixed

virtual const std::string & getFixed() const = 0;

The fixed value of the element. Empty if no one exists.

getNillable

virtual bool getNillable() const = 0;

getQualified

virtual bool getQualified() const = 0;

Returns true if the element is in qualified form or not

getSubstitutionGroup

virtual const QName & getSubstitutionGroup() const = 0;

hasDefault

virtual bool hasDefault() const = 0;

hasFixed

virtual bool hasFixed() const = 0;

hasSubstitutionGroup

virtual bool hasSubstitutionGroup() const = 0;

iterator

OrderIterator iterator() const;

Returns an iterator for iterating over the element's content.

See also: Poco::XSD::Types::Content::iterator()

name

virtual const std::string & name() const = 0;

nameSpace

virtual const std::string & nameSpace() const = 0;

setAbstract

virtual void setAbstract(
bool abstr
) = 0;

setBlockAll

virtual void setBlockAll(
bool block
) = 0;

setBlockExtension

virtual void setBlockExtension(
bool block
) = 0;

setBlockRestriction

virtual void setBlockRestriction(
bool block
) = 0;

setBlockSubstitution

virtual void setBlockSubstitution(
bool block
) = 0;

setDefault

virtual void setDefault(
const std::string & value
) = 0;

Sets the default value of the element.

setFinalAll

virtual void setFinalAll(
bool fin
) = 0;

setFinalExtension

virtual void setFinalExtension(
bool fin
) = 0;

setFinalRestriction

virtual void setFinalRestriction(
bool fin
) = 0;

setFixed

virtual void setFixed(
const std::string & value
) = 0;

setName

virtual void setName(
const std::string & name
) = 0;

setNillable

virtual void setNillable(
bool nillable
) = 0;

setQualified

virtual void setQualified(
bool qual
) = 0;

setSubstitutionGroup

virtual void setSubstitutionGroup(
const QName & ref
) = 0;

type

virtual const Type & type() const = 0;