Module dev.metaschema.databind

Package dev.metaschema.databind.model

Interface IBoundInstanceModelFieldScalar

All Superinterfaces:

IAttributable, IBoundDefinition, IBoundDefinitionModel<Object>, IBoundDefinitionModelField<Object>, IBoundInstance<Object>, IBoundInstanceModel<Object>, IBoundInstanceModelField<Object>, IBoundInstanceModelNamed<Object>, IBoundModelElement, IBoundModelObject<Object>, IBoundProperty<Object>, IContainer, IDefaultable, IDefinition, IDescribable, IFeatureContainerFlag<IBoundInstanceFlag>, IFeatureDefinitionInstanceInlined<IBoundDefinitionModelField<Object>,IBoundInstanceModelFieldScalar>, IFeatureJavaField, IFeatureScalarItemValueHandler, IFeatureValueConstrained, IField, IFieldDefinition, IFieldInstance, IFieldInstanceAbsolute, IGroupable, IInstance, IInstanceAbsolute, IItemValueHandler<Object>, IJsonInstance, IJsonNamed, IModelDefinition, IModelElement, IModelElementVisitable, IModelInstance, IModelInstanceAbsolute, INamed, INamedInstance, INamedModelElement, INamedModelInstance, INamedModelInstanceAbsolute, IValueConstrained, IValued, IValuedDefinition, IValuedInstance, IValuedMutable

public interface IBoundInstanceModelFieldScalar
extends IBoundInstanceModelField<Object>, IBoundDefinitionModelField<Object>, IFeatureScalarItemValueHandler, IFeatureDefinitionInstanceInlined<IBoundDefinitionModelField<Object>,IBoundInstanceModelFieldScalar>

Represents a bound field instance that contains scalar (simple) data, such as a string or number value.

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

Method Summary

Modifier and Type	Method	Description
default <CONTEXT, RESULT> RESULT	accept(IModelElementVisitor<CONTEXT,RESULT> visitor, CONTEXT context)	A visitor callback.
IBoundDefinitionModelAssembly	getContainingDefinition()	Retrieve the Metaschema module definition on which the instance was declared.
default IBoundDefinitionModelField<Object>	getDefinition()	Retrieve the definition of this instance.
default Object	getFieldValue(Object item)	Get the value of the field's value from the field item object.
default IContainerFlagSupport<IBoundInstanceFlag>	getFlagContainer()	Lazy initialize the flag instances associated with this definition.
default IBoundInstanceModelFieldScalar	getInlineInstance()	If IDefinition.isInline() is true, return the instance the definition is inlined for.
default IBoundInstanceFlag	getItemJsonKey(Object item)	Get the JSON key flag for the provided item.
default IBoundInstanceFlag	getJsonKey()	Get the JSON key associated with this instance.
default IBoundInstanceFlag	getJsonValueKeyFlagInstance()	Retrieves the flag instance whose value will be used as the "value key".
default String	getJsonValueKeyName()	Retrieves the configured static label to use as the value key, or the type specific name if a label is not configured.
default boolean	isInline()	Determine if the definition is defined inline, meaning the definition is declared where it is used.
default Object	readItem(IBoundObject parent, IItemReadHandler handler)	Parse and return an item.
default void	writeItem(Object item, IItemWriteHandler handler)	Write the provided item.

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

getProperties, getPropertyValues, hasProperty, hasPropertyValue

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

getBindingContext

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

getContainingModule, getValue, setValue

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

deepCopy, getCollectionInfo, getResolvedDefaultValue

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

canHandleXmlQName

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

getEffectiveJsonKey, getIndex, getItemValues, getName

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

getDefaultValue

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

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.databind.model.IFeatureJavaField

getField, getItemType, getType

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

deepCopyItem, getJavaTypeAdapter, getValueFromString, setValue

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

getEffectiveJsonValueKeyName, getJsonValueKey, hasJsonValueKeyFlagInstance

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

isInXmlWrapped

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

isEffectiveValueWrappedInXml

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

hasChildren

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

getRemarks

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

getParentContainer

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

getQName, getUseIndex, getUseName

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

getReferencedDefinitionQName

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

hasJsonKey

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

getJsonName

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

getJavaTypeAdapter

Method Details

getDefinition

default IBoundDefinitionModelField<Object> getDefinition()

Description copied from interface: INamedInstance

Retrieve the definition of this instance.

Specified by:

getDefinition in interface IBoundInstanceModelField<Object>

Specified by:

getDefinition in interface IBoundInstanceModelNamed<Object>

Specified by:

getDefinition in interface IFeatureDefinitionInstanceInlined<IBoundDefinitionModelField<Object>,IBoundInstanceModelFieldScalar>

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 corresponding definition

isInline

default 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<IBoundDefinitionModelField<Object>,IBoundInstanceModelFieldScalar>

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

default IBoundInstanceModelFieldScalar 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 IBoundDefinitionModel<Object>

Specified by:

getInlineInstance in interface IBoundDefinitionModelField<Object>

Specified by:

getInlineInstance in interface IDefinition

Specified by:

getInlineInstance in interface IFeatureDefinitionInstanceInlined<IBoundDefinitionModelField<Object>,IBoundInstanceModelFieldScalar>

Specified by:

getInlineInstance in interface IFieldDefinition

Returns:

the instance or null otherwise

See Also:

• IDefinition.isInline()

getContainingDefinition

IBoundDefinitionModelAssembly getContainingDefinition()

Description copied from interface: IInstance

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

Specified by:

getContainingDefinition in interface IBoundInstance<Object>

Specified by:

getContainingDefinition in interface IBoundInstanceModel<Object>

Specified by:

getContainingDefinition in interface IInstance

Specified by:

getContainingDefinition in interface IModelInstance

Returns:

the Metaschema module definition on which the instance was declared

getFlagContainer

default IContainerFlagSupport<IBoundInstanceFlag> getFlagContainer()

Description copied from interface: IFeatureContainerFlag

Lazy initialize the flag instances associated with this definition.

Specified by:

getFlagContainer in interface IFeatureContainerFlag<IBoundInstanceFlag>

Returns:

the flag container

getJsonKey

default IBoundInstanceFlag getJsonKey()

Description copied from interface: INamedModelInstance

Get the JSON key associated with this instance.

Specified by:

getJsonKey in interface IBoundInstanceModelNamed<Object>

Specified by:

getJsonKey in interface IFeatureContainerFlag<IBoundInstanceFlag>

Specified by:

getJsonKey in interface IModelDefinition

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<Object>

Specified by:

getItemJsonKey in interface IBoundInstanceModelNamed<Object>

Parameters:

item - the item to get the JSON key flag for

Returns:

the JSON key flag

getFieldValue

default Object getFieldValue(Object item)

Description copied from interface: IFieldDefinition

Get the value of the field's value from the field item object.

Specified by:

getFieldValue in interface IFieldDefinition

Parameters:

item - the field item

Returns:

the field's value or null if it has no value

getJsonValueKeyName

default String getJsonValueKeyName()

Description copied from interface: IFieldDefinition

Retrieves the configured static label to use as the value key, or the type specific name if a label is not configured.

Specified by:

getJsonValueKeyName in interface IFieldDefinition

Returns:

the value key label

getJsonValueKeyFlagInstance

default IBoundInstanceFlag getJsonValueKeyFlagInstance()

Description copied from interface: IFieldDefinition

Retrieves the flag instance whose value will be used as the "value key".

Specified by:

getJsonValueKeyFlagInstance in interface IBoundDefinitionModelField<Object>

Specified by:

getJsonValueKeyFlagInstance in interface IFieldDefinition

Returns:

the configured flag instance, or null if a flag is not configured as the "value key"

readItem

default Object readItem(IBoundObject parent,
 IItemReadHandler handler)
                 throws IOException

Description copied from interface: IItemValueHandler

Parse and return an item.

Specified by:

readItem in interface IItemValueHandler<Object>

Parameters:

parent - the parent Java object to use for serialization callbacks, or null if there is no parent

handler - the item parsing handler

Returns:

the Java object representing the parsed item

Throws:

IOException - if an error occurred while parsing

writeItem

default void writeItem(Object item,
 IItemWriteHandler handler)
                throws IOException

Description copied from interface: IItemValueHandler

Write the provided item.

Specified by:

writeItem in interface IItemValueHandler<Object>

Parameters:

item - the data to write

handler - the item writing handler

Throws:

IOException - if an error occurred while writing

accept

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

Description copied from interface: IModelElementVisitable

A visitor callback.

Specified by:

accept in interface IFieldDefinition

Specified by:

accept in interface IFieldInstanceAbsolute

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