Uses of Interface
dev.metaschema.core.metapath.item.ISequence

Packages that use ISequence

Package	Description
dev.metaschema.core.metapath	Provides the core Metapath expression language implementation.
dev.metaschema.core.metapath.function	Provides the core framework for defining and executing Metapath functions.
dev.metaschema.core.metapath.function.library	Built-in Metapath function implementations based on the XPath 3.1 specification.
dev.metaschema.core.metapath.item	Core interfaces and classes for the Metapath item type system.
dev.metaschema.core.metapath.item.function	Provides support for Metapath function items, including arrays and maps.
dev.metaschema.core.metapath.type	Provides support for Metapath type system and sequence type testing.
dev.metaschema.core.model.constraint	Metaschema constraint definitions and validation framework.
dev.metaschema.core.util	Provides utility classes for common operations throughout the Metaschema framework.

Uses of ISequence in dev.metaschema.core.metapath

Methods in dev.metaschema.core.metapath that return ISequence

Modifier and Type	Method	Description
ISequence<? extends IItem>	IExpression.accept(DynamicContext dynamicContext, ISequence<?> focus)	Provides a double dispatch callback for visitor handling.
default <T extends IItem> ISequence<T>	IMetapathExpression.evaluate()	Evaluate this Metapath expression without a specific focus.
default <T extends IItem> ISequence<T>	IMetapathExpression.evaluate(IItem focus)	Evaluate this Metapath expression using the provided focus as the initial evaluation context.
<T extends IItem> ISequence<T>	IMetapathExpression.evaluate(IItem focus, DynamicContext dynamicContext)	Evaluate this Metapath expression using the provided focus as the initial evaluation context.
ISequence<?>	DynamicContext.getCachedResult(CalledContext callingContext)	Get the cached function call result for evaluating a function that has the property IFunction.FunctionProperty.DETERMINISTIC.
ISequence<?>	DynamicContext.getVariableValue(IEnhancedQName name)	Get the sequence value assigned to a let variable with the provided qualified name.

Methods in dev.metaschema.core.metapath with parameters of type ISequence

Modifier and Type	Method	Description
ISequence<? extends IItem>	IExpression.accept(DynamicContext dynamicContext, ISequence<?> focus)	Provides a double dispatch callback for visitor handling.
DynamicContext	DynamicContext.bindVariableValue(IEnhancedQName name, ISequence<?> boundValue)	Bind the variable name to the sequence value.
void	DynamicContext.cacheResult(CalledContext callingContext, ISequence<?> result)	Cache a function call result for a that has the property IFunction.FunctionProperty.DETERMINISTIC.
<T> T	IMetapathExpression.ResultType.convert(ISequence<?> sequence)	Convert the provided sequence to the expected type.

Uses of ISequence in dev.metaschema.core.metapath.function

Methods in dev.metaschema.core.metapath.function that return ISequence

Modifier and Type	Method	Description
static <TYPE extends IItem> ISequence<TYPE>	FunctionUtils.asType(ISequence<?> sequence)	Casts the provided item as the result sequence type.
ISequence<?>	IFunction.execute(List<? extends ISequence<?>> arguments, DynamicContext dynamicContext, ISequence<?> focus)	Execute the function with the provided arguments, using the provided DynamicContext and focus.
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.

Methods in dev.metaschema.core.metapath.function that return types with arguments of type ISequence

Modifier and Type	Method	Description
List<ISequence<?>>	CalledContext.getArguments()	Get the arguments associated with the calling context.

Methods in dev.metaschema.core.metapath.function with parameters of type ISequence

Modifier and Type	Method	Description
static <TYPE extends IItem> ISequence<TYPE>	FunctionUtils.asType(ISequence<?> sequence)	Casts the provided item as the result sequence type.
ISequence<?>	IFunction.execute(List<? extends ISequence<?>> arguments, DynamicContext dynamicContext, ISequence<?> focus)	Execute the function with the provided arguments, using the provided DynamicContext and focus.
static IBooleanItem	ComparisonFunctions.generalComparison(ISequence<? extends IAnyAtomicItem> leftItems, ComparisonFunctions.Operator operator, ISequence<? extends IAnyAtomicItem> rightItems, DynamicContext dynamicContext)	Compare the sets of atomic items.
static INumericItem	FunctionUtils.toNumeric(ISequence<?> sequence, boolean requireSingleton)	Deprecated, 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 ISequence

Modifier and Type	Method	Description
ISequence<?>	IFunction.execute(List<? extends ISequence<?>> arguments, DynamicContext dynamicContext, ISequence<?> focus)	Execute the function with the provided arguments, using the provided DynamicContext and focus.
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.

Constructor parameters in dev.metaschema.core.metapath.function with type arguments of type ISequence

Modifier	Constructor	Description
	CalledContext(IFunction function, List<ISequence<?>> arguments, IItem contextItem)	Creates an immutable execution context for a function call.

Uses of ISequence in dev.metaschema.core.metapath.function.library

Methods in dev.metaschema.core.metapath.function.library that return ISequence

Modifier and Type	Method	Description
ISequence<ITEM>	CastFunction.execute(IFunction function, List<ISequence<?>> arguments, DynamicContext dynamicContext, IItem focus)
ISequence<INumericItem>	NumericFunction.execute(IFunction function, List<ISequence<?>> arguments, DynamicContext dynamicContext, IItem focus)
static ISequence<?>	FnExactlyOne.fnExactlyOne(ISequence<?> sequence)	Check that the provided sequence has exactly one item.
static ISequence<IIntegerItem>	FnIndexOf.fnIndexOf(List<IAnyAtomicItem> items, IAnyAtomicItem search, DynamicContext dynamicContext)	Determine if the string provided in the first argument contains the string in the second argument as a substring.
static ISequence<?>	FnOneOrMore.fnOneOrMore(ISequence<?> sequence)	Check that the provided sequence has one or more items.
static ISequence<IStringItem>	FnPath.fnPath(ISequence<?> sequence)	An implementation of XPath 3.1 fn:path.
static ISequence<IStringItem>	FnTokenize.fnTokenize(IStringItem input, IStringItem pattern, IStringItem flags)	Implements fn:tokenize.
static ISequence<?>	FnZeroOrOne.fnZeroOrOne(ISequence<?> sequence)	Check that the provided sequence has zero or one items.
static ISequence<?>	MapForEach.forEach(IMapItem<?> map, BiFunction<IAnyAtomicItem,ISequence<?>,ISequence<?>> action)	An implementation of XPath 3.1 map:for-each.
static ISequence<INodeItem>	MpRecurseDepth.recurseDepth(ISequence<INodeItem> initialContext, IMetapathExpression recursionMetapath, DynamicContext dynamicContext)	Evaluates the recursionMetapath starting with the the items in the initialContext and also recursively using the resulting items returned by evaluating this path.

Methods in dev.metaschema.core.metapath.function.library with parameters of type ISequence

Modifier and Type	Method	Description
static IBooleanItem	FnBoolean.fnBoolean(ISequence<?> sequence)	Get the effective boolean value of the provided sequence.
static boolean	FnBoolean.fnBooleanAsPrimitive(ISequence<?> sequence)	A helper method that gets the effective boolean value of the provided sequence based on XPath 3.1.
static ISequence<?>	FnExactlyOne.fnExactlyOne(ISequence<?> sequence)	Check that the provided sequence has exactly one item.
static IBooleanItem	FnExists.fnExists(ISequence<?> sequence)	Identify if there is at least one item in the sequence.
static IBooleanItem	FnNot.fnNot(ISequence<?> sequence)	Get the negated, effective boolean value of the provided item.
static ISequence<?>	FnOneOrMore.fnOneOrMore(ISequence<?> sequence)	Check that the provided sequence has one or more items.
static ISequence<IStringItem>	FnPath.fnPath(ISequence<?> sequence)	An implementation of XPath 3.1 fn:path.
static ISequence<?>	FnZeroOrOne.fnZeroOrOne(ISequence<?> sequence)	Check that the provided sequence has zero or one items.
static ISequence<INodeItem>	MpRecurseDepth.recurseDepth(ISequence<INodeItem> initialContext, IMetapathExpression recursionMetapath, DynamicContext dynamicContext)	Evaluates the recursionMetapath starting with the the items in the initialContext and also recursively using the resulting items returned by evaluating this path.

Method parameters in dev.metaschema.core.metapath.function.library with type arguments of type ISequence

Modifier and Type	Method	Description
ISequence<ITEM>	CastFunction.execute(IFunction function, List<ISequence<?>> arguments, DynamicContext dynamicContext, IItem focus)
ISequence<INumericItem>	NumericFunction.execute(IFunction function, List<ISequence<?>> arguments, DynamicContext dynamicContext, IItem focus)
static ISequence<?>	MapForEach.forEach(IMapItem<?> map, BiFunction<IAnyAtomicItem,ISequence<?>,ISequence<?>> action)	An implementation of XPath 3.1 map:for-each.
static ISequence<?>	MapForEach.forEach(IMapItem<?> map, BiFunction<IAnyAtomicItem,ISequence<?>,ISequence<?>> action)	An implementation of XPath 3.1 map:for-each.

Uses of ISequence in dev.metaschema.core.metapath.item

Methods in dev.metaschema.core.metapath.item that return ISequence

Modifier and Type	Method	Description
ISequence<?>	ICollectionValue.contentsAsSequence()	Get the collection value as a sequence.
default ISequence<?>	IItem.contentsAsSequence()
default ISequence<?>	ISequence.contentsAsSequence()
static <T extends IItem> ISequence<T>	ISequence.copyOf(Collection<? extends T> collection)	Returns an unmodifiable sequence containing the items of the given Collection, in its iteration order.
static <T extends IItem> ISequence<T>	ISequence.empty()	Get an empty sequence.
static ISequence<IDocumentBasedNodeItem>	ItemUtils.getDocumentNodeItems(DynamicContext dynamicContext, ISequence<?> items)	Get the ancestor document nodes for the provided items.
static <T extends R, R extends IItem> ISequence<R>	ISequence.map(Function<T,R> mapFunction, ISequence<T> seq)	Apply the provided mapFunction to each item in the sequence.
static <T extends IItem> ISequence<T>	ISequence.of()	Returns an unmodifiable sequence containing zero elements.
static <T extends IItem> ISequence<T>	ISequence.of(Stream<T> items)	Returns an unmodifiable sequence containing the provided items.
static <T extends IItem> ISequence<T>	ISequence.of(T item)	Returns an unmodifiable sequence containing the provided item.
static <T extends IItem> ISequence<T>	ISequence.of(T... items)	Returns an unmodifiable sequence containing an arbitrary number of items.
static <T extends IItem> ISequence<T>	ISequence.of(T e1, T e2)	Returns an unmodifiable sequence containing two items.
static <T extends IItem> ISequence<T>	ISequence.of(T e1, T e2, T e3)	Returns an unmodifiable sequence containing three elements.
static <T extends IItem> ISequence<T>	ISequence.of(T e1, T e2, T e3, T e4)	Returns an unmodifiable sequence containing four items.
static <T extends IItem> ISequence<T>	ISequence.of(T e1, T e2, T e3, T e4, T e5)	Returns an unmodifiable sequence containing five items.
static <T extends IItem> ISequence<T>	ISequence.of(T e1, T e2, T e3, T e4, T e5, T e6)	Returns an unmodifiable sequence containing six items.
static <T extends IItem> ISequence<T>	ISequence.of(T e1, T e2, T e3, T e4, T e5, T e6, T e7)	Returns an unmodifiable sequence containing seven items.
static <T extends IItem> ISequence<T>	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.
static <T extends IItem> ISequence<T>	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.
static <T extends IItem> ISequence<T>	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.
static <ITEM_TYPE extends IItem> ISequence<ITEM_TYPE>	ISequence.ofCollection(Collection<ITEM_TYPE> items)	Returns an unmodifiable sequence containing the provided items.
default ISequence<ITEM>	ISequence.reusable()	Ensure the sequence is able to be iterated over multiple times.
default ISequence<?>	ICollectionValue.toSequence()	Get the collection value as a sequence.
default ISequence<?>	IItem.toSequence()
default ISequence<ITEM>	ISequence.toSequence()	Get this sequence.

Methods in dev.metaschema.core.metapath.item with parameters of type ISequence

Modifier and Type	Method	Description
static ISequence<IDocumentBasedNodeItem>	ItemUtils.getDocumentNodeItems(DynamicContext dynamicContext, ISequence<?> items)	Get the ancestor document nodes for the provided items.
static <T extends IItem> T	ISequence.getFirstItem(ISequence<T> items, boolean requireSingleton)	Retrieves the first item in a sequence.
static <T extends R, R extends IItem> ISequence<R>	ISequence.map(Function<T,R> mapFunction, ISequence<T> seq)	Apply the provided mapFunction to each item in the sequence.
void	DefaultItemWriter.writeSequence(ISequence<?> sequence)
void	IItemWriter.writeSequence(ISequence<?> sequence)	Write the provided sequence instance.

Uses of ISequence in dev.metaschema.core.metapath.item.function

Methods in dev.metaschema.core.metapath.item.function that return ISequence

Modifier and Type	Method	Description
default ISequence<?>	IArrayItem.contentsAsSequence()
default ISequence<?>	IMapItem.contentsAsSequence()
default ISequence<? extends IArrayItem<ITEM>>	IArrayItem.toSequence()
default ISequence<IMapItem<VALUE>>	IMapItem.toSequence()

Methods in dev.metaschema.core.metapath.item.function with parameters of type ISequence

Modifier and Type	Method	Description
Stream<? extends ICollectionValue>	IKeySpecifier.lookup(IItem targetItem, DynamicContext dynamicContext, ISequence<?> focus)	Perform a lookup on the provided target item.

Uses of ISequence in dev.metaschema.core.metapath.type

Methods in dev.metaschema.core.metapath.type that return ISequence

Modifier and Type	Method	Description
<T extends IItem> ISequence<T>	Occurrence.ISequenceHandler.handle(ISequence<T> sequence)	Check that the provided sequence matches the occurrence.
default <T extends IItem> ISequence<T>	ISequenceType.test(ISequence<T> sequence)	Test if the provided sequence matches this sequence type.

Methods in dev.metaschema.core.metapath.type with parameters of type ISequence

Modifier and Type	Method	Description
default I	IAtomicOrUnionType.cast(ISequence<?> sequence)	Cast the provided sequence to this item type.
<T extends IItem> ISequence<T>	Occurrence.ISequenceHandler.handle(ISequence<T> sequence)	Check that the provided sequence matches the occurrence.
default <T extends IItem> ISequence<T>	ISequenceType.test(ISequence<T> sequence)	Test if the provided sequence matches this sequence type.

Uses of ISequence in dev.metaschema.core.model.constraint

Methods in dev.metaschema.core.model.constraint that return ISequence

Modifier and Type	Method	Description
ISequence<? extends IDefinitionNodeItem<?,?>>	IConstraint.matchTargets(IDefinitionNodeItem<?,?> item, DynamicContext dynamicContext)	Based on the provided contextNodeItem, find all nodes matching the target expression.

Methods in dev.metaschema.core.model.constraint with parameters of type ISequence

Modifier and Type	Method	Description
void	FindingCollectingConstraintValidationHandler.handleCardinalityMaximumViolation(ICardinalityConstraint constraint, INodeItem target, ISequence<? extends INodeItem> testedItems, DynamicContext dynamicContext)
void	IConstraintValidationHandler.handleCardinalityMaximumViolation(ICardinalityConstraint constraint, INodeItem target, ISequence<? extends INodeItem> testedItems, DynamicContext dynamicContext)	Handle a cardinality constraint maximum violation.
void	LoggingConstraintValidationHandler.handleCardinalityMaximumViolation(ICardinalityConstraint constraint, INodeItem node, ISequence<? extends INodeItem> targets, DynamicContext dynamicContext)
void	FindingCollectingConstraintValidationHandler.handleCardinalityMinimumViolation(ICardinalityConstraint constraint, INodeItem target, ISequence<? extends INodeItem> testedItems, DynamicContext dynamicContext)
void	IConstraintValidationHandler.handleCardinalityMinimumViolation(ICardinalityConstraint constraint, INodeItem target, ISequence<? extends INodeItem> testedItems, DynamicContext dynamicContext)	Handle a cardinality constraint minimum violation.
void	LoggingConstraintValidationHandler.handleCardinalityMinimumViolation(ICardinalityConstraint constraint, INodeItem node, ISequence<? extends INodeItem> targets, DynamicContext dynamicContext)
protected String	AbstractConstraintValidationHandler.newCardinalityMaximumViolationMessage(ICardinalityConstraint constraint, INodeItem target, ISequence<? extends INodeItem> testedItems, DynamicContext dynamicContext)	Construct a new violation message for the provided constraint applied to the node.
protected String	AbstractConstraintValidationHandler.newCardinalityMinimumViolationMessage(ICardinalityConstraint constraint, INodeItem target, ISequence<? extends INodeItem> testedItems, DynamicContext dynamicContext)	Construct a new violation message for the provided constraint applied to the node.

Uses of ISequence in dev.metaschema.core.util

Methods in dev.metaschema.core.util that return types with arguments of type ISequence

Modifier and Type	Method	Description
static <ITEM_TYPE extends IItem> Collector<ITEM_TYPE,?,ISequence<ITEM_TYPE>>	CustomCollectors.toSequence()	A Collector implementation to generates a sequence from a stream of Metapath items.