Qt 4.8
|
A delegate class that wraps around a QAbstractXmlNodeModel and provides additional validation specific information. More...
#include <qxsdvalidatedxmlnodemodel_p.h>
Public Types | |
typedef QList< Ptr > | List |
typedef QExplicitlySharedDataPointer< XsdValidatedXmlNodeModel > | Ptr |
Public Types inherited from QAbstractXmlNodeModel | |
typedef QList< Ptr > | List |
A list of smart pointers to instances of QAbstractXmlNodeModel. More... | |
enum | NodeCopySetting { InheritNamespaces = 0x1, PreserveNamespaces = 0x2 } |
typedef QFlags< NodeCopySetting > | NodeCopySettings |
typedef QExplicitlySharedDataPointer< QAbstractXmlNodeModel > | Ptr |
A QExplicitlySharedDataPointer {smart pointer} to an instance of QAbstractXmlNodeModel. More... | |
enum | SimpleAxis { Parent, FirstChild, PreviousSibling, NextSibling } |
Four axes that each contain one node only. More... | |
Public Functions | |
void | addIdIdRefBinding (const QString &id, const NamedSchemaComponent::Ptr &binding) |
XsdAttribute::Ptr | assignedAttribute (const QXmlNodeModelIndex &index) const |
XsdElement::Ptr | assignedElement (const QXmlNodeModelIndex &index) const |
SchemaType::Ptr | assignedType (const QXmlNodeModelIndex &index) const |
virtual QUrl | baseUri (const QXmlNodeModelIndex &ni) const |
Returns the base URI for the node whose index is n. More... | |
virtual QXmlNodeModelIndex::DocumentOrder | compareOrder (const QXmlNodeModelIndex &ni1, const QXmlNodeModelIndex &ni2) const |
This function returns the relative document order for the nodes indexed by ni1 and ni2. More... | |
virtual void | copyNodeTo (const QXmlNodeModelIndex &node, QAbstractXmlReceiver *const receiver, const NodeCopySettings &) const |
virtual QUrl | documentUri (const QXmlNodeModelIndex &ni) const |
Returns the document URI of n. More... | |
virtual QXmlNodeModelIndex | elementById (const QXmlName &NCName) const |
Returns the index of the element identified as id. More... | |
QStringList | idIdRefBindingIds () const |
QSet< NamedSchemaComponent::Ptr > | idIdRefBindings (const QString &id) const |
virtual bool | isDeepEqual (const QXmlNodeModelIndex &ni1, const QXmlNodeModelIndex &ni2) const |
Determines whether ni1 is deep equal to ni2. More... | |
virtual QExplicitlySharedDataPointer< QAbstractXmlForwardIterator< QXmlNodeModelIndex > > | iterate (const QXmlNodeModelIndex &ni, QXmlNodeModelIndex::Axis axis) const |
Performs navigation, starting from ni, by returning an QAbstractXmlForwardIterator that returns nodes the axis emanating from ni. More... | |
virtual QXmlNodeModelIndex::NodeKind | kind (const QXmlNodeModelIndex &ni) const |
Returns a value indicating the kind of node identified by ni. More... | |
virtual QXmlName | name (const QXmlNodeModelIndex &ni) const |
Returns the name of ni. More... | |
virtual QVector< QXmlName > | namespaceBindings (const QXmlNodeModelIndex &n) const |
Returns the in-scope namespaces of n. More... | |
virtual QXmlName::NamespaceCode | namespaceForPrefix (const QXmlNodeModelIndex &ni, const QXmlName::PrefixCode prefix) const |
Returns the namespace URI on ni that corresponds to prefix. More... | |
virtual QVector< QXmlNodeModelIndex > | nodesByIdref (const QXmlName &NCName) const |
Returns the elements and/or attributes that have an IDREF value equal to idref. More... | |
virtual QXmlNodeModelIndex | root (const QXmlNodeModelIndex &n) const |
Returns the root node of the tree that contains the node whose index is n. More... | |
virtual void | sendNamespaces (const QXmlNodeModelIndex &n, QAbstractXmlReceiver *const receiver) const |
virtual QPatternist::ItemIteratorPtr | sequencedTypedValue (const QXmlNodeModelIndex &ni) const |
void | setAssignedAttribute (const QXmlNodeModelIndex &index, const XsdAttribute::Ptr &attribute) |
void | setAssignedElement (const QXmlNodeModelIndex &index, const XsdElement::Ptr &element) |
void | setAssignedType (const QXmlNodeModelIndex &index, const SchemaType::Ptr &type) |
virtual QString | stringValue (const QXmlNodeModelIndex &n) const |
Returns the string value for node n. More... | |
virtual QPatternist::ItemTypePtr | type (const QXmlNodeModelIndex &ni) const |
virtual QVariant | typedValue (const QXmlNodeModelIndex &n) const |
Returns the typed value for node node. More... | |
XsdValidatedXmlNodeModel (const QAbstractXmlNodeModel *model) | |
virtual | ~XsdValidatedXmlNodeModel () |
Public Functions inherited from QAbstractXmlNodeModel | |
virtual void | copyNodeTo (const QXmlNodeModelIndex &node, QAbstractXmlReceiver *const receiver, const NodeCopySettings &) const |
QAbstractXmlNodeModel () | |
Default constructor. More... | |
virtual void | sendNamespaces (const QXmlNodeModelIndex &n, QAbstractXmlReceiver *const receiver) const |
Sends the namespaces declared on n to receiver. More... | |
QSourceLocation | sourceLocation (const QXmlNodeModelIndex &index) const |
Returns the source location for the object with the given index or a default constructed QSourceLocation in case no location information is available. More... | |
virtual | ~QAbstractXmlNodeModel () |
Destructor. More... | |
Public Functions inherited from QSharedData | |
QSharedData () | |
Constructs a QSharedData object with a reference count of 0. More... | |
QSharedData (const QSharedData &) | |
Constructs a QSharedData object with reference count 0. More... | |
Protected Functions | |
virtual QVector< QXmlNodeModelIndex > | attributes (const QXmlNodeModelIndex &element) const |
Returns the attributes of element. More... | |
virtual QXmlNodeModelIndex | nextFromSimpleAxis (SimpleAxis axis, const QXmlNodeModelIndex &origin) const |
When QtXmlPatterns evaluate path expressions, it emulate them through a combination of calls with QSimpleXmlNodeModel::SimpleAxis values. More... | |
Protected Functions inherited from QAbstractXmlNodeModel | |
QXmlNodeModelIndex | createIndex (qint64 data) const |
Creates a node index with data as its internal data. More... | |
QXmlNodeModelIndex | createIndex (void *pointer, qint64 additionalData=0) const |
Creates a node index with pointer and additionalData as its internal data. More... | |
QXmlNodeModelIndex | createIndex (qint64 data, qint64 additionalData) const |
Creates a QXmlNodeModelIndex containing data and additionalData. More... | |
QAbstractXmlNodeModel (QAbstractXmlNodeModelPrivate *d) | |
Additional Inherited Members | |
Public Variables inherited from QSharedData | |
QAtomicInt | ref |
Protected Variables inherited from QAbstractXmlNodeModel | |
QScopedPointer< QAbstractXmlNodeModelPrivate > | d_ptr |
A delegate class that wraps around a QAbstractXmlNodeModel and provides additional validation specific information.
This class represents the input XML document enriched with additional type information that has been assigned during validation.
Definition at line 78 of file qxsdvalidatedxmlnodemodel_p.h.
Definition at line 82 of file qxsdvalidatedxmlnodemodel_p.h.
typedef QExplicitlySharedDataPointer<XsdValidatedXmlNodeModel> QPatternist::XsdValidatedXmlNodeModel::Ptr |
Definition at line 81 of file qxsdvalidatedxmlnodemodel_p.h.
XsdValidatedXmlNodeModel::XsdValidatedXmlNodeModel | ( | const QAbstractXmlNodeModel * | model | ) |
Creates a new validated xml node model.
Definition at line 52 of file qxsdvalidatedxmlnodemodel.cpp.
|
virtual |
Destroys the validated xml node model.
Definition at line 57 of file qxsdvalidatedxmlnodemodel.cpp.
void XsdValidatedXmlNodeModel::addIdIdRefBinding | ( | const QString & | id, |
const NamedSchemaComponent::Ptr & | binding | ||
) |
Adds the attribute or element binding
with the given id
.
Definition at line 200 of file qxsdvalidatedxmlnodemodel.cpp.
Referenced by QPatternist::XsdValidatingInstanceReader::addIdIdRefBinding().
XsdAttribute::Ptr XsdValidatedXmlNodeModel::assignedAttribute | ( | const QXmlNodeModelIndex & | index | ) | const |
Returns the attribute that is assigned to the xml node at index
.
Definition at line 179 of file qxsdvalidatedxmlnodemodel.cpp.
XsdElement::Ptr XsdValidatedXmlNodeModel::assignedElement | ( | const QXmlNodeModelIndex & | index | ) | const |
Returns the element that is assigned to the xml node at index
.
Definition at line 166 of file qxsdvalidatedxmlnodemodel.cpp.
Referenced by QPatternist::XsdValidatingInstanceReader::validateKeyIdentityConstraint().
SchemaType::Ptr XsdValidatedXmlNodeModel::assignedType | ( | const QXmlNodeModelIndex & | index | ) | const |
Returns the type that is assigned to the xml node at index
.
Definition at line 192 of file qxsdvalidatedxmlnodemodel.cpp.
Referenced by QPatternist::XsdValidatingInstanceReader::selectNodeSets().
|
protectedvirtual |
Returns the attributes of element.
The caller guarantees that element is an element in this node model.
Implements QAbstractXmlNodeModel.
Definition at line 156 of file qxsdvalidatedxmlnodemodel.cpp.
|
virtual |
Returns the base URI for the node whose index is n.
The caller guarantees that n is not null
and that it belongs to a node in this node model.
The base URI of a node can be extracted using the fn:base-uri
() function. The base URI is typically used for resolving relative URIs that appear in the node or its children. It is conformant to just return the document URI, although that might not properly reflect the underlying data.
This function maps to the dm:base-uri
accessor, which returns a base URI according to the following:
For document nodes, the base URI and the document URI are the same.
For elements, the base URI is the URI appearing in the element's xml:base
attribute, if present, or it is resolved to the parent element's base URI.
Namespace nodes have no base URI.
The base URI for a processing instruction, comment, attribute, or text node is the base URI of the node's parent element.
The implementation guarantees to return a valid QUrl, or a default constructed QUrl. If a node has no base URI, as in the case where a comment has no parent, a default constructed QUrl is returned.
Implements QAbstractXmlNodeModel.
Definition at line 61 of file qxsdvalidatedxmlnodemodel.cpp.
|
virtual |
This function returns the relative document order for the nodes indexed by ni1 and ni2.
It is used for the Is
operator and for sorting nodes in document order.
The caller guarantees that ni1 and ni2 are not null
and that both identify nodes in this node model.
If ni1 is identical to ni2, QXmlNodeModelIndex::Is is returned. If ni1 precedes ni2 in document order, QXmlNodeModelIndex::Precedes is returned. If ni1 follows ni2 in document order, QXmlNodeModelIndex::Follows is returned.
Implements QAbstractXmlNodeModel.
Definition at line 76 of file qxsdvalidatedxmlnodemodel.cpp.
|
virtual |
Definition at line 146 of file qxsdvalidatedxmlnodemodel.cpp.
|
virtual |
Returns the document URI of n.
The document URI identifies the resource which is the document. For example, the document could be a regular file, e.g., file:/
, or it could be the http://
URL of the location of a file. The document URI is used for resolving URIs and to simply know where the document is.
If the node model maps to a URI in a natural way, return that URI. Otherwise, return the company or product URI. The document URI can be any URI as long as its valid and absolute.
The caller guarantees that n is not null
and that it belongs to this QAbstractXmlNodeModel.
This function maps to the dm:document-uri
accessor, which returns a document URI according to the following:
If n is a document node, return an absolute QUrl containing the document URI, or a default constructed QUrl. The latter signals that no document URI is available for the document node.
For all other nodes, return a default constructed QUrl.
Implements QAbstractXmlNodeModel.
Definition at line 66 of file qxsdvalidatedxmlnodemodel.cpp.
|
virtual |
Returns the index of the element identified as id.
XQuery's id()
function calls this function.
The node index returned will be the element node whose value is of type ID
and equals id, or it will be the element node that has an attribute whose typed value is of type ID
and equals id. If there is no such element, a default constructed QXmlNodeModelIndex instance is returned. The implementor guarantees that if the returned node index is not null, it identifies an element.
It is not sufficient for an attribute or element to merely be called id
. Its value type must also be ID
. However, the reserved name xml:id
is sufficient.
In id, the namespace URI
and the prefix
are undefined, and the local name
is the ID that should be looked up.
Implements QAbstractXmlNodeModel.
Definition at line 136 of file qxsdvalidatedxmlnodemodel.cpp.
QStringList XsdValidatedXmlNodeModel::idIdRefBindingIds | ( | ) | const |
Returns a list of all binding ids.
Definition at line 205 of file qxsdvalidatedxmlnodemodel.cpp.
Referenced by QPatternist::XsdValidatingInstanceReader::read().
QSet< NamedSchemaComponent::Ptr > XsdValidatedXmlNodeModel::idIdRefBindings | ( | const QString & | id | ) | const |
Returns the set of bindings with the given id
.
Definition at line 210 of file qxsdvalidatedxmlnodemodel.cpp.
Referenced by QPatternist::XsdValidatingInstanceReader::addIdIdRefBinding().
|
virtual |
Determines whether ni1 is deep equal to ni2.
isDeepEqual() is defined as evaluating the expression fn:deep-equal
($n1, $n2) where $n1
is ni1 and $n1
is ni2. This function is associative, meaning the same value is returned regardless of if isDeepEqual() is invoked with ni1 as first argument or second. It is guaranteed that ni1 and ni2 are nodes, as opposed to the definition of fn:deep-equal
().
Returns true if ni1 is deep-equal to ni2, otherwise false
Reimplemented from QAbstractXmlNodeModel.
Definition at line 121 of file qxsdvalidatedxmlnodemodel.cpp.
|
virtual |
Performs navigation, starting from ni, by returning an QAbstractXmlForwardIterator that returns nodes the axis emanating from ni.
The implementation returns the nodes on the axis, without duplicates and in axis order. This means that if axis is a reverse axis, which is the case for the parent
, ancestor
, ancestor-or-self
, preceding
, and preceding-sibling
, the nodes are delivered in reverse document order. Otherwise the nodes are delivered in document order.
The implementor guarantees that the nodes delivered for the axes are consistent with the XPath Data Model. This just implies common sense, e.g., The child axis for a comment node can't contain any children; a document node can't be a child of an element, etc. Attributes aren't considered children of an element, but are only available on AxisAttribute.
The value past in axis is not guaranteed based on what is used in a query. QtXmlPatterns may call this function arbitrarily with any value for axis. This is because QtXmlPatterns may rewrite queries to be more efficient, using axes in different ways from the original query.
QAbstractXmlNodeModel::Axis has a good overview of the axes and what they select.
The caller guarantees that ni is not null
and that it belongs to this QAbstractXmlNodeModel instance.
Implementing iterate() can involve significant work, since it requires different iterators for all the axes used. In the worst case, it could require writing as many QAbstractXmlForwardIterator subclasses as there are axes, but the number can often be reduced with clever use of lists and template classes. It is better to use or subclass QSimpleXmlNodeModel, which makes it easier to write the node navigation code without loss of efficiency or flexibility.
Reimplemented from QAbstractXmlNodeModel.
Definition at line 101 of file qxsdvalidatedxmlnodemodel.cpp.
|
virtual |
Returns a value indicating the kind of node identified by ni.
The caller guarantees that ni is not null and that it identifies a node in this node model. This function maps to the dm:node-kind
() accessor.
Implements QAbstractXmlNodeModel.
Definition at line 71 of file qxsdvalidatedxmlnodemodel.cpp.
Referenced by QPatternist::XsdValidatingInstanceReader::validateKeyIdentityConstraint().
|
virtual |
Returns the name of ni.
The caller guarantees that ni is not null
and that it belongs to this QAbstractXmlNodeModel.
If a node does not have a name, e.g., comment nodes, a null QXmlName is returned. QXmlNames must be created with the instance of QXmlQuery that is being used for evaluating queries using this QAbstractXmlNodeModel.
This function maps to the dm:node-name
() accessor.
If ni is a processing instruction, a QXmlName is returned with the local name as the target name and the namespace URI and prefix both empty.
Implements QAbstractXmlNodeModel.
Definition at line 86 of file qxsdvalidatedxmlnodemodel.cpp.
|
virtual |
Returns the in-scope namespaces of n.
The caller guarantees that n is not null
and that it belongs to this QAbstractXmlNodeModel.
This function corresponds to the dm:namespace-nodes
accessor.
The returned vector of namespace declarations includes namespaces of the ancestors of n.
The caller guarantees that n is an Element that belongs to this QAbstractXmlNodeModel.
Implements QAbstractXmlNodeModel.
Definition at line 131 of file qxsdvalidatedxmlnodemodel.cpp.
|
virtual |
Returns the namespace URI on ni that corresponds to prefix.
If prefix is StandardPrefixes::empty, the namespace URI for the default namespace is returned.
The default implementation use namespaceBindings(), in a straight forward manner.
If no namespace exists for prefix, NamespaceResolver::NoBinding is returned.
The caller guarantees to only call this function for element nodes.
Reimplemented from QAbstractXmlNodeModel.
Definition at line 116 of file qxsdvalidatedxmlnodemodel.cpp.
|
protectedvirtual |
When QtXmlPatterns evaluate path expressions, it emulate them through a combination of calls with QSimpleXmlNodeModel::SimpleAxis values.
Therefore, the implementation of this function must return the node, if any, that appears on the axis emanating from the origin.
If no such node is available, a default constructed QXmlNodeModelIndex is returned.
QSimpleXmlNodeModel eliminates the need to handle redundant corner cases by guaranteeing that it will never ask for:
A typical implementation performs a switch
on the value of axis:
Implements QAbstractXmlNodeModel.
Definition at line 151 of file qxsdvalidatedxmlnodemodel.cpp.
|
virtual |
Returns the elements and/or attributes that have an IDREF
value equal to idref.
XQuery's idref()
function calls this function.
The implementor guarantees that the nodes identified by the returned indexes are elements or attributes.
It is not sufficient for an attribute or element to merely be called idref
. It must also be of type IDREF
. Elements must be typed as xs:IDREF
or xs:IDREFS
, or, in the case of attributes, as IDREF
or IDREFS
in the schema.
In idref, the namespace URI
and the prefix
are undefined, and the local name
is the ID that should be looked up.
Implements QAbstractXmlNodeModel.
Definition at line 141 of file qxsdvalidatedxmlnodemodel.cpp.
|
virtual |
Returns the root node of the tree that contains the node whose index is n.
The caller guarantees that n is not null
and that it identifies a node in this node model.
If n identifies a node that is a direct child of the root, parent() would return the same QXmlNodeModelIndex returned by this function.
Implements QAbstractXmlNodeModel.
Definition at line 81 of file qxsdvalidatedxmlnodemodel.cpp.
|
virtual |
Definition at line 126 of file qxsdvalidatedxmlnodemodel.cpp.
|
virtual |
Reimplemented from QAbstractXmlNodeModel.
Definition at line 106 of file qxsdvalidatedxmlnodemodel.cpp.
void XsdValidatedXmlNodeModel::setAssignedAttribute | ( | const QXmlNodeModelIndex & | index, |
const XsdAttribute::Ptr & | attribute | ||
) |
Sets the attribute
that is assigned to the xml node at index
.
Definition at line 174 of file qxsdvalidatedxmlnodemodel.cpp.
Referenced by QPatternist::XsdValidatingInstanceReader::validateAttribute().
void XsdValidatedXmlNodeModel::setAssignedElement | ( | const QXmlNodeModelIndex & | index, |
const XsdElement::Ptr & | element | ||
) |
Sets the element
that is assigned to the xml node at index
.
Definition at line 161 of file qxsdvalidatedxmlnodemodel.cpp.
Referenced by QPatternist::XsdValidatingInstanceReader::read().
void XsdValidatedXmlNodeModel::setAssignedType | ( | const QXmlNodeModelIndex & | index, |
const SchemaType::Ptr & | type | ||
) |
Sets the type
that is assigned to the xml node at index
.
Definition at line 187 of file qxsdvalidatedxmlnodemodel.cpp.
Referenced by QPatternist::XsdValidatingInstanceReader::validate(), QPatternist::XsdValidatingInstanceReader::validateAttribute(), QPatternist::XsdValidatingInstanceReader::validateElementComplexType(), and QPatternist::XsdValidatingInstanceReader::validateElementSimpleType().
|
virtual |
Returns the string value for node n.
The caller guarantees that n is not null
and that it belong to this QAbstractXmlNodeModel instance.
This function maps to the dm:string-value
() accessor, which the specification completely specifies. Here's a summary:
For processing instructions, the string value is the data section(excluding any whitespace appearing between the name and the data).
For text nodes, the string value equals the text node.
For comments, the content of the comment
For elements, the concatenation of all text nodes that are descendants. Note, this is not only the children, but the childrens' childrens' text nodes, and so forth.
For document nodes, the concatenation of all text nodes in the document.
Implements QAbstractXmlNodeModel.
Definition at line 91 of file qxsdvalidatedxmlnodemodel.cpp.
Referenced by QPatternist::XsdValidatingInstanceReader::selectNodeSets().
|
virtual |
Reimplemented from QAbstractXmlNodeModel.
Definition at line 111 of file qxsdvalidatedxmlnodemodel.cpp.
|
virtual |
Returns the typed value for node node.
The typed value is an atomic value, which an element or attribute contains.
The caller guarantees that node is either an element or an attribute. The implementor guarantees that the returned QVariant has a value which is supported in XQuery. It cannot be an arbitrary QVariant value. The implementor also guarantees that stringValue() returns a lexical representation of typedValue()(this is guaranteed by QSimpleXmlNodeModel::stringValue()).
If the return QVariant is a default constructed variant, it signals that node has no typed value.
Implements QAbstractXmlNodeModel.
Definition at line 96 of file qxsdvalidatedxmlnodemodel.cpp.
|
private |
Definition at line 169 of file qxsdvalidatedxmlnodemodel_p.h.
Referenced by assignedAttribute(), and setAssignedAttribute().
|
private |
Definition at line 168 of file qxsdvalidatedxmlnodemodel_p.h.
Referenced by assignedElement(), and setAssignedElement().
|
private |
Definition at line 170 of file qxsdvalidatedxmlnodemodel_p.h.
Referenced by assignedType(), and setAssignedType().
|
private |
Definition at line 171 of file qxsdvalidatedxmlnodemodel_p.h.
Referenced by addIdIdRefBinding(), idIdRefBindingIds(), and idIdRefBindings().
|
private |
Definition at line 167 of file qxsdvalidatedxmlnodemodel_p.h.
Referenced by attributes(), baseUri(), compareOrder(), copyNodeTo(), documentUri(), elementById(), isDeepEqual(), iterate(), kind(), name(), namespaceBindings(), namespaceForPrefix(), nextFromSimpleAxis(), nodesByIdref(), root(), sendNamespaces(), sequencedTypedValue(), stringValue(), type(), and typedValue().