Saxon.Api

 

 

Saxon.Api

Class XdmNodeKind

public class XdmNodeKind
extends XdmItemType

Instances of XdmNodeKind represent the item types denoted in XPath as document-node(), element(), attribute(), text(), and so on. These are all represented by singular named instances.

Field Summary
static XdmNodeKind Attribute

The item type attribute()

static XdmNodeKind Comment

The item type comment()

static XdmNodeKind Document

The item type document-node()

static XdmNodeKind Element

The item type element()

static XdmNodeKind Namespace

The item type namespace-node()

static XdmNodeKind ProcessingInstruction

The item type processing-instruction()

static XdmNodeKind Text

The item type text()

 

Method Summary
 bool Equals (object other)

Ask whether this node kind is the same as another

static XdmNodeKind ForNode (XdmNode node)

Get the item type representing the node kind of a supplied node

static XdmNodeKind ForNodeType (XmlNodeType type)

Get the item type corresponding to an XmlNodeType as defined in the System.Xml package

 int GetHashCode ()

Get a hash code

 bool Matches (XdmItem item)

Determine whether this item type matches a given item.

 bool Subsumes (XdmItemType other)

Determine whether this ItemType subsumes another ItemType. Specifically, A.subsumes(B) is true if every value that matches the ItemType B also matches the ItemType A.

 

Field Detail

Attribute

public static readonly XdmNodeKind Attribute

The item type attribute()

Comment

public static readonly XdmNodeKind Comment

The item type comment()

Document

public static readonly XdmNodeKind Document

The item type document-node()

Element

public static readonly XdmNodeKind Element

The item type element()

Namespace

public static readonly XdmNodeKind Namespace

The item type namespace-node()

ProcessingInstruction

public static readonly XdmNodeKind ProcessingInstruction

The item type processing-instruction()

Text

public static readonly XdmNodeKind Text

The item type text()

Method Detail

Equals

public override bool Equals(object other)

Ask whether this node kind is the same as another

Parameters:

other - The other object

Returns:

True if the argument is the same node kind.

ForNode

public static XdmNodeKind ForNode(XdmNode node)

Get the item type representing the node kind of a supplied node

Parameters:

node - The node whose node kind is required

Returns:

The relevant node kind

ForNodeType

public static XdmNodeKind ForNodeType(XmlNodeType type)

Get the item type corresponding to an XmlNodeType as defined in the System.Xml package

Parameters:

type - The XmlNodeType to be converted

Returns:

The corresponding XdmNodeKind

GetHashCode

public override int GetHashCode()

Get a hash code

Returns:

A suitable hash code

Matches

public override bool Matches(XdmItem item)

Determine whether this item type matches a given item.

Parameters:

item - item the item to be tested against this item type

Returns:

true if the item matches this item type, false if it does not match.

Subsumes

public override bool Subsumes(XdmItemType other)

Determine whether this ItemType subsumes another ItemType. Specifically, A.subsumes(B) is true if every value that matches the ItemType B also matches the ItemType A.

Parameters:

other - the other ItemType

Returns:

true if this ItemType subsumes the other ItemType. This includes the case where A and B represent the same ItemType.