Module gov.nist.secauto.metaschema.core

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

Interface IFieldNodeItem

All Superinterfaces:

IAtomicValuedItem, IDefinitionNodeItem<IFieldDefinition,IFieldInstance>, IItem, IModelNodeItem<IFieldDefinition,IFieldInstance>, INodeItem, INodeItemVisitable, IPathSegment

public interface IFieldNodeItem
extends IModelNodeItem<IFieldDefinition,IFieldInstance>, IAtomicValuedItem

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	getBaseUri()	Retrieve the base URI of this node.
default IFieldNodeItem	getNodeItem()	Get the value associated with the path segment.
default NodeItemType	getNodeItemType()	Get the type of node item this is.

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

toAtomicItem

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

getDefinition, getInstance, getName

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.IModelNodeItem

getParentContentNodeItem, getParentNodeItem, getPosition

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

getNodeItemType

default NodeItemType getNodeItemType()

Description copied from interface: INodeItem

Get the type of node item this is.

Specified by:

getNodeItemType in interface INodeItem

Returns:

the node item's type

getNodeItem

default IFieldNodeItem getNodeItem()

Description copied from interface: IPathSegment

Get the value associated with the path segment.

Specified by:

getNodeItem in interface IPathSegment

Returns:

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

getBaseUri

@Nullable
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

format

@NonNull
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 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 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