Module gov.nist.secauto.metaschema.core

Package gov.nist.secauto.metaschema.core.metapath.item.node

Interface IRootAssemblyNodeItem

All Superinterfaces:

IAssemblyNodeItem, IDefinitionNodeItem<IAssemblyDefinition,IAssemblyInstance>, IItem, IModelNodeItem<IAssemblyDefinition,IAssemblyInstance>, INodeItem, INodeItemVisitable, IPathSegment

public interface IRootAssemblyNodeItem
extends IAssemblyNodeItem

A marker interface used to expose root node functionality for an assembly node that has root information.

Method Summary

Modifier and Type	Method	Description
default String	format(IPathFormatter formatter)	Generate a path for this node in the directed node graph, using the provided path formatter.
IDocumentNodeItem	getDocumentNodeItem()	Get the parent document node item for this root.
default IAssemblyInstance	getInstance()	Retrieve the instance associated with this path segment.
default String	getName()	Get the name of this node.
default IRootAssemblyNodeItem	getNodeItem()	Get the value associated with the path segment.
default IAssemblyNodeItem	getParentContentNodeItem()	Retrieve the parent content node item if it exists.
default IDocumentNodeItem	getParentNodeItem()	Retrieve the parent node item if it exists.
default int	getPosition()	Retrieve the relative position of this node relative to sibling nodes.

Methods inherited from interface gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem

accept, getBaseUri, getNodeItemType

Methods inherited from interface gov.nist.secauto.metaschema.core.metapath.item.node.IDefinitionNodeItem

getDefinition

Methods inherited from interface gov.nist.secauto.metaschema.core.metapath.item.IItem

getValue, hasValue

Methods inherited from interface gov.nist.secauto.metaschema.core.metapath.item.node.INodeItem

ancestor, ancestorOrSelf, descendant, descendantOrSelf, flags, getFlagByName, getFlags, getMetapath, getModelItems, getModelItemsByName, getPathStream, modelItems

Methods inherited from interface gov.nist.secauto.metaschema.core.metapath.format.IPathSegment

getPath, toPath

Method Detail

getName

default String getName()

Get the name of this node.

This overrides the default behavior using the root name for the assembly.

Specified by:

getName in interface IDefinitionNodeItem<IAssemblyDefinition,IAssemblyInstance>

Returns:

the item's name

getDocumentNodeItem

@NonNull
IDocumentNodeItem getDocumentNodeItem()

Get the parent document node item for this root.

Returns:

the parent document item

getParentNodeItem

@NonNull
default IDocumentNodeItem getParentNodeItem()

Description copied from interface: IModelNodeItem

Retrieve the parent node item if it exists.

The parent can be an assembly or a document (in the case of a root assembly.

Specified by:

getParentNodeItem in interface IModelNodeItem<IAssemblyDefinition,IAssemblyInstance>

Specified by:

getParentNodeItem in interface INodeItem

Returns:

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

getParentContentNodeItem

default IAssemblyNodeItem 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 IModelNodeItem<IAssemblyDefinition,IAssemblyInstance>

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

getInstance

default IAssemblyInstance getInstance()

Description copied from interface: IDefinitionNodeItem

Retrieve the instance associated with this path segment.

Specified by:

getInstance in interface IDefinitionNodeItem<IAssemblyDefinition,IAssemblyInstance>

Returns:

the instance of the segment, or null if it doesn't have one

getNodeItem

default IRootAssemblyNodeItem getNodeItem()

Description copied from interface: IPathSegment

Get the value associated with the path segment.

Specified by:

getNodeItem in interface IAssemblyNodeItem

Specified by:

getNodeItem in interface IPathSegment

Returns:

the value or if no value is associated with this path segment

getPosition

default int getPosition()

Description copied from interface: IModelNodeItem

Retrieve the relative position of this node relative to sibling nodes.

A singleton item in a sequence will have a position value of 1.

The value 1 is used as the starting value to align with the XPath specification.

Specified by:

getPosition in interface IModelNodeItem<IAssemblyDefinition,IAssemblyInstance>

Returns:

a positive integer value designating this instance's position within a collection

format

default String format(@NonNull
                      IPathFormatter formatter)

Description copied from interface: INodeItem

Generate a path for this node in the directed node graph, using the provided path formatter.

Specified by:

format in interface IAssemblyNodeItem

Specified by:

format in interface INodeItem

Specified by:

format in interface IPathSegment

Parameters:

formatter - the path formatter

Returns:

a textual representation of the path segment