io.jmix.core.metamodel.model

Interface MetaClass

All Superinterfaces:

MetadataObject

All Known Implementing Classes:

KeyValueMetaClass, MetaClassImpl

public interface MetaClass
extends MetadataObject

Metadata object representing an entity.

Method Summary

Modifier and Type	Method and Description
MetaProperty	findProperty(java.lang.String name) Get MetaProperty by its name.
MetaClass	getAncestor() Immediate ancestor of the object, or null if there is no one.
java.util.List<MetaClass>	getAncestors() All ancestors of the metaclass, in order going up from the immediate ancestor.
java.util.Collection<MetaClass>	getDescendants() All descendants of the metaclass, recursively.
<T> java.lang.Class<T>	getJavaClass()
java.util.Collection<MetaProperty>	getOwnProperties()
java.util.Collection<MetaProperty>	getProperties()
MetaProperty	getProperty(java.lang.String name) Get MetaProperty by its name.
MetaPropertyPath	getPropertyPath(java.lang.String propertyPath) Returns MetaPropertyPath object, representing path to the property from the current class
Session	getSession()
Store	getStore()

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.

getJavaClass

<T> java.lang.Class<T> getJavaClass()

Returns:

corresponding Java class

getAncestor

@Nullable
MetaClass getAncestor()

Immediate ancestor of the object, or null if there is no one.

getAncestors

java.util.List<MetaClass> getAncestors()

All ancestors of the metaclass, in order going up from the immediate ancestor.

getDescendants

java.util.Collection<MetaClass> getDescendants()

All descendants of the metaclass, recursively. Order is undefined.

findProperty

@Nullable
MetaProperty findProperty(java.lang.String name)

Get MetaProperty by its name.

Returns:

MetaProperty instance, or null if no such property found

getProperty

MetaProperty getProperty(java.lang.String name)

Get MetaProperty by its name.

Returns:

MetaProperty instance. Throws exception if not found.

getPropertyPath

@Nullable
MetaPropertyPath getPropertyPath(java.lang.String propertyPath)

Returns MetaPropertyPath object, representing path to the property from the current class

Parameters:

propertyPath - dot-separated string

Returns:

MetaPropertyPath instance, or null if the input parameter doesn't represent a valid path.

getOwnProperties

java.util.Collection<MetaProperty> getOwnProperties()

Returns:

collection of meta properties directly owned by this metaclass.

getProperties

java.util.Collection<MetaProperty> getProperties()

Returns:

collection of meta properties owned by this metaclass and all its ancestors.

getStore

Store getStore()