Module dev.metaschema.core

Package dev.metaschema.core.metapath.item.node

Interface IDocumentBasedNodeItem

All Superinterfaces:

ICollectionValue, IItem, IMetapathQueryable, INodeItem, INodeItemVisitable, IPathSegment

All Known Subinterfaces:

IDocumentNodeItem, IModuleNodeItem

public interface IDocumentBasedNodeItem
extends INodeItem

Represents a Metapath node item that is associated with a document.

Nested Class Summary

Nested classes/interfaces inherited from interface dev.metaschema.core.metapath.item.node.INodeItem

INodeItem.NodeType

Method Summary

Modifier and Type	Method	Description
default URI	getBaseUri()	Retrieve the base URI of this node.
URI	getDocumentUri()	Get the URI associated with this document.
default IModelNodeItem<?,?>	getParentContentNodeItem()	Retrieve the parent content node item if it exists.
default INodeItem	getParentNodeItem()	Retrieve the parent node item if it exists.
default IAnyAtomicItem	toAtomicItem()	Get the atomic value for the item.

Methods inherited from interface dev.metaschema.core.metapath.item.ICollectionValue

deepEquals, toSignature

Methods inherited from interface dev.metaschema.core.metapath.item.IItem

atomize, contentsAsSequence, flatten, getType, getValue, hasValue, toSequence

Methods inherited from interface dev.metaschema.core.metapath.item.node.INodeItem

accept, ancestor, ancestorOrSelf, descendant, descendantOrSelf, flags, following, followingSibling, format, getFlagByName, getFlags, getLocation, getMetapath, getModelItems, getModelItemsByName, getNodeItemKind, getNodeType, getPathStream, getPosition, getStaticContext, modelItems, preceding, precedingSibling, stringValue

Methods inherited from interface dev.metaschema.core.metapath.item.node.INodeItemVisitable

accept

Methods inherited from interface dev.metaschema.core.metapath.format.IPathSegment

getNodeItem, getPath, toPath

Method Details

getParentContentNodeItem

default IModelNodeItem<?,?> getParentContentNodeItem()

Description copied from interface: INodeItem

Retrieve the parent content node item if it exists. A content node is a non-document node.

Specified by:

getParentContentNodeItem in interface INodeItem

Returns:

the parent content node item, or null if this node item has no known parent content node item

getDocumentUri

@Nullable
URI getDocumentUri()

Get the URI associated with this document.

Returns:

the document's URI or null if unavailable

getBaseUri

default URI getBaseUri()

Description copied from interface: INodeItem

Retrieve the base URI of this node.

The base URI of a node will be in order of preference:

1. the base URI defined on the node
2. the base URI defined on the nearest ancestor node
3. the base URI defined on the document node
4. null if the document node is unknown

Specified by:

getBaseUri in interface INodeItem

Returns:

the base URI or null if it is unknown

getParentNodeItem

default INodeItem getParentNodeItem()

Description copied from interface: INodeItem

Retrieve the parent node item if it exists.

Specified by:

getParentNodeItem in interface INodeItem

Returns:

the parent node item, or null if this node item has no known parent

toAtomicItem

default IAnyAtomicItem toAtomicItem()

Description copied from interface: IItem

Get the atomic value for the item. This may be the same item if the item is an instance of IAnyAtomicItem.

An implementation of item atomization.

Specified by:

toAtomicItem in interface IItem

Returns:

the atomic value or null if the item has no available value