Module dev.metaschema.databind

Package dev.metaschema.databind.model

Interface IBoundDefinitionModelFieldComplex

All Superinterfaces:

IAttributable, IBoundDefinition, IBoundDefinitionModel<IBoundObject>, IBoundDefinitionModelComplex, IBoundDefinitionModelField<IBoundObject>, IBoundModelElement, IBoundModelObject<IBoundObject>, IContainer, IDefaultable, IDefinition, IDescribable, IFeatureComplexItemValueHandler, IFeatureContainerFlag<IBoundInstanceFlag>, IFeatureValueConstrained, IField, IFieldDefinition, IItemValueHandler<IBoundObject>, IJsonNamed, IModelDefinition, IModelElement, IModelElementVisitable, INamed, INamedModelElement, IValueConstrained, IValuedDefinition

public interface IBoundDefinitionModelFieldComplex
extends IBoundDefinitionModelField<IBoundObject>, IBoundDefinitionModelComplex

Represents a field definition bound to a Java class.

This definition is considered "complex", since it is bound to a Java class.

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

Method Summary

Modifier and Type	Method	Description
default boolean	canHandleXmlQName(IEnhancedQName qname)	Determine if the provided XML qualified name is associated with this property.
default Object	getDefaultValue()	Retrieves the default data value for this model construct.
default IBoundDefinitionModelFieldComplex	getDefinition()	Get the Metaschema definition representing the bound complex data.
IBoundFieldValue	getFieldValue()	Get the bound field value associated with this field.
default Object	getFieldValue(Object item)	Get the value of the field's value from the field item object.
default IDataTypeAdapter<?>	getJavaTypeAdapter()	Retrieves the data type of the definition's value.
default Map<String,IBoundProperty<?>>	getJsonProperties(Predicate<IBoundInstanceFlag> flagFilter)	Get a mapping of JSON property names to their corresponding bound properties.
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 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.IBoundDefinitionModel

getBindingContext, getInlineInstance

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

callAfterDeserialize, callBeforeDeserialize, getAfterDeserializeMethod, getBeforeDeserializeMethod

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

getInlineInstance, getJsonValueKeyFlagInstance

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

getContainingModule

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

getEffectiveDefaultValue, getResolvedDefaultValue

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

getDefinitionQName, getLocation, getModuleScope, toCoordinates

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

getDescription, getEffectiveDescription, getEffectiveFormalName, getFormalName

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

deepCopyItem, getBoundClass, getJsonProperties, newInstance

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

getFlagContainer, getFlagInstanceByName, getFlagInstances, getJsonKey

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, getJsonValueKey, hasJsonValueKeyFlagInstance, isInline

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

getEffectiveIndex, getEffectiveName, getIndex, getName, getQName, getUseIndex, getUseName

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

getJsonName

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

getSource

Method Details

getDefinition

@NonNull
default IBoundDefinitionModelFieldComplex getDefinition()

Description copied from interface: IFeatureComplexItemValueHandler

Get the Metaschema definition representing the bound complex data.

Specified by:

getDefinition in interface IFeatureComplexItemValueHandler

Returns:

the definition

getDefaultValue

default Object getDefaultValue()

Description copied from interface: IDefaultable

Retrieves the default data value for this model construct.

Child implementations are expected to override this method to provide a more reasonable default value.

Specified by:

getDefaultValue in interface IDefaultable

Returns:

the default value or null if there is no default

getFieldValue

@NonNull
IBoundFieldValue getFieldValue()

Get the bound field value associated with this field.

Returns:

the field's value binding

getFieldValue

@NonNull
default Object getFieldValue(@NonNull
 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

@NonNull
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

getJavaTypeAdapter

@NonNull
default IDataTypeAdapter<?> getJavaTypeAdapter()

Description copied from interface: IValuedDefinition

Retrieves the data type of the definition's value.

Specified by:

getJavaTypeAdapter in interface IValuedDefinition

Returns:

the data type

getJsonProperties

@NonNull
default Map<String,IBoundProperty<?>> getJsonProperties(@Nullable
 Predicate<IBoundInstanceFlag> flagFilter)

Description copied from interface: IBoundDefinitionModelComplex

Get a mapping of JSON property names to their corresponding bound properties.

Specified by:

getJsonProperties in interface IBoundDefinitionModelComplex

Parameters:

flagFilter - a predicate to filter which flag instances to include, or null to include all flags

Returns:

a map of property names to bound properties

readItem

@NonNull
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

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

Parameters:

qname - the XML qualified name of the property being parsed

Returns:

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