Module dev.metaschema.core

Package dev.metaschema.core.model

package dev.metaschema.core.model

Core Metaschema model interfaces and implementations.

This package defines the fundamental object model for Metaschema modules, including definitions (assemblies, fields, flags), instances, and their relationships. It provides both the API contracts and abstract base implementations for representing Metaschema structures.

Key Interfaces

• IModule - Represents a Metaschema module containing definitions
• IAssemblyDefinition - Defines a complex assembly structure
• IFieldDefinition - Defines a field with optional value and flags
• IFlagDefinition - Defines a flag (simple name-value pair)
• IModelInstance - Represents an instance of a definition within a model
• IContainerModel - Represents a container that can hold model instances

Usage Context

This package is used by:

• Metaschema module loaders to construct in-memory representations of modules
• Databinding implementations to map between Java objects and Metaschema structures
• Code generators to produce Java classes from Metaschema definitions
• Validation and constraint processing to enforce structural rules

See Also:

• dev.metaschema.core.model.constraint
• dev.metaschema.core.model.validation

Related Packages

Package	Description
dev.metaschema.core	Core support for handling Metaschema-based models.
dev.metaschema.core.model.constraint	Metaschema constraint definitions and validation framework.
dev.metaschema.core.model.util	Utility classes for Metaschema model processing and manipulation.
dev.metaschema.core.model.validation	Schema-based content validation for Metaschema instances.
dev.metaschema.core.configuration	Provides a type-safe configuration framework for processors and parsers.
dev.metaschema.core.datatype	The Metaschema and Metapath data type system API.
dev.metaschema.core.metapath	Provides the core Metapath expression language implementation.
dev.metaschema.core.qname	Enhanced qualified name (QName) support with efficient caching and namespace management.
dev.metaschema.core.util	Provides utility classes for common operations throughout the Metaschema framework.

Class	Description
AbstractAssemblyInstance<PARENT extends IContainerModel,DEFINITION extends IAssemblyDefinition,INSTANCE extends IAssemblyInstance,PARENT_DEFINITION extends IAssemblyDefinition>	A base class for an assembly that is a member of a containing model.
AbstractChoiceGroupInstance<PARENT extends IAssemblyDefinition,NAMED_MODEL extends INamedModelInstanceGrouped,FIELD extends IFieldInstanceGrouped,ASSEMBLY extends IAssemblyInstanceGrouped>	A base class for a choice group that is a member of a containing model.
AbstractChoiceInstance<PARENT extends IAssemblyDefinition,MODEL extends IModelInstanceAbsolute,NAMED_MODEL extends INamedModelInstanceAbsolute,FIELD extends IFieldInstanceAbsolute,ASSEMBLY extends IAssemblyInstanceAbsolute>	A base class for a choice that is a member of a containing model.
AbstractContainerModelSupport<MI extends IModelInstance,NMI extends INamedModelInstance,FI extends IFieldInstance,AI extends IAssemblyInstance>	Supports model instance operations on assembly model instances.
AbstractFieldInstance<PARENT extends IContainerModel,DEFINITION extends IFieldDefinition,INSTANCE extends IFieldInstance,PARENT_DEFINITION extends IAssemblyDefinition>	A base class for a field that is a member of a containing model.
AbstractFlagInstance<PARENT extends IModelDefinition,DEFINITION extends IFlagDefinition,INSTANCE extends IFlagInstance>	A base class for a flag that is a member of a containing model.
AbstractGlobalAssemblyDefinition<MODULE extends IModule,INSTANCE extends IAssemblyInstance,FLAG extends IFlagInstance,MODEL extends IModelInstanceAbsolute,NAMED_MODEL extends INamedModelInstanceAbsolute,FIELD extends IFieldInstanceAbsolute,ASSEMBLY extends IAssemblyInstanceAbsolute,CHOICE extends IChoiceInstance,CHOICE_GROUP extends IChoiceGroupInstance>	A base class for an assembly definition defined globally within a Metaschema module.
AbstractGlobalDefinition<MODULE extends IModule,INSTANCE extends INamedInstance>	A base class for definitions defined globally within a Metaschema module.
AbstractGlobalDefinition.NameInitializer	Provides a callback for generating a qualified name from a name.
AbstractGlobalFieldDefinition<MODULE extends IModule,INSTANCE extends IFieldInstance,FLAG extends IFlagInstance>	A base class for a field definition defined globally within a Metaschema module.
AbstractGlobalFlagDefinition<MODULE extends IModule,INSTANCE extends IFlagInstance>	A base class for a flag definition defined globally within a Metaschema module.
AbstractInlineAssemblyDefinition<PARENT extends IContainerModel,DEFINITION extends IAssemblyDefinition,INSTANCE extends IAssemblyInstance,PARENT_DEFINITION extends IAssemblyDefinition,FLAG extends IFlagInstance,MODEL extends IModelInstanceAbsolute,NAMED_MODEL extends INamedModelInstanceAbsolute,FIELD extends IFieldInstanceAbsolute,ASSEMBLY extends IAssemblyInstanceAbsolute,CHOICE extends IChoiceInstance,CHOICE_GROUP extends IChoiceGroupInstance>	A base class for an assembly instance defined inline.
AbstractInlineFieldDefinition<PARENT extends IContainerModel,DEFINITION extends IFieldDefinition,INSTANCE extends IFieldInstance,PARENT_DEFINITION extends IAssemblyDefinition,FLAG extends IFlagInstance>	A base class for an assembly instance defined inline.
AbstractInlineFlagDefinition<PARENT extends IModelDefinition,DEFINITION extends IFlagDefinition,INSTANCE extends IFlagInstance>	A base class for an assembly instance defined inline.
AbstractInstance<P extends IContainer>	Base implementation of IInstance providing parent container management.
AbstractLoader<T>	Base implementation of ILoader providing resource loading with caching and cycle detection.
AbstractModelElementVisitor<CONTEXT,RESULT>	Provides a set of callbacks used when iterating over model elements in a directed graph.
AbstractModule<M extends IModuleExtended<M,D,FL,FI,A>,D extends IModelDefinition,FL extends IFlagDefinition,FI extends IFieldDefinition,A extends IAssemblyDefinition>	Provides a common, abstract implementation of a IModule.
AbstractModuleLoader<T,M extends IModuleExtended<M,?,?,?,?>>	Provides methods to load a Metaschema expressed in XML.
AbstractNamedInstance<PARENT extends IContainer>	Base implementation of INamedInstance providing qualified name management.
AbstractNamedModelInstance<PARENT extends IContainerModel,PARENT_DEFINITION extends IAssemblyDefinition>	A base class for name members of a containing model.
AbstractResourceResolver	Base implementation of IResourceResolver providing URI resolution support.
DefaultAssemblyModelBuilder<MI extends IModelInstance,NMI extends INamedModelInstance,FI extends IFieldInstance,AI extends IAssemblyInstance,CI extends IChoiceInstance,CGI extends IChoiceGroupInstance>	An assembly model builder.
DefaultChoiceGroupModelBuilder<NMI extends INamedModelInstance,FI extends IFieldInstance,AI extends IAssemblyInstance>	A choice group model builder.
DefaultChoiceModelBuilder<MI extends IModelInstance,NMI extends INamedModelInstance,FI extends IFieldInstance,AI extends IAssemblyInstance>	A choice model builder.
DefinitionCollectingModelWalker	Supports walking a portion of a metaschema model collecting a set of definitions that match the provided filter.
FlagContainerBuilder<T extends IFlagInstance>	Default implementation of IFlagContainerBuilder.
IAssembly	A marker interface for an information element that is an assembly model type.
IAssemblyDefinition	Represents an assembly definition in a Metaschema module.
IAssemblyInstance	Represents an assembly instance within another assembly definition.
IAssemblyInstanceAbsolute	Represents an assembly instance that appears directly within an assembly definition.
IAssemblyInstanceGrouped	Represents an assembly instance that appears within a choice or other grouping construct.
IAttributable	A marker interface for implementations that supports the mapping of a namespace valued key to a set of values.
IAttributable.Key	Represents a property key based on a name and a namespace.
IBoundObject	A common interface found bound objects that have a complex model consisting of flags, fields, or assemblies.
IChoiceGroupInstance	An Metaschema model instance representing a grouped set of objects consisting of heterogeneous object types.
IChoiceInstance	A marker interface for a choice of allowed instances in a Metachema.
IConstraintLoader	Provides loading capabilities for Metaschema constraint sets.
IContainer	Represents a model element that can contain child instances.
IContainerFlagSupport<FI extends IFlagInstance>	Provides support for managing the flag contents of a IModelDefinition.
IContainerModel	Indicates that the Metaschema type that has a complex model that can contain field and assembly instances.
IContainerModelAbsolute	Represents a model container with absolute (non-grouped) instances.
IContainerModelAssembly	Represents a model container for assembly definitions.
IContainerModelAssemblySupport<MI extends IModelInstance,NMI extends INamedModelInstance,FI extends IFieldInstance,AI extends IAssemblyInstance,CI extends IChoiceInstance,CGI extends IChoiceGroupInstance>	Common interface for model container support classes.
IContainerModelGrouped	Represents a model container with grouped instances.
IContainerModelSupport<MI extends IModelInstance,NMI extends INamedModelInstance,FI extends IFieldInstance,AI extends IAssemblyInstance>	Common interface for model container support classes.
IDefaultable	A marker interface for Metaschema constructs that can have a default value.
IDefinition	Represents a definition of a flag, field, or assembly in a Metaschema module.
IDefinition.ModuleScope	Describes the visibility of a definition to other modules.
IDescribable	Represents a model element that has a formal name and description.
IFeatureContainerFlag<FI extends IFlagInstance>	Represents a definition that may contain flags.
IFeatureContainerModelAbsolute<MI extends IModelInstanceAbsolute,NMI extends INamedModelInstanceAbsolute,FI extends IFieldInstanceAbsolute,AI extends IAssemblyInstanceAbsolute>	Common interface for model container support classes.
IFeatureContainerModelAssembly<MI extends IModelInstanceAbsolute,NMI extends INamedModelInstanceAbsolute,FI extends IFieldInstanceAbsolute,AI extends IAssemblyInstanceAbsolute,CI extends IChoiceInstance,CGI extends IChoiceGroupInstance>	Provides assembly-specific container model functionality through delegation.
IFeatureContainerModelGrouped<NMI extends INamedModelInstanceGrouped,FI extends IFieldInstanceGrouped,AI extends IAssemblyInstanceGrouped>	Provides grouped container model functionality through delegation.
IFeatureDefinitionInstanceInlined<DEFINITION extends IDefinition,INSTANCE extends INamedInstance>	A trait indicating that the implementation is a localized definition that is declared in-line as an instance.
IFeatureDefinitionReferenceInstance<DEFINITION extends IDefinition,INSTANCE extends INamedInstance>	Represents an instance that references a definition.
IFeatureValueless	Represents an instance that has no value.
IField	A marker interface for an information element that is a field model type.
IFieldDefinition	Represents a field definition in a Metaschema module.
IFieldInstance	Represents a field instance within an assembly definition.
IFieldInstanceAbsolute	Represents a field instance that appears directly within an assembly definition.
IFieldInstanceGrouped	Represents a field instance that appears within a choice or other grouping construct.
IFlag	A marker interface for an information element that is an flag model type.
IFlagContainerBuilder<T extends IFlagInstance>	Builder for constructing flag container instances.
IFlagDefinition	Represents a flag definition in a Metaschema module.
IFlagInstance	Represents a flag instance within a field or assembly definition.
IGroupable	This behavioral interface represents an instance that supports grouped values.
IInstance	This marker interface indicates that this object is an instance.
IInstanceAbsolute	Represents an instance with an absolute path and an associated value.
IJsonInstance	Represents a model instance that has a JSON property name.
IJsonNamed	Represents a model element that has a JSON property name.
ILoader<T>	Provides loading capabilities for resources of type T.
IMetapathQueryable	Represents a model element that can be queried using Metapath expressions.
IMetaschemaData	Represents data associated with a Metaschema module.
IMetaschemaModule<SELF extends IMetaschemaModule<SELF>>	Represents a loaded Metaschema module.
IModelDefinition	Represents a Metaschema definition for a complex object that may contain flags.
IModelElement	A marker interface for Metaschema constructs that can be members of a Metaschema definition's model.
IModelElementVisitable	Represents a model element that can be visited using the visitor pattern.
IModelElementVisitor<CONTEXT,RESULT>	Provides a set of callbacks used when iterating over node items in a directed graph.
IModelInstance	This marker interface is used to identify a field or assembly instance that is a member of an assembly's model.
IModelInstanceAbsolute	Represents a model instance with an absolute path and an associated value.
IModule	Represents a Metaschema module.
IModuleExtended<M extends IModuleExtended<M,D,FL,FI,A>,D extends IModelDefinition,FL extends IFlagDefinition,FI extends IFieldDefinition,A extends IAssemblyDefinition>	The API for accessing information about a given Metaschema module.
IModuleLoader<M extends IModuleExtended<M,?,?,?,?>>	Provides loading capabilities for Metaschema modules.
IModuleLoader.IModulePostProcessor	Used to define a post-processing operation to perform on a module.
INamed	Represents a model element that has a name and associated naming properties.
INamedInstance	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.
INamedModelElement	A marker interface for Metaschema constructs that can be members of a Metaschema module's model that have a name and other identifying characteristics.
INamedModelInstance	Represents a named instance of a field or assembly within a model.
INamedModelInstanceAbsolute	Represents a named model instance with absolute positioning and JSON serialization support.
INamedModelInstanceGrouped	Represents an arbitrary grouping of Metaschema model instances.
IResourceLocation	Represents a location within a resource.
IResourceResolver	A common interface for implementation classes that load data resources.
ISource	A descriptor that identifies where a given constraint was defined.
ISource.SourceLocation	The relative location of the source.
IUriResolver	Provides URI resolution capabilities for Metaschema resources.
IValued	A marker interface for Metaschema constructs that can have a value.
IValuedDefinition	This marker interface identifies Metaschema definition types that have associated values (i.e., field, flag).
IValuedInstance	Represents a Metaschema instance that has an associated value (i.e., field or flag instance).
JsonGroupAsBehavior	Defines how repeated instances are grouped in JSON/YAML representations.
JsonValueKeyTypeEnum	Defines the type of JSON value key used to identify data values.
MetaschemaException	Indicates an error related to Metaschema processing.
MetaschemaModelConstants	Provides commonly used QName constants for Metaschema model elements.
ModelInitializationException	Identifies that an unexpected error occurred while initializing or using a Metaschema-based model.
ModelType	An enumeration that identifies the type of a Metaschema construct.
ModelWalker<DATA>	Walks a Metaschema model.
SimpleResourceLocation	A simple implementation of IMetaschemaData that stores location information from various parser sources.
UsedDefinitionModelWalker	This model walker can be used to gather metaschema definitions that are defined globally.
XmlGroupAsBehavior	Defines how repeated instances are grouped in XML representations.