Module dev.metaschema.core

Package dev.metaschema.core.model

Interface IModelInstance

All Superinterfaces:

IDefaultable, IGroupable, IInstance, IModelElement, IModelElementVisitable

All Known Subinterfaces:

IAssemblyInstance, IAssemblyInstanceAbsolute, IAssemblyInstanceGrouped, IBindingInstanceModel, IBoundInstanceModel<ITEM>, IBoundInstanceModelAssembly, IBoundInstanceModelChoiceGroup, IBoundInstanceModelField<ITEM>, IBoundInstanceModelFieldComplex, IBoundInstanceModelFieldScalar, IBoundInstanceModelGroupedAssembly, IBoundInstanceModelGroupedField, IBoundInstanceModelGroupedNamed, IBoundInstanceModelNamed<ITEM>, IChoiceGroupInstance, IChoiceInstance, IFieldInstance, IFieldInstanceAbsolute, IFieldInstanceGrouped, IModelInstanceAbsolute, INamedModelInstance, INamedModelInstanceAbsolute, INamedModelInstanceGrouped

All Known Implementing Classes:

AbstractAssemblyInstance, AbstractChoiceGroupInstance, AbstractChoiceInstance, AbstractFieldInstance, AbstractInlineAssemblyDefinition, AbstractInlineFieldDefinition, AbstractNamedModelInstance

public interface IModelInstance
extends IGroupable

This marker interface is used to identify a field or assembly instance that is a member of an assembly's model.

Field Summary

Fields inherited from interface dev.metaschema.core.model.IGroupable

DEFAULT_GROUP_AS_MAX_OCCURS, DEFAULT_GROUP_AS_MIN_OCCURS, DEFAULT_JSON_GROUP_AS_BEHAVIOR, DEFAULT_XML_GROUP_AS_BEHAVIOR

Method Summary

Modifier and Type	Method	Description
IAssemblyDefinition	getContainingDefinition()	Retrieve the Metaschema module definition on which the instance was declared.
IContainerModel	getParentContainer()	Get the parent model definition that serves as the container of this instance.
boolean	isEffectiveValueWrappedInXml()	Indicate if the instance allows values without an XML element wrapper.

Methods inherited from interface dev.metaschema.core.model.IDefaultable

getDefaultValue, getEffectiveDefaultValue, getResolvedDefaultValue

Methods inherited from interface dev.metaschema.core.model.IGroupable

getEffectiveXmlGroupAsQName, getGroupAsName, getItemValues, getJsonGroupAsBehavior, getMaxOccurs, getMinOccurs, getXmlGroupAsBehavior

Methods inherited from interface dev.metaschema.core.model.IInstance

toCoordinates

Methods inherited from interface dev.metaschema.core.model.IModelElement

getContainingModule, getModelType, getRemarks

Methods inherited from interface dev.metaschema.core.model.IModelElementVisitable

accept

Method Details

getParentContainer

IContainerModel getParentContainer()

Description copied from interface: IInstance

Get the parent model definition that serves as the container of this instance.

Specified by:

getParentContainer in interface IInstance

Returns:

the container

getContainingDefinition

IAssemblyDefinition getContainingDefinition()

Description copied from interface: IInstance

Retrieve the Metaschema module definition on which the instance was declared.

Specified by:

getContainingDefinition in interface IInstance

Returns:

the Metaschema module definition on which the instance was declared

isEffectiveValueWrappedInXml

boolean isEffectiveValueWrappedInXml()

Indicate if the instance allows values without an XML element wrapper.

Returns:

true if the underlying data type is allowed to be unwrapped, or false otherwise