Module dev.metaschema.core

Package dev.metaschema.core.model

Interface IFieldInstanceGrouped

All Superinterfaces:

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

public interface IFieldInstanceGrouped
extends INamedModelInstanceGrouped, IFieldInstance

Represents a field instance that appears within a choice or other grouping construct.

Grouped field instances always have XML wrapping enabled and inherit cardinality from their containing group.

Nested Class Summary

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

IAttributable.Key

Field Summary

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

DEFAULT_PROPERY_NAMESPACE

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

DEFAULT_FIELD_IN_XML_WRAPPED

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
default <CONTEXT, RESULT> RESULT	accept(IModelElementVisitor<CONTEXT,RESULT> visitor, CONTEXT context)	A visitor callback.
default boolean	isEffectiveValueWrappedInXml()	Indicate if the instance allows values without an XML element wrapper.
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.IFieldInstance

getDefinition

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

getEffectiveXmlGroupAsQName, getGroupAsName, getItemValues, getJsonGroupAsBehavior, 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.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

hasJsonKey

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

getContainingDefinition, getDiscriminatorValue, getEffectiveDisciminatorValue, getEffectiveJsonKey, getJsonKey, getMaxOccurs, getMinOccurs, getParentContainer

Method Details

isInXmlWrapped

default boolean isInXmlWrapped()

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

Specified by:

isInXmlWrapped in interface IFieldInstance

Returns:

true if an XML wrapper is required, or false otherwise

See Also:

• IFieldInstance.DEFAULT_FIELD_IN_XML_WRAPPED

isEffectiveValueWrappedInXml

default boolean isEffectiveValueWrappedInXml()

Description copied from interface: IModelInstance

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

Specified by:

isEffectiveValueWrappedInXml in interface IModelInstance

Returns:

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

accept

default <CONTEXT,
RESULT> RESULT accept(@NonNull
 IModelElementVisitor<CONTEXT,RESULT> visitor,
 CONTEXT context)

A visitor callback.

Specified by:

accept in interface IModelElementVisitable

Type Parameters:

CONTEXT - the type of the context parameter

RESULT - the type of the visitor result

Parameters:

visitor - the calling visitor

context - a parameter used to pass contextual information between visitors

Returns:

the visitor result