com.trolltech.qt.xmlpatterns
Class QXmlItem

java.lang.Object
  extended by com.trolltech.qt.internal.QSignalEmitterInternal
      extended by com.trolltech.qt.QSignalEmitter
          extended by com.trolltech.qt.QtJambiObject
              extended by com.trolltech.qt.xmlpatterns.QXmlItem
All Implemented Interfaces:
QtJambiInterface, java.lang.Cloneable

public class QXmlItem
extends QtJambiObject
implements java.lang.Cloneable

The QXmlItem class contains either an XML node or an atomic value. In XQuery, all expressions evaluate to a sequence of items, where each item is either an XML node or an atomic value. The query in the following snippet evaluates to sequence of five items.

<aNode/>,
xs:base64Binary("FFFF"),
current-date(),
3e3, (: A floating point value :)
attribute {"name"} {()}
The five items are: An element, an atomic value (binary data encoded in base64), a date, a float, and an attribute.

QXmlItem is the class that represents these XQuery items in the QtXmlPatterns API. A non-null instance of QXmlItem is either a node or an atomic value. Calling isNode() or isAtomicValue() tells you which it is. Atomic values are represented elsewhere in the Qt API as instances of QVariant, and an instance of QXmlItem that represents an atomic value can be converted to a QVariant by calling toAtomicValue(). A QXmlItem that wraps a node is represented elsewhere as an instance of QXmlNodeModelIndex. A node QXmlItem can be converted to a QXmlNodeModelIndex by calling toNodeModelIndex().

A default constructed QXmlItem instance is neither a node nor an atomic value. It is considered null, in which case isNull() returns true.

An instance of QXmlItem will be left dangling if the XML node model it refers to is deleted, if it is a QXmlNodeModelIndex.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
QSignalEmitter.AbstractSignal, QSignalEmitter.PrivateSignal0, QSignalEmitter.PrivateSignal1, QSignalEmitter.PrivateSignal2, QSignalEmitter.PrivateSignal3, QSignalEmitter.PrivateSignal4, QSignalEmitter.PrivateSignal5, QSignalEmitter.PrivateSignal6, QSignalEmitter.PrivateSignal7, QSignalEmitter.PrivateSignal8, QSignalEmitter.PrivateSignal9, QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9
 
Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal
 
Field Summary
 
Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
currentSender
 
Constructor Summary
QXmlItem()
          Constructs a null QXmlItem that is neither a node nor an atomic value.
QXmlItem(java.lang.Object atomicValue)
          Constructs an atomic value QXmlItem with atomicValue.
QXmlItem(QXmlItem other)
          The copy constructor constructs a copy of other.
QXmlItem(QXmlNodeModelIndex node)
          Constructs a node QXmlItem that is a copy of node.
 
Method Summary
 QXmlItem clone()
          This method is reimplemented for internal reasons
 boolean isAtomicValue()
          Returns true if this item is an atomic value.
 boolean isNode()
          Returns true if this item is a Node.
 boolean isNull()
          Returns true if this QXmlItem is neither a node nor an atomic value.
 java.lang.Object toAtomicValue()
          If this QXmlItem represents an atomic value, it is converted to an appropriate QVariant and returned.
 QXmlNodeModelIndex toNodeModelIndex()
          If this QXmlItem represents a node, it returns the item as a QXmlNodeModelIndex.
 
Methods inherited from class com.trolltech.qt.QtJambiObject
dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr
 
Methods inherited from class com.trolltech.qt.QSignalEmitter
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread
 
Methods inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
__qt_signalInitialization
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.trolltech.qt.QtJambiInterface
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership
 

Constructor Detail

QXmlItem

public QXmlItem()
Constructs a null QXmlItem that is neither a node nor an atomic value. isNull() returns true for a default constructed instance.


QXmlItem

public QXmlItem(java.lang.Object atomicValue)
Constructs an atomic value QXmlItem with atomicValue.

See also:
isAtomicValue().


QXmlItem

public QXmlItem(QXmlItem other)
The copy constructor constructs a copy of other.


QXmlItem

public QXmlItem(QXmlNodeModelIndex node)
Constructs a node QXmlItem that is a copy of node.

See also:
isNode().

Method Detail

isAtomicValue

public final boolean isAtomicValue()
Returns true if this item is an atomic value. Returns false if it is a node or null.

See also:
isNull(), and isNode().


isNode

public final boolean isNode()
Returns true if this item is a Node. Returns false if it is an atomic value or null.

See also:
isNull(), and isAtomicValue().


isNull

public final boolean isNull()
Returns true if this QXmlItem is neither a node nor an atomic value. Default constructed instances of QXmlItem are null.


toAtomicValue

public final java.lang.Object toAtomicValue()
If this QXmlItem represents an atomic value, it is converted to an appropriate QVariant and returned. If this QXmlItem is not an atomic value, the return value is a default constructed QVariant. You can call isAtomicValue() to test whether the item is an atomic value.

See also:
isAtomicValue().


toNodeModelIndex

public final QXmlNodeModelIndex toNodeModelIndex()
If this QXmlItem represents a node, it returns the item as a QXmlNodeModelIndex. If this QXmlItem is not a node, the return value is undefined. You can call isNode() to test whether the item is a node.

See also:
isNode().


clone

public QXmlItem clone()
This method is reimplemented for internal reasons

Overrides:
clone in class java.lang.Object