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

Interface IFlagNodeItem

All Superinterfaces:
IAtomicValuedItem, IAtomicValuedNodeItem, ICollectionValue, IDefinitionNodeItem<IFlagDefinition,IFlagInstance>, IItem, IMetapathQueryable, INodeItem, INodeItemVisitable, IPathSegment
All Known Implementing Classes:
AbstractFlagInstanceNodeItem
public interface IFlagNodeItem extends IDefinitionNodeItem<IFlagDefinition,IFlagInstance>, IAtomicValuedNodeItem
A Metapath node valued item representing a Metaschema module flag.

  • Method Details

    • type

      @NonNull static IItemType type()
      Get the static type information of the node item.
      Returns:
      the item type

    • getNodeItemKind

      default NodeItemKind getNodeItemKind()
      Description copied from interface: INodeItem
      Get the kind of node item this is.
      Specified by:
      getNodeItemKind in interface INodeItem
      Returns:
      the node item's kind

    • getNodeType

      default INodeItem.NodeType getNodeType()
      Description copied from interface: INodeItem
      Get the node type for the node item.
      Specified by:
      getNodeType in interface INodeItem
      Returns:
      the node type

    • getNodeItem

      default IFlagNodeItem getNodeItem()
      Description copied from interface: IPathSegment
      Get the value associated with the path segment.
      Specified by:
      getNodeItem in interface IMetapathQueryable
      Specified by:
      getNodeItem in interface IPathSegment
      Returns:
      the value or null if no value is associated with this path segment

    • getDefinition

      IFlagDefinition getDefinition()
      Description copied from interface: IDefinitionNodeItem
      Get the Metaschema definition associated with this node.
      Specified by:
      getDefinition in interface IDefinitionNodeItem<IFlagDefinition,IFlagInstance>
      Returns:
      the definition

    • getInstance

      IFlagInstance getInstance()
      Description copied from interface: IDefinitionNodeItem
      Retrieve the instance associated with this path segment.
      Specified by:
      getInstance in interface IDefinitionNodeItem<IFlagDefinition,IFlagInstance>
      Returns:
      the instance of the segment, or null if it doesn't have one

    • getType

      default IKindTest<IFlagNodeItem> getType()
      Description copied from interface: IItem
      Get the type information for the item.
      Specified by:
      getType in interface IItem
      Returns:
      the item's type information

    • getValueItemType

      default IAtomicOrUnionType<?> getValueItemType()
      Description copied from interface: IAtomicValuedNodeItem
      Get the item type of the item's value.
      Specified by:
      getValueItemType in interface IAtomicValuedNodeItem
      Returns:
      the item type

    • 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

    • getFlags

      default Collection<? extends IFlagNodeItem> getFlags()
      FlagContainer do not have flag items. This call should return an empty collection.
      Specified by:
      getFlags in interface INodeItem
      Returns:
      a collection of flags

    • getFlagByName

      default IFlagNodeItem getFlagByName(@NonNull IEnhancedQName name)
      FlagContainer do not have flag items. This call should return null.
      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

    • flags

      @NonNull default Stream<? extends IFlagNodeItem> flags()
      FlagContainer do not have flag items. This call should return an empty stream.
      Specified by:
      flags in interface INodeItem
      Returns:
      the stream of flags or an empty stream if none exist

    • getModelItems

      @NonNull default Collection<? extends List<? extends IModelNodeItem<?,?>>> getModelItems()
      FlagContainer do not have model items. This call should return an empty collection.
      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)
      FlagContainer do not have model items. This call should return an empty list.
      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

    • modelItems

      @NonNull default Stream<? extends IModelNodeItem<?,?>> modelItems()
      FlagContainer do not have model items. This call should return an empty stream.
      Specified by:
      modelItems in interface INodeItem
      Returns:
      the stream of model items or an empty stream if none exist

    • 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 <CONTEXT, RESULT> RESULT accept(@NonNull INodeItemVisitor<CONTEXT,RESULT> visitor, CONTEXT context)
      Description copied from interface: INodeItemVisitable
      A visitor callback.
      Specified by:
      accept in interface INodeItemVisitable
      Type Parameters:
      CONTEXT - the type of the context parameter
      RESULT - the type of the visitor result
      Parameters:
      visitor - the calling visitor
      context - a parameter used to pass contextual information between visitors
      Returns:
      the visitor result

    • deepEquals

      default boolean deepEquals(ICollectionValue other, DynamicContext dynamicContext)
      Description copied from interface: ICollectionValue
      Determine if this and the other value are deeply equal.

      Item equality is defined by the XPath 3.1 fn:deep-equal specification.

      Specified by:
      deepEquals in interface ICollectionValue
      Parameters:
      other - the other value to compare to this value to
      dynamicContext - used to provide evaluation information, including the implicit timezone
      Returns:
      the true if the two values are equal, or false otherwise