All Classes and Interfaces

Class
Description
Implementations of this class represent a temporal value which may not have a timezone making it ambiguous as a point/window in time.
Provides a common implementation for all atomic types that have an underlying value.
A base class for an assembly that is a member of a containing model.
Provides base functionality for atomic item implementations.
An abstract implementation of an atomic type.
A base class for a choice group that is a member of a containing model.
A base class for a choice that is a member of a containing model.
This Metapath exception base class is used for all exceptions that have a defined error code family and value.
Provides builder methods for the core data elements of an IConstraint.
Provides a complete, abstract implementation of a generalized feature.
Provides builder methods for the core data elements of an IConstraint.
Provides messaging for constraint violations.
Supports model instance operations on assembly model instances.
 
A common base implementation of a custom Java object providing an underlying implementation of a data type.
Provides a Java type adapter implementation for data types that are based on ICustomJavaDataType.
Provides a basic Java type adapter implementation.
A base implementation of an IDataTypeProvider, supporting dynamic loading of Metaschema data type extensions at runtime.
A base class for a field that is a member of a containing model.
A base class for a flag that is a member of a containing model.
A base class for an assembly definition defined globally within a Metaschema module.
A base class for definitions defined globally within a Metaschema module.
Provides a callback for generating a qualified name from a name.
A base class for a field definition defined globally within a Metaschema module.
A base class for a flag definition defined globally within a Metaschema module.
A base class for an assembly instance defined inline.
A base class for an assembly instance defined inline.
A base class for an assembly instance defined inline.
 
Provides a common base class for integer-based data types.
 
 
The common base for all markup implementations.
Provides a common, abstract implementation of a IModule.
Provides methods to load a Metaschema expressed in XML.
 
A base class for name members of a containing model.
 
 
Used by implementations of this class to visit a sequence of node items in a directed graph, using depth-first ordering.
 
 
Provides a common base class for string-based data types.
Provides an base implementation for a set of constraints that target a definition using a target Metapath expression.
A base class for untyped atomic items.
Provides processing hooks for a set of validation results.
Provides the means to aggregate multiple validation result sets into a single result set.
Represents a date value which may not have a timezone making it ambiguous as a window in time.
Represents a date/time value which may not have a timezone making it ambiguous as a point in time.
Represents a date value which may not have a timezone making it ambiguous as a window in time.
Represents an error that occurred while performing mathematical operations.
Implements the XPath 3.1 array:append function.
Represents an error that occurred while performing mathematical operations.
Implements the XPath 3.1 array:flatten function.
Implements the XPath 3.1 array:get function.
Implements the XPath 3.1 array:head function.
Implements the XPath 3.1 array:insert-before function.
Implements the XPath 3.1 array:join function.
Implements the XPath 3.1 array:put function.
Implements the XPath 3.1 array:remove function.
Implements the XPath 3.1 array:reverse function.
Implements the XPath 3.1 array:size function.
Implements the XPath 3.1 array:subarray function.
Implements the XPath 3.1 array:tail function.
Represents a container of rules constraining the effective model of a Metaschema assembly data instance.
A set of constraints targeting a IAssemblyDefinition based on a target Metapath expression.
Wraps a resource to make it AutoCloseable.
 
Support for the Metaschema base64 data type.
Support for the Metaschema boolean data type.
Implements the XPath 3.1 casting functions.
 
 
Comparison operators.
Identifies that an unexpected error occurred while initializing or using constraints associated with a Metaschema-based model.
Represents an individual constraint validation issue.
 
A variety of collector and other stream utilities.
A handler that supports resolving duplicate keys while inserting values into a map.
An abstract implementation of an atomic type backed by a data type adapter.
This class provides a singleton service to allow data types to be discovered within the system based on an SPI provided by IDataTypeProvider.
Support for the Metaschema date data type.
Support for the Metaschema date-time data type.
FODT: Exceptions related to Date/Time/Duration errors.
Support for the Metaschema date-time-with-timezone data type.
Support for the Metaschema date-with-timezone data type.
Support for the Metaschema day-time-duration data type.
Support for the Metaschema decimal data type.
An assembly model builder.
A choice group model builder.
A choice model builder.
Provides a basic configuration management implementation that allows mutable access to configuration state.
The default implementation of a constraint set sourced from an external constraint resource.
Used to perform constraint validation over one or more node items.
A basic implementation of a IDiagramNodeVisitor.
Provides a concrete implementation of a function call executor.
Provides built-in Metapath functions based on the XPath 3.1 function specification.
Produces a textual representation of a Metapath sequence.
 
Supports walking a portion of a metaschema model collecting a set of definitions that match the provided filter.
Used to perform cleanup on shutdown.
FODC: Exceptions representing document related errors.
The implementation of a Metapath dynamic context.
MPDY: Exceptions related to the Metapath dynamic context and dynamic evaluation.
Support for the Metaschema email-address data type.
A factory that produces qualified names.
Provides a callback for resolving namespace prefixes.
A module loading post processor that integrates applicable external constraints into a given module when loaded.
A set of constraints targeting a IFieldDefinition based on a target Metapath expression.
A validation result handler that collects the resulting findings for later retrieval using the FindingCollectingConstraintValidationHandler.getFindings() method.
 
A set of constraints targeting a IFlagDefinition based on a target Metapath expression.
Provides factory methods for Flexmark processing to support HTML-to-markdown and markdown-to-HTML conversion.
Implements the XPath 3.1 fn:abs function.
Implements the XPath 3.1 fn:avg function.
Implements the XPath 3.1 fn:base-uri functions.
Implements the XPath 3.1 fn:boolean function.
Implements the XPath 3.1 fn:ceiling function.
Implements the XPath 3.1 fn:compare function.
Implements the XPath 3.1 fn:concat function.
Implements the XPath 3.1 fn:contains function.
Implements the XPath 3.1 fn:count function.
Implements the XPath 3.1 fn:current-dateTime function.
Implements the XPath 3.1 fn:current-dateTime function.
Implements the XPath 3.1 fn:data functions.
Implements the XPath 3.1 fn:doc function.
Implements the XPath 3.1 fn:doc-available function.
Implements the XPath 3.1 fn:document-uri functions.
Implements the XPath 3.1 fn:empty function.
Implements the XPath 3.1 fn:ends-with function.
Implements the XPath 3.1 fn:exists function.
Implements the XPath 3.1 fn:false function.
Implements the XPath 3.1 fn:head function.
Implements the XPath 3.1 fn:insert-before function.
Based on the XPath 3.1 fn:lower-case functions.
Implements the XPath 3.1 fn:matches functions.
Implements the XPath 3.1 fn:min and fn:max functions.
Implements the XPath 3.1 fn:normalize-space functions.
Implements the XPath 3.1 fn:not function.
Implements the XPath 3.1 fn:path functions.
Implements the XPath 3.1 fn:remove function.
Implements the XPath 3.1 resolve-ur functions.
Implements the XPath 3.1 fn:reverse function.
Implements the XPath 3.1 fn:round functions.
Implements the XPath 3.1 fn:starts-with function.
Implements the XPath 3.1 fn:static-base-uri function.
Implements the XPath 3.1 fn:string function.
Implements the XPath 3.1 fn:string-length functions.
Implements the XPath 3.1 fn:substring functions.
Implements the XPath 3.1 fn:substring-after function.
Implements the XPath 3.1 fn:substring-before function.
Implements the XPath 3.1 fn:sum functions.
Implements the XPath 3.1 fn:tail function.
Implements the XPath 3.1 fn:tokenize function.
Implements the XPath 3.1 fn:true function.
Based on the XPath 3.1 fn:upper-case functions.
 
 
A collection of utility functions for use in implementing Metapath functions.
Support for the Metaschema hostname data type.
Adds support for the use of "q" tags in HTML to replace quotation marks.
A Flexmark node implementation representing a quotation mark.
Represents an individual enumerated value associated with an IAllowedValuesConstraint.
Represents a rule requiring the value of a field or flag to match the name of one entry in a set of enumerated values.
Provides a builder pattern for constructing a new IAllowedValuesConstraint.
Indicates how an allowed values constraint can be extended, or if it can be.
The 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.
An atomic Metapath item containing a URI data value.
Represents a single function argument signature.
Used to create an argument's signature using a builder pattern.
A representation of a Metapath array item type.
Declares the expected type information for an IArrayItem.
A marker interface for an information element that is an assembly model type.
 
 
 
 
 
A Metapath node valued item representing a Metaschema module assembly.
Provides type information for an atomic type.
A callback used to perform a casting operation.
This marker interface identifies a valued IItem type that has an associated IAnyAtomicItem value.
A marker interface for implementations that supports the mapping of a namespace valued key to a set of values.
Represents a property key based on a name and a namespace.
An atomic Metapath item containing a Base64 encoded data value.
An atomic Metapath item with a boolean value.
A common interface found bound objects that have a complex model consisting of flags, fields, or assemblies.
Represents a rule requiring a Metaschema assembly data instance to have elements with a minimum and/or maximum occurrence.
Provides a builder pattern for constructing a new ICardinalityConstraint.
An Metaschema model instance representing a grouped set of objects consisting of heterogeneous object types.
A marker interface for a choice of allowed instances in a Metachema.
A data value that can be a value in a Metapath array or map.
Represents a constraint that allows a configurable message.
The base interface for getting the configuration of processors and parsers in this library.
The common interface that all configuration features must implement.
Represents a rule constraining the model of a Metaschema assembly, field or flag.
The degree to which a constraint violation is significant.
 
 
Provides a set of callback methods used to process the result of evaluating a constraint.
This interface provides an entry point for performing validations over Metapath items associated with a Metaschema model.
Supports a visitor pattern over constraint instances.
 
Provides support for managing the flag contents of a IModelDefinition.
Indicates that the Metaschema type that has a complex model that can contain field and assembly instances.
 
 
Common interface for model container support classes.
 
Common interface for model container support classes.
A common interface for validation of Metaschema module-based content.
The common interface for all data type implementations supported by a custom Java class.
A marker interface used to identify an IAssemblyNodeItem as the head of a cycle of item that loop back to the head.
Represents a data type implementation.
A service interface used to provide implementations of data types represented as IDataTypeAdapter instances.
An atomic Metapath item representing a date value in the Metapath system with or without an explicit time zone.
An atomic Metapath item representing a date/time value in the Metapath system.
An atomic Metapath item representing a date/time value in the Metapath system with an explicit time zone.
An atomic Metapath item containing a date data value that has an explicit timezone.
An atomic Metapath item containing a duration data value in days, hours, and seconds.
An atomic Metapath item containing a decimal data value.
A marker interface for Metaschema constructs that can have a default value.
 
Describes the visibility of a definition to other modules.
 
 
Represents a Metaschema module IModelDefinition node that is part of a model diagram.
Represents a scalar-valued data point associated with a node.
Represents a relationship between a subject node and a target node.
The nature of a relationship between two nodes.
 
 
Supports loading documents referenced in Metapath expressions.
 
An atomic Metapath item representing a duration data value.
An atomic Metapath item containing an email address data value.
An efficient cache-backed representation of a qualified name.
Provides a callback for resolving namespace prefixes.
Represents a rule requiring a Metaschema assembly, field, or flag data instance to pass a Metapath-based test.
Provides a builder pattern for constructing a new IExpectConstraint.
Represents a node item for a Metaschema model instance the is always a child of another item in the Metaschema model.
Represents a definition that may contain flags.
Common interface for model container support classes.
 
 
A trait indicating that the implementation is a localized definition that is declared in-line as an instance.
 
This mixin interface indicates that the implementation is a INodeItem that is based on an IModelDefinition.
Provides an abstract implementation of a model that contains a collection of flags.
 
This mixin interface indicates that the implementation is a INodeItem that may have both flag and model children.
Provides an abstract implementation of a lazy loaded model.
 
This feature interface represents an item that has no associated value data.
A mixin interface used to identify that the implementation is a IDefinitionNodeItem that is based on a IDefinition that is an orphan in it's hierarchy.
 
 
A marker interface for an information element that is a field model type.
 
 
 
 
A Metapath node valued item representing a Metaschema module field.
A marker interface for an information element that is an flag model type.
 
 
 
A Metapath node valued item representing a Metaschema module flag.
A common interface for all Metapath functions.
Used to create a function's signature using a builder pattern.
Details specific characteristics of a function.
This functional interface provides a dispatch method for executing a function call.
 
 
An atomic Metapath item containing a hostname data value.
 
Represents a rule that generates a key-based index containing references to data items found in a Metaschema data instance.
Provides a builder pattern for constructing a new IIndexConstraint.
Represents a rule that checks that a key generated for a Metaschema data object exists in a named index that was generated using an IIndexConstraint.
Provides a builder pattern for constructing a new IIndexHasKeyConstraint.
This marker interface indicates that this object is an instance.
 
An atomic Metapath item containing an integer data value.
An atomic Metapath item representing an IP address data value.
An atomic Metapath item containing an IPv4 address data value.
An atomic Metapath item containing an IPv6 address data value.
The base interface inherited by all Metapath item implementations.
Provides type information that be used to discover type information for, test, and cast various item objects.
Use to visit the major types of items.
Supports writing different types of items using a visitor pattern.
 
A common interface used for constraints oriented around key-based indexes.
Represents a component of a key used in a key-based index.
A common interface for all key specifier implementations.
Provides type information that be used to discover type information for, test, and cast various node-based item objects.
Represents a variable assignment for use in Metaschema module constraints.
 
Represents a mapping of IMapKey keys to values.
The key value used in an IMapItem.
Declares the expected type information for a IMapItem.
An atomic Metapath item representing a Markup data value.
An atomic Metapath item representing a single line of Markup.
An atomic Metapath item representing multiple lines of Markup.
The common interface for all markup implementations.
Represents a rule requiring the value of a field or flag to match a pattern and/or conform to an identified data type.
Provides a builder pattern for constructing a new IMatchesConstraint.
 
 
Represents a loaded Metaschema module.
Represents a container of rules constraining the effective model of a Metaschema assembly data instance.
Represents a Metaschema definition for a complex object that may contain flags.
A marker interface for Metaschema constructs that can be members of a Metaschema definition's model.
This marker interface is used to identify a field or assembly instance that is a member of an assembly's model.
 
 
Represents a Metaschema module.
The API for accessing information about a given Metaschema module.
IModuleLoader<M extends IModuleExtended<M,?,?,?,?>>
 
Used to define a post-processing operation to perform on a module.
Supports querying of global definitions and associated instances in a Metaschema module by effective name.
This interface provides methods for retrieving and updating the configuration of processors and parsers in this library.
 
This marker interface indicates that the instance has a flag, field, or assembly name associated with it which will be used in JSON/YAML or XML to identify the data.
A marker interface for Metaschema constructs that can be members of a Metaschema module's model that have a name and other identifying characteristics.
 
 
Represents an arbitrary grouping of Metaschema model instances.
Deprecated, for removal: This API element is subject to removal in a future version.
Represents a queryable Metapath model node.
This factory interface is used to create INodeItem objects of various types.
 
 
Provides a set of callbacks used when iterating over node items in a directed graph.
An atomic Metapath item containing a non-negative integer data value.
Extension that adds support for insert anchors, used in OSCAL statements, and applicable more generally in other Metaschema-based models.
The flexmark node for an insert anchor.
Used to collect insert nodes.
Support for the Metaschema integer data type.
Represents an atomic Metapath item containing a numeric data value, which can be either an integer or decimal.
FORG: Exceptions related to argument types.
FOTY: Exceptions related to type errors.
Provides a convenient way to raise a TypeMetapathException.INVALID_TYPE_ERROR.
 
This interface provides an implementation contract for all path formatters.
A named segment of a path that can be formatted.
An atomic Metapath item containing a positive integer data value.
Identifies the implementation as being able to produce a string value for output.
Support for the Metaschema ip-v4-address data type.
Support for the Metaschema ip-v6-address data type.
Represents a location within a resource.
A common interface for implementation classes that load data resources.
A marker interface used to expose root node functionality for an assembly node that has root information.
Represents a set of target constraints that apply to a given Metaschema module namespace and short name.
Represents an ordered collection of Metapath expression results.
Supports sequence type testing.
A descriptor that identifies where a given constraint was defined.
The relative location of the source.
An atomic Metapath item containing a text data value.
Represents a set of constraints that target a given definition using a target Metapath expression.
An atomic Metapath item containing a temporal data value.
Provides a variety of utilities for working with Metapath items.
An atomic Metapath item representing a time value in the Metapath system.
An atomic Metapath item representing a time value in the Metapath system with an explicit time zone.
An atomic Metapath item containing a text token data value.
Represents a rule that requires all matching data items found in a Metaschema data instance to have a unique key.
Provides a builder pattern for constructing a new IUniqueConstraint.
An atomic Metapath item containing an untyped atomic data value.
An atomic Metapath item containing a URI reference data value that complies with RFC2396.
 
An atomic Metapath item containing a UUID data value.
Provides information about an individual finding that is the result of a completed content validation.
The finding type.
Provides data that is the result of a completed content validation.
Represents a container of rules constraining the effective model of a Metaschema field or flag data instance.
A marker interface for Metaschema constructs that can have a value.
This marker interface identifies Metaschema definition types that have associated values (i.e., field, flag).
 
Provides version information for a runtime dependency or application.
A Metaschema module represented in XML.
An atomic Metapath item containing a duration data value in years, months, and days.
 
 
 
Records an identified individual validation result found during JSON schema validation.
Provides utility functions to support reading and writing JSON, and for producing error and warning messages.
 
Supports logging constraint findings to the configured Log4J2 instance.
Implements the XPath 3.1 map:contains function.
Implements the XPath 3.1 map:entry function.
Implements the XPath 3.1 map:find function.
Implements the XPath 3.1 map:get function.
Implements the XPath 3.1 map:keys function.
Implements the XPath 3.1 map:merge functions.
Implements the XPath 3.1 map:put function.
Implements the XPath 3.1 map:remove function.
Implements the XPath 3.1 map:size function.
Provides for runtime discovery of built-in implementations of the markup Metaschema data types.
Supports a data value which is a single line of markup.
Support for the Metaschema markup-line data type.
Supports a data value which may be multiple lines of markup.
Support for the Metaschema markup-multiline data type.
Generates a mermaid diagram from a Metaschema IModule.
Provides constant values for use in Metapath.
Provides a mechanism to configure Metapath evaluation settings.
MetapathException is the superclass of all exceptions that can be thrown during the compilation and evaluation of a Metapath.
Supports compiling and executing Metapath expressions.
Identifies the expected type for a Metapath evaluation result.
An IPathFormatter that produces a Metapath expression for the path to a given INodeItem.
A collection of constant values related to Metaschema handling.
Provides runtime discovery of built-in implementations of the core Metaschema data types.
 
Provides version information for this library.
Provides version information for the underlying Metaschema implementation used by this library.
Identifies that an unexpected error occurred while initializing or using a Metaschema-based model.
An enumeration that identifies the type of a Metaschema construct.
Walks a Metaschema model.
Provides methods to load a Metaschema expressed in XML.
 
Provides new Metapath functions that evaluate a Metapath recursively over sequences generated by evaluating that expression.
An integer-based cache of namespaces to reduce the memory footprint of namespaces used by reusing instances with the same namespace.
Deprecated.
This enumeration provides a listing of the available kinds of INodeItem implementations.
Support for the Metaschema non-negative-integer data type.
Provides a generic implementation of methods defined by XPath 3.1 Functions on numeric values.
Implementations of this interface are used to execute a numeric opertaion on the provided item.
 
Identifies the occurrence of a sequence used a function argument or return value.
Used to check that a provided sequence matches an associated occurrence value.
 
Support for the Metaschema positive-integer data type.
 
 
 
 
 
The implementation of a Metapath static context.
A builder used to generate the static context.
Provides a callback for resolving namespace prefixes.
MPST: Exceptions related to the Metapath static context and static evaluation.
Support for the Metaschema string data type.
Support for the Metaschema date data type.
Support for the Metaschema date-time-with-timezone data type.
Support for the Metaschema token data type.
MPTY: Exceptions related to Metapath type errors.
Support for the Metaschema uri data type.
FONS: Exceptions related to function namespaces.
Support for the Metaschema uri-reference data type.
 
This model walker can be used to gather metaschema definitions that are defined globally.
Support for the Metaschema uuid data type.
 
A container of rules constraining the effective model of a Metaschema field or flag data instance.
Provides methods to load a constraint set expressed in XML.
Provides utility functions to support reading and writing XML stream events, and for producing error and warning messages.
 
Provides utility functions to support reading and writing XML, and for producing error and warning messages.
Used to load a set of external constraints from an XML-based resource.
Provides commonly used XML constants related to an XML-based Metaschema module.
Supports validating an XML resource using an XML schema.
Records an identified individual validation result found during XML schema validation.
 
Support for the Metaschema year-month-duration data type.