Module dev.metaschema.databind

Package dev.metaschema.databind.model

Interface IBoundInstanceModelNamed<ITEM>

Type Parameters:

ITEM - the Java type of the bound item

All Superinterfaces:

IAttributable, IBoundInstance<ITEM>, IBoundInstanceModel<ITEM>, IBoundModelElement, IBoundModelObject<ITEM>, IBoundProperty<ITEM>, IDefaultable, IDescribable, IFeatureJavaField, IGroupable, IInstance, IInstanceAbsolute, IItemValueHandler<ITEM>, IJsonInstance, IJsonNamed, IModelElement, IModelElementVisitable, IModelInstance, IModelInstanceAbsolute, INamed, INamedInstance, INamedModelElement, INamedModelInstance, INamedModelInstanceAbsolute, IValued, IValuedMutable

All Known Subinterfaces:

IBoundInstanceModelAssembly, IBoundInstanceModelField<ITEM>, IBoundInstanceModelFieldComplex, IBoundInstanceModelFieldScalar

public interface IBoundInstanceModelNamed<ITEM>
extends IBoundInstanceModel<ITEM>, INamedModelInstanceAbsolute

Represents a bound model instance that is named and can be addressed by that name in the Metaschema model.

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.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 boolean	canHandleXmlQName(IEnhancedQName qname)	Determine if the provided XML qualified name is associated with this property.
IBoundDefinitionModel<ITEM>	getDefinition()	Retrieve the definition of this instance.
default IBoundInstanceFlag	getEffectiveJsonKey()	Get the JSON key flag instance for this model instance, if one is configured.
default Integer	getIndex()	Retrieve the index value to use for binary naming.
default IBoundInstanceFlag	getItemJsonKey(Object item)	Get the JSON key flag for the provided item.
default Collection<? extends Object>	getItemValues(Object value)	Get the item values associated with the provided value.
default IBoundInstanceFlag	getJsonKey()	Get the JSON key associated with this instance.
default String	getName()	Retrieve the name of the model element.

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

getProperties, getPropertyValues, hasProperty, hasPropertyValue

Methods inherited from interface dev.metaschema.databind.model.IBoundInstance

getContainingModule, getValue, setValue

Methods inherited from interface dev.metaschema.databind.model.IBoundInstanceModel

deepCopy, getCollectionInfo, getContainingDefinition, getResolvedDefaultValue

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

getDefaultValue, getEffectiveDefaultValue

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

getDescription, getEffectiveDescription, getEffectiveFormalName, getFormalName

Methods inherited from interface dev.metaschema.databind.model.IFeatureJavaField

getField, getItemType, getType

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

getEffectiveXmlGroupAsQName, getGroupAsName, getJsonGroupAsBehavior, getMaxOccurs, getMinOccurs, getXmlGroupAsBehavior

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

toCoordinates

Methods inherited from interface dev.metaschema.databind.model.info.IItemValueHandler

deepCopyItem, readItem, writeItem

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

getModelType, 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, getQName, getUseIndex, getUseName

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

getReferencedDefinitionQName, isInlineDefinition

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

hasJsonKey

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

getJsonName

Method Details

getDefinition

@NonNull
IBoundDefinitionModel<ITEM> getDefinition()

Description copied from interface: INamedInstance

Retrieve the definition of this instance.

Specified by:

getDefinition in interface INamedInstance

Specified by:

getDefinition in interface INamedModelInstance

Returns:

the corresponding definition

getName

default String getName()

Description copied from interface: INamed

Retrieve the name of the model element.

Specified by:

getName in interface INamed

Returns:

the name

getIndex

default Integer getIndex()

Description copied from interface: INamed

Retrieve the index value to use for binary naming.

Specified by:

getIndex in interface INamed

Returns:

the name index or null if no name index is defined

getEffectiveJsonKey

@Nullable
default IBoundInstanceFlag getEffectiveJsonKey()

Description copied from interface: INamedModelInstance

Get the JSON key flag instance for this model instance, if one is configured.

Specified by:

getEffectiveJsonKey in interface INamedModelInstance

Specified by:

getEffectiveJsonKey in interface INamedModelInstanceAbsolute

Returns:

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

getJsonKey

default IBoundInstanceFlag getJsonKey()

Description copied from interface: INamedModelInstance

Get the JSON key associated with this instance.

Specified by:

getJsonKey in interface INamedModelInstance

Specified by:

getJsonKey in interface INamedModelInstanceAbsolute

Returns:

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

getItemJsonKey

default IBoundInstanceFlag getItemJsonKey(Object item)

Description copied from interface: IBoundInstanceModel

Get the JSON key flag for the provided item.

Specified by:

getItemJsonKey in interface IBoundInstanceModel<ITEM>

Parameters:

item - the item to get the JSON key flag for

Returns:

the JSON key flag

getItemValues

default Collection<? extends Object> getItemValues(Object value)

Description copied from interface: IBoundInstanceModel

Get the item values associated with the provided value.

Specified by:

getItemValues in interface IBoundInstanceModel<ITEM>

Specified by:

getItemValues in interface IGroupable

Parameters:

value - the value which may be a singleton or a collection

Returns:

the ordered collection of values

canHandleXmlQName

default boolean canHandleXmlQName(IEnhancedQName qname)

Description copied from interface: IBoundModelObject

Determine if the provided XML qualified name is associated with this property.

Specified by:

canHandleXmlQName in interface IBoundModelObject<ITEM>

Parameters:

qname - the XML qualified name of the property being parsed

Returns:

true if the instance will handle this name, or false otherwise