Module dev.metaschema.core

Package dev.metaschema.core.model

Class AbstractInlineFieldDefinition<PARENT extends IContainerModel,DEFINITION extends IFieldDefinition,INSTANCE extends IFieldInstance,PARENT_DEFINITION extends IAssemblyDefinition,FLAG extends IFlagInstance>

java.lang.Object

dev.metaschema.core.model.AbstractInstance<PARENT>

dev.metaschema.core.model.AbstractNamedInstance<PARENT>

dev.metaschema.core.model.AbstractNamedModelInstance<PARENT,PARENT_DEFINITION>

dev.metaschema.core.model.AbstractInlineFieldDefinition<PARENT,DEFINITION,INSTANCE,PARENT_DEFINITION,FLAG>

Type Parameters:

PARENT - the Java type of the parent model container for this instance

DEFINITION - the Java type of the related assembly definition

INSTANCE - the expected Java type of an instance of this definition

PARENT_DEFINITION - the Java type of the containing assembly definition

FLAG - the expected Java type of flag children

All Implemented Interfaces:

IFeatureValueConstrained, IValueConstrained, IAttributable, IContainer, IDefaultable, IDefinition, IDescribable, IFeatureContainerFlag<FLAG>, IFeatureDefinitionInstanceInlined<DEFINITION,INSTANCE>, IField, IFieldDefinition, IFieldInstance, IGroupable, IInstance, IJsonNamed, IModelDefinition, IModelElement, IModelElementVisitable, IModelInstance, INamed, INamedInstance, INamedModelElement, INamedModelInstance, IValuedDefinition, IValuedInstance

public abstract class AbstractInlineFieldDefinition<PARENT extends IContainerModel,DEFINITION extends IFieldDefinition,INSTANCE extends IFieldInstance,PARENT_DEFINITION extends IAssemblyDefinition,FLAG extends IFlagInstance>
extends AbstractNamedModelInstance<PARENT,PARENT_DEFINITION>
implements IFieldInstance, IFieldDefinition, IFeatureContainerFlag<FLAG>, IFeatureDefinitionInstanceInlined<DEFINITION,INSTANCE>

A base class for an assembly instance defined inline.

Nested Class Summary

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

IAttributable.Key

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

IDefinition.ModuleScope

Field Summary

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

DEFAULT_PROPERY_NAMESPACE

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

DEFAULT_MODULE_SCOPE

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractInlineFieldDefinition(PARENT parent)	Construct a new inline assembly definition.

Method Summary

Modifier and Type	Method	Description
final DEFINITION	getDefinition()	Retrieves the field definition referenced by this instance.
final INSTANCE	getInlineInstance()	If IDefinition.isInline() is true, return the instance the definition is inlined for.
final FLAG	getJsonKey()	Get the JSON key associated with this instance.
boolean	isInline()	Determine if the definition is defined inline, meaning the definition is declared where it is used.

Methods inherited from class dev.metaschema.core.model.AbstractNamedModelInstance

getContainingDefinition, getContainingModule

Methods inherited from class dev.metaschema.core.model.AbstractNamedInstance

getQName, getReferencedDefinitionQName

Methods inherited from class dev.metaschema.core.model.AbstractInstance

getParentContainer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getProperties, getPropertyValues, hasProperty, hasPropertyValue

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

getDefaultValue, getResolvedDefaultValue

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

getLocation, getModuleScope

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

getDescription, getFormalName

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

getFlagContainer, getFlagInstanceByName, getFlagInstances

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

getDefinitionQName, getEffectiveDefaultValue, getEffectiveDescription, getEffectiveFormalName, getEffectiveIndex, getEffectiveName, getSource, isInlineDefinition, toCoordinates

Methods inherited from interface dev.metaschema.core.model.constraint.IFeatureValueConstrained

addConstraint, addConstraint, addConstraint, addConstraint, addConstraint, addLetExpression, getAllowedValuesConstraints, getConstraints, getConstraintSupport, getExpectConstraints, getIndexHasKeyConstraints, getLetExpressions, getMatchesConstraints, getReportConstraints

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

getModelType

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

accept, getEffectiveJsonValueKeyName, getFieldValue, getJsonValueKey, getJsonValueKeyFlagInstance, getJsonValueKeyName, hasJsonValueKeyFlagInstance

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

isInXmlWrapped

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.IModelDefinition

hasChildren

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

getContainingModule, getRemarks

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

getContainingDefinition, getParentContainer, isEffectiveValueWrappedInXml

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

getIndex, getName, getQName, getUseIndex, getUseName

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

getReferencedDefinitionQName

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

getJsonName

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

getEffectiveJsonKey, hasJsonKey

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

getJavaTypeAdapter

Constructor Details

AbstractInlineFieldDefinition

protected AbstractInlineFieldDefinition(@NonNull
 PARENT parent)

Construct a new inline assembly definition.

Parameters:

parent - the parent model containing this instance

Method Details

getDefinition

public final DEFINITION getDefinition()

Description copied from interface: IFieldInstance

Retrieves the field definition referenced by this instance.

Specified by:

getDefinition in interface IFeatureDefinitionInstanceInlined<PARENT extends IContainerModel,DEFINITION extends IFieldDefinition>

Specified by:

getDefinition in interface IFieldInstance

Specified by:

getDefinition in interface INamedInstance

Specified by:

getDefinition in interface INamedModelInstance

Specified by:

getDefinition in interface IValuedInstance

Returns:

the field definition

isInline

public boolean isInline()

Description copied from interface: IDefinition

Determine if the definition is defined inline, meaning the definition is declared where it is used.

If this method returns false, then IDefinition.getInlineInstance() must return null.

Specified by:

isInline in interface IDefinition

Specified by:

isInline in interface IFeatureDefinitionInstanceInlined<PARENT extends IContainerModel,DEFINITION extends IFieldDefinition>

Specified by:

isInline in interface IFieldDefinition

Returns:

true if the definition is declared inline or false if the definition is able to be globally referenced

See Also:

• IDefinition.getInlineInstance()

getInlineInstance

@NonNull
public final INSTANCE getInlineInstance()

Description copied from interface: IDefinition

If IDefinition.isInline() is true, return the instance the definition is inlined for.

If this method returns null, then IDefinition.getInlineInstance() must return false.

Specified by:

getInlineInstance in interface IDefinition

Specified by:

getInlineInstance in interface IFeatureDefinitionInstanceInlined<PARENT extends IContainerModel,DEFINITION extends IFieldDefinition>

Specified by:

getInlineInstance in interface IFieldDefinition

Returns:

the instance or null otherwise

See Also:

• IDefinition.isInline()

getJsonKey

public final FLAG getJsonKey()

Description copied from interface: INamedModelInstance

Get the JSON key associated with this instance.

Specified by:

getJsonKey in interface IFeatureContainerFlag<PARENT extends IContainerModel>

Specified by:

getJsonKey in interface IModelDefinition

Specified by:

getJsonKey in interface INamedModelInstance

Returns:

the configured JSON key or null if no JSON key is configured