Module dev.metaschema.databind

Package dev.metaschema.databind.model

Interface IBoundInstanceModelFieldComplex

All Superinterfaces:

IAttributable, IBoundInstance<IBoundObject>, IBoundInstanceModel<IBoundObject>, IBoundInstanceModelField<IBoundObject>, IBoundInstanceModelNamed<IBoundObject>, IBoundModelElement, IBoundModelObject<IBoundObject>, IBoundProperty<IBoundObject>, IDefaultable, IDescribable, IFeatureComplexItemValueHandler, IFeatureJavaField, IField, IFieldInstance, IFieldInstanceAbsolute, IGroupable, IInstance, IInstanceAbsolute, IItemValueHandler<IBoundObject>, IJsonInstance, IJsonNamed, IModelElement, IModelElementVisitable, IModelInstance, IModelInstanceAbsolute, INamed, INamedInstance, INamedModelElement, INamedModelInstance, INamedModelInstanceAbsolute, IValued, IValuedInstance, IValuedMutable

public interface IBoundInstanceModelFieldComplex
extends IBoundInstanceModelField<IBoundObject>, IFeatureComplexItemValueHandler

Represents a bound field instance that contains complex (non-scalar) data, such as an object with flags and a value.

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 void	callAfterDeserialize(IBoundObject targetObject, IBoundObject parentObject)	Invoke the after-deserialize lifecycle callback on the target object.
default void	callBeforeDeserialize(IBoundObject targetObject, IBoundObject parentObject)	Invoke the before-deserialize lifecycle callback on the target object.
default IBoundObject	deepCopyItem(IBoundObject item, IBoundObject parentInstance)	Create and return a deep copy of the provided item.
default Class<? extends IBoundObject>	getBoundClass()	The class this binding is to.
IBoundDefinitionModelFieldComplex	getDefinition()	Retrieve the definition of this instance.
default boolean	isEffectiveValueWrappedInXml()	Indicate if the instance allows values without an XML element wrapper.
default IBoundObject	readItem(IBoundObject parent, IItemReadHandler handler)	Parse and return an item.
default void	writeItem(IBoundObject 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.IBoundInstance

getContainingModule, getValue, setValue

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

deepCopy, getCollectionInfo, getContainingDefinition, getResolvedDefaultValue

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

canHandleXmlQName

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

getEffectiveJsonKey, getIndex, getItemJsonKey, getItemValues, getJsonKey, getName

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.info.IFeatureComplexItemValueHandler

getJsonProperties, newInstance

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

getField, getItemType, getType

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

getModelType

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

isInXmlWrapped

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

accept

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

getRemarks

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

getContainingDefinition, getParentContainer

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

IBoundDefinitionModelFieldComplex getDefinition()

Description copied from interface: INamedInstance

Retrieve the definition of this instance.

Specified by:

getDefinition in interface IBoundInstanceModelField<IBoundObject>

Specified by:

getDefinition in interface IBoundInstanceModelNamed<IBoundObject>

Specified by:

getDefinition in interface IFeatureComplexItemValueHandler

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

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 IFieldInstanceAbsolute

Specified by:

isEffectiveValueWrappedInXml in interface IModelInstance

Returns:

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

readItem

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

Description copied from interface: IItemValueHandler

Parse and return an item.

Specified by:

readItem in interface IItemValueHandler<IBoundObject>

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(IBoundObject item,
 IItemWriteHandler handler)
                throws IOException

Description copied from interface: IItemValueHandler

Write the provided item.

Specified by:

writeItem in interface IItemValueHandler<IBoundObject>

Parameters:

item - the data to write

handler - the item writing handler

Throws:

IOException - if an error occurred while writing

deepCopyItem

default IBoundObject deepCopyItem(IBoundObject item,
 IBoundObject parentInstance)
                           throws BindingException

Description copied from interface: IItemValueHandler

Create and return a deep copy of the provided item.

Specified by:

deepCopyItem in interface IFeatureComplexItemValueHandler

Specified by:

deepCopyItem in interface IItemValueHandler<IBoundObject>

Parameters:

item - the item to copy

parentInstance - an optional parent object to use for serialization callbacks

Returns:

the new deep copy

Throws:

BindingException - if an error occurred while analyzing the bound objects

getBoundClass

default Class<? extends IBoundObject> getBoundClass()

Description copied from interface: IFeatureComplexItemValueHandler

The class this binding is to.

Specified by:

getBoundClass in interface IFeatureComplexItemValueHandler

Returns:

the bound class

callBeforeDeserialize

default void callBeforeDeserialize(IBoundObject targetObject,
 IBoundObject parentObject)
                            throws BindingException

Description copied from interface: IFeatureComplexItemValueHandler

Invoke the before-deserialize lifecycle callback on the target object.

Specified by:

callBeforeDeserialize in interface IFeatureComplexItemValueHandler

Parameters:

targetObject - the object being deserialized

parentObject - the parent object containing the target, or null if there is no parent

Throws:

BindingException - if an error occurs during the callback

callAfterDeserialize

default void callAfterDeserialize(IBoundObject targetObject,
 IBoundObject parentObject)
                           throws BindingException

Description copied from interface: IFeatureComplexItemValueHandler

Invoke the after-deserialize lifecycle callback on the target object.

Specified by:

callAfterDeserialize in interface IFeatureComplexItemValueHandler

Parameters:

targetObject - the object that was deserialized

parentObject - the parent object containing the target, or null if there is no parent

Throws:

BindingException - if an error occurs during the callback