Module gov.nist.secauto.metaschema.core

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

Interface IModuleNodeItem

All Superinterfaces:

IDocumentNodeItem, IItem, INodeItem, INodeItemVisitable, IPathSegment

public interface IModuleNodeItem
extends IDocumentNodeItem

Supports querying of global definitions and associated instances in a Metaschema module by effective name.

All definitions in the ModuleScopeEnum.INHERITED scope. This allows the exported structure of the Metaschema module to be queried.

Method Summary

Modifier and Type	Method	Description
default <RESULT,CONTEXT> RESULT	accept(INodeItemVisitor<RESULT,CONTEXT> visitor, CONTEXT context)	A visitor callback.
default String	format(IPathFormatter formatter)	Generate a path for this node in the directed node graph, using the provided path formatter.
default URI	getDocumentUri()	Get the URI associated with this document.
IModule	getModule()	The Metaschema module this item is based on.
default IModuleNodeItem	getNodeItem()	Get the value associated with the path segment.
default NodeItemType	getNodeItemType()	Get the type of node item this is.
default Object	getValue()	Get the item's "wrapped" value.
default boolean	hasValue()	Determine if the item has an associated value.

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

getBaseUri, getParentContentNodeItem, getParentNodeItem, getRootNodeItemByName

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

getModule

@NonNull
IModule getModule()

The Metaschema module this item is based on.

Returns:

the Metaschema module

getDocumentUri

default URI getDocumentUri()

Description copied from interface: IDocumentNodeItem

Get the URI associated with this document.

Specified by:

getDocumentUri in interface IDocumentNodeItem

Returns:

the document's URI or null if unavailable

getNodeItemType

default NodeItemType getNodeItemType()

Description copied from interface: INodeItem

Get the type of node item this is.

Specified by:

getNodeItemType in interface IDocumentNodeItem

Specified by:

getNodeItemType in interface INodeItem

Returns:

the node item's type

getNodeItem

default IModuleNodeItem getNodeItem()

Description copied from interface: IPathSegment

Get the value associated with the path segment.

Specified by:

getNodeItem in interface IDocumentNodeItem

Specified by:

getNodeItem in interface IPathSegment

Returns:

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

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 IDocumentNodeItem

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

accept

default <RESULT,CONTEXT> RESULT accept(@NonNull
                                             INodeItemVisitor<RESULT,CONTEXT> visitor,
                                             CONTEXT context)

Description copied from interface: INodeItemVisitable

A visitor callback.

Specified by:

accept in interface IDocumentNodeItem

Specified by:

accept in interface INodeItemVisitable

Type Parameters:

RESULT - the type of the visitor result

CONTEXT - the type of the context parameter

Parameters:

visitor - the calling visitor

context - a parameter used to pass contextual information between visitors

Returns:

the visitor result

getValue

@Nullable
default Object getValue()

Description copied from interface: IItem

Get the item's "wrapped" value. This "wrapped" value may be:

• In the case of an Assembly, a Java object representing the fields and flags of the assembly.
• In the case of a Field with flags, a Java object representing the field value and flags of the field.
• In the case of a Field without flags or a flag, a Java type managed by a IDataTypeAdapter or a primitive type provided by the Java standard library.

Specified by:

getValue in interface IItem

Returns:

the value or null if the item has no available value

hasValue

default boolean hasValue()

Description copied from interface: IItem

Determine if the item has an associated value.

Specified by:

hasValue in interface IItem

Returns:

true if the item has a non-null value or false otherwise