Module dev.metaschema.core

Package dev.metaschema.core.model

Interface IFieldInstance

All Superinterfaces:

IAttributable, IDefaultable, IDescribable, IField, IGroupable, IInstance, IJsonNamed, IModelElement, IModelElementVisitable, IModelInstance, INamed, INamedInstance, INamedModelElement, INamedModelInstance, IValuedInstance

All Known Subinterfaces:

IBoundInstanceModelField<ITEM>, IBoundInstanceModelFieldComplex, IBoundInstanceModelFieldScalar, IBoundInstanceModelGroupedField, IFieldInstanceAbsolute, IFieldInstanceGrouped

All Known Implementing Classes:

AbstractFieldInstance, AbstractInlineFieldDefinition

public interface IFieldInstance
extends IField, INamedModelInstance, IValuedInstance

Represents a field instance within an assembly definition.

A field instance references a field definition and specifies how that field is used within its containing assembly, including XML wrapping behavior.

Nested Class Summary

Nested classes/interfaces inherited from interface dev.metaschema.core.model.IAttributable

IAttributable.Key

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_FIELD_IN_XML_WRAPPED	The default value for whether a field is wrapped in XML.

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

DEFAULT_PROPERY_NAMESPACE

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
IFieldDefinition	getDefinition()	Retrieves the field definition referenced by this instance.
default boolean	isInXmlWrapped()	Determines if the field is configured to have a wrapper in XML.

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

getProperties, getPropertyValues, hasProperty, hasPropertyValue

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

getDefaultValue, getEffectiveDefaultValue, getResolvedDefaultValue

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

getDescription, getEffectiveDescription, getEffectiveFormalName, getFormalName

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

getModelType

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, getRemarks

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

accept

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

getContainingDefinition, getParentContainer, isEffectiveValueWrappedInXml

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

getEffectiveIndex, getEffectiveName, getIndex, getName, getQName, getUseIndex, getUseName

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

getReferencedDefinitionQName, isInlineDefinition

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

getJsonName

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

getEffectiveJsonKey, getJsonKey, hasJsonKey

Field Details

DEFAULT_FIELD_IN_XML_WRAPPED

static final boolean DEFAULT_FIELD_IN_XML_WRAPPED

The default value for whether a field is wrapped in XML.

See Also:

• Constant Field Values

Method Details

getDefinition

IFieldDefinition getDefinition()

Retrieves the field definition referenced by this instance.

Specified by:

getDefinition in interface INamedInstance

Specified by:

getDefinition in interface INamedModelInstance

Specified by:

getDefinition in interface IValuedInstance

Returns:

the field definition

isInXmlWrapped

default boolean isInXmlWrapped()

Determines if the field is configured to have a wrapper in XML.

Returns:

true if an XML wrapper is required, or false otherwise

See Also:

• DEFAULT_FIELD_IN_XML_WRAPPED