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

Interface IFieldNodeItem

All Superinterfaces:
IAtomicValuedItem, IAtomicValuedNodeItem, ICollectionValue, IDefinitionNodeItem<IFieldDefinition,IFieldInstance>, IItem, IMetapathQueryable, IModelNodeItem<IFieldDefinition,IFieldInstance>, INodeItem, INodeItemVisitable, IPathSegment
public interface IFieldNodeItem extends IModelNodeItem<IFieldDefinition,IFieldInstance>, IAtomicValuedNodeItem
A Metapath node valued item representing a Metaschema module field.

  • 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 IFieldNodeItem 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

    • getType

      default IKindTest<IFieldNodeItem> 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

    • 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