Module gov.nist.secauto.metaschema.databind

Package gov.nist.secauto.metaschema.databind.model

Class AbstractFieldProperty

java.lang.Object

gov.nist.secauto.metaschema.databind.model.AbstractFieldProperty

All Implemented Interfaces:

IField, IFieldInstance, IInstance, IModelElement, IModelInstance, INamedInstance, INamedModelElement, INamedModelInstance, IBoundFieldInstance, IBoundNamedInstance, IBoundNamedModelInstance

public abstract class AbstractFieldProperty
extends Object
implements IBoundFieldInstance

Constructor Summary

Constructors

Constructor	Description
AbstractFieldProperty(Field field, IAssemblyClassBinding parentClassBinding)

Method Summary

Modifier and Type	Method	Description
void	copyBoundObject(Object fromInstance, Object toInstance)	Copy this instance from one parent object to another.
Object	copyItem(Object fromItem, Object toInstance)
CLASS_BINDING	getContainingDefinition()
IDataTypeHandler	getDataTypeHandler()
MarkupLine	getDescription()
Field	getField()	Gets the bound Java field associated with this property.
protected BoundField	getFieldAnnotation()
String	getFormalName()
String	getGroupAsName()
String	getGroupAsXmlNamespace()
Collection<? extends Object>	getItemValues(Object value)	Get the item values associated with the provided value.
JsonGroupAsBehavior	getJsonGroupAsBehavior()
int	getMaxOccurs()
int	getMinOccurs()
CLASS_BINDING	getParentClassBinding()	Get the IClassBinding for the Java class within which this property exists.
CLASS_BINDING	getParentContainer()
IModelPropertyInfo	getPropertyInfo()	Gets information about the bound property.
MarkupMultiline	getRemarks()
String	getUseName()
XmlGroupAsBehavior	getXmlGroupAsBehavior()
boolean	isInXmlWrapped()
protected abstract IDataTypeHandler	newDataTypeHandler()
String	toCoordinates()

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.nist.secauto.metaschema.databind.model.IBoundFieldInstance

getDefinition

Methods inherited from interface gov.nist.secauto.metaschema.databind.model.IBoundNamedInstance

copyBoundObject, defaultValue, getField, getJavaFieldName, getName, getProperties, getType, getValue, setValue

Methods inherited from interface gov.nist.secauto.metaschema.databind.model.IBoundNamedModelInstance

copyItem, getDataTypeHandler, getItemType, getItemValues, getParentClassBinding, getPropertyInfo

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IField

getModelType

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IFieldInstance

getGroupAsXmlNamespace, getXmlNamespace, getXmlQName

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IInstance

getContainingModule

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IModelInstance

getContainingDefinition, getGroupAsName, getJsonGroupAsBehavior, getParentContainer, getXmlGroupAsBehavior, getXmlGroupAsQName

Methods inherited from interface gov.nist.secauto.metaschema.core.model.INamedInstance

getEffectiveDescription, getEffectiveFormalName, getEffectiveName

Methods inherited from interface gov.nist.secauto.metaschema.core.model.INamedModelElement

getPropertyValues, hasProperty, hasPropertyValue

Methods inherited from interface gov.nist.secauto.metaschema.core.model.INamedModelInstance

getJsonName

Constructor Detail

AbstractFieldProperty

public AbstractFieldProperty(@NonNull
                             Field field,
                             @NonNull
                             IAssemblyClassBinding parentClassBinding)

Method Detail

getFieldAnnotation

@NonNull
protected BoundField getFieldAnnotation()

getFormalName

public String getFormalName()

Specified by:

getFormalName in interface INamedModelElement

getDescription

public MarkupLine getDescription()

Specified by:

getDescription in interface INamedModelElement

getUseName

public String getUseName()

Specified by:

getUseName in interface INamedModelElement

isInXmlWrapped

public boolean isInXmlWrapped()

Specified by:

isInXmlWrapped in interface IFieldInstance

getMinOccurs

public int getMinOccurs()

Specified by:

getMinOccurs in interface IModelInstance

getMaxOccurs

public int getMaxOccurs()

Specified by:

getMaxOccurs in interface IModelInstance

getRemarks

public MarkupMultiline getRemarks()

Specified by:

getRemarks in interface IModelElement

toCoordinates

public String toCoordinates()

Specified by:

toCoordinates in interface IInstance

Specified by:

toCoordinates in interface IModelElement

Specified by:

toCoordinates in interface INamedInstance

newDataTypeHandler

protected abstract IDataTypeHandler newDataTypeHandler()

getDataTypeHandler

public IDataTypeHandler getDataTypeHandler()

Specified by:

getDataTypeHandler in interface IBoundNamedModelInstance

getField

public Field getField()

Description copied from interface: IBoundNamedInstance

Gets the bound Java field associated with this property.

Specified by:

getField in interface IBoundNamedInstance

Returns:

the Java field

getGroupAsName

public String getGroupAsName()

Specified by:

getGroupAsName in interface IModelInstance

getGroupAsXmlNamespace

public String getGroupAsXmlNamespace()

Specified by:

getGroupAsXmlNamespace in interface IModelInstance

getJsonGroupAsBehavior

public JsonGroupAsBehavior getJsonGroupAsBehavior()

Specified by:

getJsonGroupAsBehavior in interface IModelInstance

getXmlGroupAsBehavior

public XmlGroupAsBehavior getXmlGroupAsBehavior()

Specified by:

getXmlGroupAsBehavior in interface IModelInstance

getPropertyInfo

@NonNull
public IModelPropertyInfo getPropertyInfo()

Gets information about the bound property.

Specified by:

getPropertyInfo in interface IBoundNamedModelInstance

Returns:

the property information for the bound property

getItemValues

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

Description copied from interface: IBoundNamedModelInstance

Get the item values associated with the provided value.

Specified by:

getItemValues in interface IBoundNamedModelInstance

Specified by:

getItemValues in interface INamedModelInstance

Parameters:

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

Returns:

the ordered collection of values

copyBoundObject

public void copyBoundObject(@NonNull
                            Object fromInstance,
                            @NonNull
                            Object toInstance)
                     throws BindingException

Description copied from interface: IBoundNamedInstance

Copy this instance from one parent object to another.

Specified by:

copyBoundObject in interface IBoundNamedInstance

Parameters:

fromInstance - the object to copy from

toInstance - the object to copy to

Throws:

BindingException - if an error occurred while processing the object bindings

copyItem

public Object copyItem(Object fromItem,
                       Object toInstance)
                throws BindingException

Specified by:

copyItem in interface IBoundNamedModelInstance

Throws:

BindingException

getParentContainer

public CLASS_BINDING getParentContainer()

Specified by:

getParentContainer in interface IInstance

getContainingDefinition

public CLASS_BINDING getContainingDefinition()

Specified by:

getContainingDefinition in interface IInstance

getParentClassBinding

public CLASS_BINDING getParentClassBinding()

Description copied from interface: IBoundNamedInstance

Get the IClassBinding for the Java class within which this property exists.

Specified by:

getParentClassBinding in interface IBoundNamedInstance

Returns:

the containing class's binding