io.jmix.core.metamodel.model

Interface MetaProperty

All Superinterfaces:

MetadataObject

All Known Implementing Classes:

KeyValueMetaProperty, MetaPropertyImpl

public interface MetaProperty
extends MetadataObject

Metadata object representing an entity attribute.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MetaProperty.Type Property type

Method Summary

Modifier and Type	Method and Description
java.lang.reflect.AnnotatedElement	getAnnotatedElement()
java.lang.Class<?>	getDeclaringClass()
MetaClass	getDomain()
MetaProperty	getInverse()
java.lang.Class<?>	getJavaType()
Range	getRange()
Session	getSession()
Store	getStore()
MetaProperty.Type	getType()
boolean	isMandatory()
boolean	isReadOnly()

Methods inherited from interface io.jmix.core.metamodel.model.MetadataObject

getAnnotations, getName

Method Detail

getSession

@Nullable
Session getSession()

Returns:

containing MetaModel instance. Null signifies a temporary metaclass, not associated with an entity class.

getDomain

MetaClass getDomain()

Returns:

MetaClass, containing this MetaProperty.
In case of ReplaceEntity returns extended meta class.

getRange

Range getRange()

Returns:

Range of this property.

getType

MetaProperty.Type getType()

Returns:

property type (DATATYPE, ENUM, ASSOCIATION, COMPOSITION)

isMandatory

boolean isMandatory()

Returns:

true if the corresponding entity attribute must contain a value

isReadOnly

boolean isReadOnly()

Returns:

true if the corresponding entity attribute is read-only

getInverse

@Nullable
MetaProperty getInverse()

Returns:

a MetaProperty from the opposite side of relation, or null if this is not a reference property

getAnnotatedElement

java.lang.reflect.AnnotatedElement getAnnotatedElement()

Returns:

corresponding Java field or method as AnnotatedElement object

getJavaType

java.lang.Class<?> getJavaType()

Returns:

Java class of the corresponding field or method's return type

getDeclaringClass

@Nullable
java.lang.Class<?> getDeclaringClass()

Returns:

Java class which declares the corresponding field or method

getStore

Store getStore()