Module dev.metaschema.core

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

Interface IFeatureFlagContainerItem

All Superinterfaces:

ICollectionValue, IItem, IMetapathQueryable, INodeItem, INodeItemVisitable, IPathSegment

All Known Subinterfaces:

IFeatureModelContainerItem

public interface IFeatureFlagContainerItem
extends INodeItem

This mixin interface indicates that the implementation is a INodeItem that is based on an IModelDefinition. This means it has flag children.

If an implementation may have flag and model children, or model children only, then the IFeatureModelContainerItem should be used instead.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IFeatureFlagContainerItem.FlagContainer	Provides an abstract implementation of a model that contains a collection of flags.

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

INodeItem.NodeType

Method Summary

Modifier and Type	Method	Description
default IFlagNodeItem	getFlagByName(IEnhancedQName name)	Lookup a flag and value data on this node by it's effective qualified name.
default Collection<IFlagNodeItem>	getFlags()	Get the flags and value data associated this node.
IFeatureFlagContainerItem.FlagContainer	getModel()	Get the model implementation that potentially contains flags.
default Collection<? extends List<? extends IModelNodeItem<?,?>>>	getModelItems()	Get the model items (i.e., fields, assemblies) and value data associated this node.
default List<? extends IModelNodeItem<?,?>>	getModelItemsByName(IEnhancedQName name)	Get the collection of model items associated with the instance having the provided name.

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, toAtomicItem, toSequence

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

accept, ancestor, ancestorOrSelf, descendant, descendantOrSelf, flags, following, followingSibling, format, getBaseUri, getLocation, getMetapath, getNodeItemKind, getNodeType, getParentContentNodeItem, getParentNodeItem, 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

getModel

@NonNull
IFeatureFlagContainerItem.FlagContainer getModel()

Get the model implementation that potentially contains flags.

Returns:

the model

getFlags

default Collection<IFlagNodeItem> getFlags()

Description copied from interface: INodeItem

Get the flags and value data associated this node. The resulting collection is expected to be ordered, with the results in document order.

The resulting collection may be modified, but such modification is not thread safe

Specified by:

getFlags in interface INodeItem

Returns:

a collection of flags

getFlagByName

default IFlagNodeItem getFlagByName(@NonNull
 IEnhancedQName name)

Description copied from interface: INodeItem

Lookup a flag and value data on this node by it's effective qualified name.

Specified by:

getFlagByName in interface INodeItem

Parameters:

name - the effective qualified name of the flag

Returns:

the flag with the matching effective name or null if no match was found

getModelItems

default Collection<? extends List<? extends IModelNodeItem<?,?>>> getModelItems()

Description copied from interface: INodeItem

Get the model items (i.e., fields, assemblies) and value data associated this node. A given model instance can be multi-valued, so the value of each instance will be a list. The resulting collection is expected to be ordered, with the results in document order.

The resulting collection may be modified, but such modification is not thread safe

Specified by:

getModelItems in interface INodeItem

Returns:

a collection of list(s), with each list containing the items for a given model instance

getModelItemsByName

default List<? extends IModelNodeItem<?,?>> getModelItemsByName(IEnhancedQName name)

Description copied from interface: INodeItem

Get the collection of model items associated with the instance having the provided name.

The resulting collection may be modified, but such modification is not thread safe

Specified by:

getModelItemsByName in interface INodeItem

Parameters:

name - the instance name to get model items for

Returns:

the sequence of items associated with the named model instance, or an empty list if an instance with that name is not present