Uses of Interface
dev.metaschema.core.metapath.item.IItem
Packages that use IItem
Package
Description
The Metaschema and Metapath data type system API.
Provides the core Metapath expression language implementation.
Provides the core framework for defining and executing Metapath functions.
Built-in Metapath function implementations based on the XPath 3.1
specification.
Core interfaces and classes for the Metapath item type system.
Atomic item types representing indivisible values in the Metapath type
system.
Provides support for Metapath function items, including arrays and maps.
Node item types representing structured data in the Metapath type system.
Provides support for Metapath type system and sequence type testing.
Provides utility classes for common operations throughout the Metaschema
framework.
Provides a set of annotations for associating Module information with a Java
class.
-
Uses of IItem in dev.metaschema.core.datatype
Method parameters in dev.metaschema.core.datatype with type arguments of type IItemModifier and TypeMethodDescriptionDataTypeService.getItemTypeByItemClass(Class<? extends IItem> clazz) Lookup a specificIAtomicOrUnionTypeby its item class. -
Uses of IItem in dev.metaschema.core.metapath
Methods in dev.metaschema.core.metapath with type parameters of type IItemModifier and TypeMethodDescriptionIMetapathExpression.evaluate()Evaluate this Metapath expression without a specific focus.Evaluate this Metapath expression using the providedfocusas the initial evaluation context.IMetapathExpression.evaluate(IItem focus, DynamicContext dynamicContext) Evaluate this Metapath expression using the providedfocusas the initial evaluation context.Methods in dev.metaschema.core.metapath that return IItemMethods in dev.metaschema.core.metapath that return types with arguments of type IItemModifier and TypeMethodDescriptionIExpression.accept(DynamicContext dynamicContext, ISequence<?> focus) Provides a double dispatch callback for visitor handling.IExpression.getBaseResultType()The minimum expected result type to be produced when evaluating the expression.IExpression.getStaticResultType()The expected result type produced by evaluating the expression.Methods in dev.metaschema.core.metapath with parameters of type IItemModifier and TypeMethodDescriptionEvaluate this Metapath expression using the providedfocusas the initial evaluation context.IMetapathExpression.evaluate(IItem focus, DynamicContext dynamicContext) Evaluate this Metapath expression using the providedfocusas the initial evaluation context.default <T> TIMetapathExpression.evaluateAs(IItem focus, IMetapathExpression.ResultType resultType) Evaluate this Metapath expression using the providedfocusas the initial evaluation context.default <T> TIMetapathExpression.evaluateAs(IItem focus, IMetapathExpression.ResultType resultType, DynamicContext dynamicContext) Evaluate this Metapath expression using the providedfocusas the initial evaluation context.static FocusContextCreate a new focus context for the given item at the specified position within a sequence.Method parameters in dev.metaschema.core.metapath with type arguments of type IItemModifier and TypeMethodDescriptionstatic IItemTypeStaticContext.lookupItemType(Class<? extends IItem> clazz) Lookup a known Metapath item type based on the type's item class. -
Uses of IItem in dev.metaschema.core.metapath.function
Subinterfaces of IItem in dev.metaschema.core.metapath.functionModifier and TypeInterfaceDescriptioninterfaceA common interface for all Metapath functions.Classes in dev.metaschema.core.metapath.function that implement IItemModifier and TypeClassDescriptionclassProvides a concrete implementation of a function call executor.Methods in dev.metaschema.core.metapath.function with type parameters of type IItemModifier and TypeMethodDescriptionstatic <TYPE extends IItem>
TYPECasts the provideditemas the result type.Casts the provideditemas the result sequence type.static <TYPE extends IItem>
TYPEFunctionUtils.asTypeOrNull(IItem item) Casts the provideditemas the result type, if the item is notnull.FunctionUtils.countTypes(Set<Class<? extends T>> classes, Collection<? extends T> items) Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.static <TYPE extends IItem>
TYPEFunctionUtils.requireType(Class<TYPE> clazz, IItem item) Deprecated, for removal: This API element is subject to removal in a future version.static <TYPE extends IItem>
TYPEFunctionUtils.requireTypeOrNull(Class<TYPE> clazz, IItem item) Deprecated, for removal: This API element is subject to removal in a future version.Methods in dev.metaschema.core.metapath.function that return IItemModifier and TypeMethodDescriptionCalledContext.getContextItem()Get the node item focus associated with the calling context.Methods in dev.metaschema.core.metapath.function with parameters of type IItemModifier and TypeMethodDescriptionstatic <TYPE extends IItem>
TYPECasts the provideditemas the result type.static <TYPE extends IItem>
TYPEFunctionUtils.asTypeOrNull(IItem item) Casts the provideditemas the result type, if the item is notnull.ISequence<?>IFunctionExecutor.execute(IFunction function, List<ISequence<?>> arguments, DynamicContext dynamicContext, IItem focus) Execute the provided function using the provided arguments, dynamic context, and focus.protected ISequence<?>DefaultFunction.executeInternal(List<ISequence<?>> arguments, DynamicContext dynamicContext, IItem focus) Execute the provided function using the provided arguments, dynamic context, and focus.static <TYPE extends IItem>
TYPEFunctionUtils.requireType(Class<TYPE> clazz, IItem item) Deprecated, for removal: This API element is subject to removal in a future version.static <TYPE extends IItem>
TYPEFunctionUtils.requireTypeOrNull(Class<TYPE> clazz, IItem item) Deprecated, for removal: This API element is subject to removal in a future version.static INumericItemDeprecated, for removal: This API element is subject to removal in a future version.Method parameters in dev.metaschema.core.metapath.function with type arguments of type IItemModifier and TypeMethodDescriptionDeprecated, for removal: This API element is subject to removal in a future version.Constructors in dev.metaschema.core.metapath.function with parameters of type IItemModifierConstructorDescriptionCalledContext(IFunction function, List<ISequence<?>> arguments, IItem contextItem) Creates an immutable execution context for a function call.InvalidTypeFunctionException(int code, IItem item) Constructs a new exception with the providedcode,item, and no cause.InvalidTypeFunctionException(int code, IItem item, Throwable cause) Constructs a new exception with the providedcode,item, andcause. -
Uses of IItem in dev.metaschema.core.metapath.function.impl
Classes in dev.metaschema.core.metapath.function.impl that implement IItemModifier and TypeClassDescriptionclassdev.metaschema.core.metapath.function.impl.AbstractFunctionThis abstract implementation provides common functionality shared by all functions. -
Uses of IItem in dev.metaschema.core.metapath.function.library
Methods in dev.metaschema.core.metapath.function.library with type parameters of type IItemModifier and TypeMethodDescriptionFnInsertBefore.fnInsertBefore(List<T> target, IIntegerItem positionItem, List<T> inserts) An implementation of XPath 3.1 fn:insert-before.FnRemove.fnRemove(List<T> target, IIntegerItem positionItem) Remove the specified item atpositionfrom thesequence.Reverse the order of items in thesequence.static <T extends IItem>
IArrayItem<T>ArrayRemove.remove(IArrayItem<T> array, Collection<Integer> positions) An implementation of XPath 3.1 array:remove.static <T extends IItem>
IArrayItem<T>ArrayRemove.removeItems(IArrayItem<T> array, Collection<? extends IIntegerItem> positions) An implementation of XPath 3.1 array:remove.static <T extends IItem>
IArrayItem<T>ArrayTail.tail(IArrayItem<T> array) An implementation of XPath 3.1 array:tail.Methods in dev.metaschema.core.metapath.function.library that return IItemMethods in dev.metaschema.core.metapath.function.library that return types with arguments of type IItemModifier and TypeMethodDescriptionAn implementation of XPath 3.1 array:flatten.An implementation of XPath 3.1 array:flatten.Return the last item in thesequence.Methods in dev.metaschema.core.metapath.function.library with parameters of type IItemModifier and TypeMethodDescriptionCastFunction.execute(IFunction function, List<ISequence<?>> arguments, DynamicContext dynamicContext, IItem focus) NumericFunction.execute(IFunction function, List<ISequence<?>> arguments, DynamicContext dynamicContext, IItem focus) static Stream<ICollectionValue>MapFind.find(IItem item, IAnyAtomicItem key) An implementation of XPath 3.1 map:find.An implementation of XPath 3.1 array:flatten.static booleanFnBoolean.fnBooleanAsPrimitive(IItem item) A helper method that gets the effective boolean value of the provided item based on XPath 3.1.static IBooleanItemGet the negated, effective boolean value of the provided item.static IStringItemFnString.fnStringItem(IItem item) An implementation of fn::string.static IIntegerItemFnStringLength.fnStringLength(IItem item) An implementation of fn:string-length.Method parameters in dev.metaschema.core.metapath.function.library with type arguments of type IItemModifier and TypeMethodDescriptionstatic Stream<ICollectionValue>MapFind.find(Collection<? extends IItem> items, IAnyAtomicItem key) An implementation of XPath 3.1 map:find.An implementation of XPath 3.1 array:flatten.static IItemReturn the first item in thesequence.Return the last item in thesequence. -
Uses of IItem in dev.metaschema.core.metapath.item
Classes in dev.metaschema.core.metapath.item with type parameters of type IItemModifier and TypeInterfaceDescriptioninterfaceRepresents an ordered collection of Metapath expression results.Methods in dev.metaschema.core.metapath.item with type parameters of type IItemModifier and TypeMethodDescriptionISequence.copyOf(Collection<? extends T> collection) Returns an unmodifiable sequence containing the items of the given Collection, in its iteration order.ISequence.countTypes(Set<Class<? extends T>> classes) Count the occurrences of items in this sequence that are instances of the provided type classes.ISequence.empty()Get an empty sequence.static <T extends IItem>
TISequence.getFirstItem(ISequence<T> items, boolean requireSingleton) Retrieves the first item in a sequence.static <T extends IItem>
TISequence.getFirstItem(Stream<T> items, boolean requireSingleton) Retrieves the first item in a stream of items.Apply the providedmapFunctionto each item in the sequence.ISequence.of()Returns an unmodifiable sequence containing zero elements.Returns an unmodifiable sequence containing the provideditems.ISequence.of(T item) Returns an unmodifiable sequence containing the provideditem.ISequence.of(T... items) Returns an unmodifiable sequence containing an arbitrary number of items.ISequence.of(T e1, T e2) Returns an unmodifiable sequence containing two items.ISequence.of(T e1, T e2, T e3) Returns an unmodifiable sequence containing three elements.ISequence.of(T e1, T e2, T e3, T e4) Returns an unmodifiable sequence containing four items.ISequence.of(T e1, T e2, T e3, T e4, T e5) Returns an unmodifiable sequence containing five items.ISequence.of(T e1, T e2, T e3, T e4, T e5, T e6) Returns an unmodifiable sequence containing six items.ISequence.of(T e1, T e2, T e3, T e4, T e5, T e6, T e7) Returns an unmodifiable sequence containing seven items.ISequence.of(T e1, T e2, T e3, T e4, T e5, T e6, T e7, T e8) Returns an unmodifiable sequence containing eight items.ISequence.of(T e1, T e2, T e3, T e4, T e5, T e6, T e7, T e8, T e9) Returns an unmodifiable sequence containing nine items.ISequence.of(T e1, T e2, T e3, T e4, T e5, T e6, T e7, T e8, T e9, T e10) Returns an unmodifiable sequence containing ten items.ISequence.ofCollection(Collection<ITEM_TYPE> items) Returns an unmodifiable sequence containing the provideditems.Methods in dev.metaschema.core.metapath.item that return types with arguments of type IItemModifier and TypeMethodDescriptionICollectionValue.flatten()Get the stream of items for the collection value.IItem.flatten()ISequence.flatten()ICollectionValue.normalizeAsItems(ICollectionValue value) Get the stream of items for the collection value.Methods in dev.metaschema.core.metapath.item with parameters of type IItemModifier and TypeMethodDescriptionstatic IDocumentBasedNodeItemItemUtils.checkItemIsDocumentNodeItem(DynamicContext dynamicContext, IItem item) Checks that the item is anIDocumentNodeItem.static INodeItemItemUtils.checkItemIsNodeItem(DynamicContext dynamicContext, IItem item) Checks that the item is anINodeItem.static <TYPE> TYPEItemUtils.checkItemType(IItem item, Class<TYPE> clazz) Check that the item is the type specified byclazz.ISequence.of(T... items) Returns an unmodifiable sequence containing an arbitrary number of items. -
Uses of IItem in dev.metaschema.core.metapath.item.atomic
Subinterfaces of IItem in dev.metaschema.core.metapath.item.atomicModifier and TypeInterfaceDescriptioninterfaceThe interface shared by all atomic items, representing indivisible data values that serve as the fundamental building blocks for complex data structures in the Metaschema framework.interfaceAn atomic Metapath item containing a URI data value.interfaceThis marker interface identifies a valuedIItemtype that has an associatedIAnyAtomicItemvalue.interfaceAn atomic Metapath item containing a Base64 encoded data value.interfaceAn atomic Metapath item with a boolean value.interfaceA temporal valued item related to aZonedDateTime.interfaceAn atomic Metapath item representing a date value in the Metapath system with or without an explicit time zone.interfaceAn atomic Metapath item representing a date/time value in the Metapath system.interfaceAn atomic Metapath item representing a date/time value in the Metapath system with an explicit time zone.interfaceAn atomic Metapath item containing a date data value that has an explicit timezone.interfaceAn atomic Metapath item containing a duration data value in days, hours, and seconds.interfaceAn atomic Metapath item containing a decimal data value.interfaceAn atomic Metapath item representing a duration data value.interfaceAn atomic Metapath item containing an email address data value.interfaceAn atomic Metapath item containing a Base64 encoded data value.interfaceAn atomic Metapath item containing a hostname data value.interfaceAn atomic Metapath item containing an integer data value.interfaceAn atomic Metapath item representing an IP address data value.interfaceAn atomic Metapath item containing an IPv4 address data value.interfaceAn atomic Metapath item containing an IPv6 address data value.interfaceAn atomic Metapath item representing a Markup data value.interfaceAn atomic Metapath item representing a single line of Markup.interfaceAn atomic Metapath item representing multiple lines of Markup.interfaceDeprecated, for removal: This API element is subject to removal in a future version.interfaceAn atomic Metapath item containing a non-negative integer data value.interfaceRepresents an atomic Metapath item containing a numeric data value, which can be either an integer or decimal.interfaceAn atomic Metapath item containing a positive integer data value.interfaceAn atomic Metapath item with a namespace qualified name value.interfaceAn atomic Metapath item containing a text data value.interfaceAn atomic Metapath item containing a temporal data value.interfaceAn atomic Metapath item representing a time value in the Metapath system.interfaceAn atomic Metapath item representing a time value in the Metapath system with an explicit time zone.interfaceAn atomic Metapath item containing a text token data value.interfaceAn atomic Metapath item containing an untyped atomic data value.interfaceAn atomic Metapath item containing a URI reference data value that complies with RFC2396.interfaceAn atomic Metapath item containing a UUID data value.interfaceAn atomic Metapath item containing a duration data value in years, months, and days.Classes in dev.metaschema.core.metapath.item.atomic that implement IItemModifier and TypeClassDescriptionclassAbstractAnyAtomicItem<TYPE>Provides a common implementation for all atomic types that have an underlying value.classAbstractAtomicItemBase<TYPE>Provides base functionality for atomic item implementations.classA base class for untyped atomic items. -
Uses of IItem in dev.metaschema.core.metapath.item.atomic.impl
Subinterfaces of IItem in dev.metaschema.core.metapath.item.atomic.implModifier and TypeInterfaceDescriptioninterfacedev.metaschema.core.metapath.item.atomic.impl.IBinaryItemRepresents a binary string of bytes. -
Uses of IItem in dev.metaschema.core.metapath.item.function
Subinterfaces of IItem in dev.metaschema.core.metapath.item.functionModifier and TypeInterfaceDescriptioninterfaceIArrayItem<ITEM extends ICollectionValue>A representation of a Metapath array item type.interfaceIMapItem<VALUE extends ICollectionValue>Represents a mapping ofIMapKeykeys to values.Methods in dev.metaschema.core.metapath.item.function that return types with arguments of type IItemMethods in dev.metaschema.core.metapath.item.function with parameters of type IItemModifier and TypeMethodDescriptionStream<? extends ICollectionValue>IKeySpecifier.lookup(IItem targetItem, DynamicContext dynamicContext, ISequence<?> focus) Perform a lookup on the provided target item. -
Uses of IItem in dev.metaschema.core.metapath.item.node
Subinterfaces of IItem in dev.metaschema.core.metapath.item.nodeModifier and TypeInterfaceDescriptioninterfaceRepresents a Metapath assembly node item for a grouped assembly instance.interfaceA Metapath node valued item representing a Metaschema module assembly.interfaceRepresents a Metapath node item that has an atomic value.interfaceA marker interface used to identify anIAssemblyNodeItemas the head of a cycle of item that loop back to the head.interfaceIDefinitionNodeItem<D extends IDefinition,I extends INamedInstance> Represents a Metapath node item that is based on an underlying Metaschema module definition and instance.interfaceRepresents a Metapath node item that is associated with a document.interfaceA node item that represents the root of a tree of nodes associated with a document resource.interfaceRepresents a node item for a Metaschema model instance the is always a child of another item in the Metaschema model.interfaceThis mixin interface indicates that the implementation is aINodeItemthat is based on anIModelDefinition.interfaceThis mixin interface indicates that the implementation is aINodeItemthat may have both flag and model children.interfaceA feature interface representing an atomic-valued item that has no associated value data.interfaceThis feature interface represents an item that has no associated value data.interfaceIFeatureOrhpanedDefinitionNodeItem<D extends IDefinition,I extends INamedInstance> A mixin interface used to identify that the implementation is aIDefinitionNodeItemthat is based on aIDefinitionthat is an orphan in it's hierarchy.interfaceA Metapath node valued item representing a Metaschema module field.interfaceA Metapath node valued item representing a Metaschema module flag.interfaceIModelNodeItem<D extends IModelDefinition,I extends INamedModelInstance> Represents a Metapath node item for a Metaschema model instance (assembly or field).interfaceSupports querying of global definitions and associated instances in a Metaschema module by effective name.interfaceRepresents a Metapath model node.interfaceA marker interface used to expose root node functionality for an assembly node that has root information.Classes in dev.metaschema.core.metapath.item.node that implement IItemModifier and TypeClassDescriptionclassAbstractDefinitionNodeItem<D extends IDefinition,I extends INamedInstance> A base implementation of a node item backed by a Metaschema definition.classAINodeItemsupported by aIFlagInstance.classAbstractGlobalDefinitionNodeItem<D extends IDefinition,I extends INamedInstance> Represents a node item based on a global definition from a Metaschema.classAbstractInstanceNodeItem<D extends IDefinition,I extends INamedInstance, P extends IModelNodeItem<? extends IModelDefinition, ? extends INamedInstance>> A base implementation of a node item backed by a Metaschema instance.classA common base class for node item implementations.classAbstractOrphanedDefinitionNodeItem<D extends IDefinition,I extends INamedInstance> A base implementation of a node item for a Metaschema definition that exists without a parent context (orphaned). -
Uses of IItem in dev.metaschema.core.metapath.type
Methods in dev.metaschema.core.metapath.type with type parameters of type IItemModifier and TypeMethodDescriptionCheck that the provided sequence matches the occurrence.default <T extends IItem>
TIItemType.test(T item) Test if the provided item matches this item type.Test if the provided sequence matches this sequence type.default <T extends IItem>
TISequenceType.test(T item) Test if the provided item matches this sequence type.Methods in dev.metaschema.core.metapath.type that return IItemModifier and TypeMethodDescriptionInvalidTypeMetapathException.getItem()Get the associated item, if provided for the exception.Methods in dev.metaschema.core.metapath.type that return types with arguments of type IItemModifier and TypeMethodDescriptionIItemType.getItemClass()Get the item Java class associated with this item type.Methods in dev.metaschema.core.metapath.type with parameters of type IItemModifier and TypeMethodDescriptiondefault booleanIArrayTest.isInstance(IItem item) default booleanIItemType.isInstance(IItem item) Test if the provided item matches this item type.default booleanIMapTest.isInstance(IItem item) Constructors in dev.metaschema.core.metapath.type with parameters of type IItemModifierConstructorDescriptionConstructs a new exception with the provideditemand no cause, using a default message.InvalidTypeMetapathException(IItem item, String message) Constructs a new exception with the provideditem,message, and no cause.InvalidTypeMetapathException(IItem item, String message, Throwable cause) Constructs a new exception with the provideditem,message, andcause.InvalidTypeMetapathException(IItem item, Throwable cause) Constructs a new exception with the provideditemandcause, using a default message. -
Uses of IItem in dev.metaschema.core.util
Methods in dev.metaschema.core.util with type parameters of type IItemModifier and TypeMethodDescriptionCustomCollectors.toSequence()ACollectorimplementation to generates a sequence from a stream of Metapath items. -
Uses of IItem in dev.metaschema.databind.model.annotations
Classes in dev.metaschema.databind.model.annotations that implement IItemModifier and TypeClassDescriptionprotected static classA placeholder atomic item type that throws unsupported operation exceptions for all operations.