MetadataTools (Jmix-core 1.1 API)

java.lang.Object
- io.jmix.core.MetadataTools

```
@Component(value="core_MetadataTools")
public class MetadataTools
extends java.lang.Object
```
Utility class to provide common metadata-related functionality.
Implemented as Spring bean to allow for extension in application projects.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MetadataTools.CachingEntitiesHolder
INTERNAL

static interface MetadataTools.EntitiesHolder
INTERNAL

Nested Classes
Modifier and Type	Class and Description
`static class`	`MetadataTools.CachingEntitiesHolder` INTERNAL
`static interface`	`MetadataTools.EntitiesHolder` INTERNAL

Field Summary

Fields
Modifier and Type	Field and Description
`protected CurrentAuthentication`	`currentAuthentication`
`protected DatatypeRegistry`	`datatypeRegistry`
`static java.lang.String`	`DELETED_BY_ANN_NAME`
`static java.lang.String`	`DELETED_DATE_ANN_NAME`
`static java.lang.String`	`EMBEDDED_ANN_NAME`
`protected java.util.Collection<java.lang.Class<?>>`	`enums`
`protected ExtendedEntities`	`extendedEntities`
`protected InstanceNameProvider`	`instanceNameProvider`
`static java.lang.String`	`LAST_MODIFIED_DATE_ANN_NAME`
`static java.lang.String`	`LENGTH_ANN_NAME`
`protected Messages`	`messages`
`protected Metadata`	`metadata`
`protected java.util.List<MetadataExtension>`	`metadataExtensions`
`protected java.util.Collection<MetaPropertyPathResolver>`	`metaPropertyPathResolvers`
`protected PersistentAttributesLoadChecker`	`persistentAttributesLoadChecker`
`static java.lang.String`	`PRIMARY_KEY_ANN_NAME`
`static java.lang.String`	`STORE_ANN_NAME`
`static java.lang.String`	`SYSTEM_ANN_NAME`
`static java.lang.String`	`TEMPORAL_ANN_NAME`
`static java.lang.String`	`UUID_KEY_ANN_NAME` Not applicable for legacy cuba entities

Constructor Summary

Constructors
Constructor and Description

MetadataTools()
Default constructor used by container at runtime and in server-side integration tests.

Constructors
Constructor and Description
`MetadataTools()` Default constructor used by container at runtime and in server-side integration tests.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`copy(java.lang.Object source, java.lang.Object dest)` Make a shallow copy of an instance.
`<T> T`	`copy(T source)` Create a new instance and make it a shallow copy of the instance given.
`protected static <T> T`	`createInstance(java.lang.Class<T> aClass)`
`protected static java.lang.Object`	`createInstanceWithId(java.lang.Class<?> entityClass, java.lang.Object id)`
`void`	`deepCopy(java.lang.Object source, java.lang.Object destination, MetadataTools.EntitiesHolder entitiesHolder)` Copies all property values from source to destination excluding null values.
`<T> T`	`deepCopy(T source)` Makes a deep copy of the source entity.
`boolean`	`fetchPlanContainsProperty(FetchPlan fetchPlan, MetaPropertyPath propertyPath)` Determine whether the fetch plan contains a property, traversing a fetch plan branch according to the given property path.
`java.lang.String`	`findDeletedByProperty(java.lang.Class<?> clazz)`
`java.lang.String`	`findDeletedDateProperty(java.lang.Class<?> clazz)`
`java.lang.String`	`findLastModifiedDateProperty(java.lang.Class<?> clazz)`
`protected java.lang.String`	`findPropertyByAnnotation(java.lang.Class<?> clazz, java.lang.String annotationName)`
`java.lang.String`	`format(java.lang.Object value)` Formats a value according to the value type.
`java.lang.String`	`format(java.lang.Object value, MetaProperty property)` Formats a value according to the property type.
`java.util.Set<MetaProperty>`	`getAdditionalProperties(MetaClass metaClass)` Returns all additional properties which are providing classes implement MetadataExtension interface
`java.util.Collection<java.lang.Class<?>>`	`getAllEnums()`
`java.util.Collection<MetaClass>`	`getAllJpaEmbeddableMetaClasses()`
`java.util.Collection<MetaClass>`	`getAllJpaEntityMetaClasses()`
`java.lang.String`	`getCrossDataStoreReferenceIdProperty(java.lang.String thisStore, MetaProperty metaProperty)` If the given property is a reference to an entity from different data store, returns the name of a persistent property which stores the identifier of the related entity.
`java.lang.String`	`getDatabaseColumn(MetaProperty metaProperty)`
`java.lang.String`	`getDatabaseTable(MetaClass metaClass)`
`java.lang.String`	`getDeletedDateProperty(java.lang.Object entity)`
`java.util.List<java.lang.String>`	`getDependsOnProperties(java.lang.Class<?> entityClass, java.lang.String property)`
`java.util.List<java.lang.String>`	`getDependsOnProperties(MetaProperty metaProperty)`
`java.util.Collection<MetaPropertyPath>`	`getFetchPlanPropertyPaths(FetchPlan fetchPlan, MetaClass metaClass)` Collects all meta-properties of the given meta-class included to the given fetchPlan as `MetaPropertyPath`s.
`java.lang.String`	`getInstanceName(java.lang.Object instance)`
`java.util.Collection<MetaProperty>`	`getInstanceNameRelatedProperties(MetaClass metaClass)` Return a collection of properties included into entity's name pattern (see `InstanceName`).
`java.util.Collection<MetaProperty>`	`getInstanceNameRelatedProperties(MetaClass metaClass, boolean useOriginal)` Return a collection of properties included into entity's name pattern (see `InstanceName`).
`java.util.Map<java.lang.String,java.lang.Object>`	`getMetaAnnotationAttributes(java.util.Map<java.lang.String,java.lang.Object> metaAnnotations, java.lang.Class metaAnnotationClass)`
`<T> T`	`getMetaAnnotationValue(MetaProperty metaProperty, java.lang.Class metaAnnotationClass)`
`java.lang.String`	`getPrimaryKeyName(MetaClass metaClass)`
`MetaProperty`	`getPrimaryKeyProperty(java.lang.Class<?> entityClass)`
`MetaProperty`	`getPrimaryKeyProperty(MetaClass metaClass)`
`MetaClass`	`getPropertyEnclosingMetaClass(MetaPropertyPath propertyPath)` Get metaclass that contains metaproperty for passed propertyPath.
`java.util.Collection<MetaPropertyPath>`	`getPropertyPaths(MetaClass metaClass)`
`java.util.List<java.lang.String>`	`getSoftDeleteProperties(java.lang.Class<?> clazz)`
`java.util.List<java.lang.String>`	`getSystemProperties(MetaClass metaClass)` System Properties - is important properties used for identification, audit, soft-delete and optimistic lock purposes More formally, it is properties with annotations: `Id`, `JmixId`, `EmbeddedId` `JmixGeneratedValue` `CreatedDate` `CreatedBy` `LastModifiedDate` `LastModifiedBy` `DeletedDate` `DeletedBy` `Version`
`java.lang.String`	`getUuidPropertyName(java.lang.Class<?> clazz)`
`boolean`	`hasCompositePrimaryKey(MetaClass metaClass)`
`boolean`	`hasDbGeneratedPrimaryKey(MetaClass metaClass)`
`boolean`	`hasUuid(MetaClass metaClass)` Checks whether an entity has uuid key (primary or not)
`protected void`	`internalTraverseAttributes(Entity entity, EntityAttributeVisitor visitor, java.util.HashSet<java.lang.Object> visited)`
`protected void`	`internalTraverseAttributesByFetchPlan(FetchPlan fetchPlan, java.lang.Object entity, EntityAttributeVisitor visitor, java.util.Map<java.lang.Object,java.util.Set<FetchPlan>> visited, boolean checkLoaded)`
`boolean`	`isAdditionalProperty(MetaClass metaClass, java.lang.String propertyName)`
`boolean`	`isAnnotationPresent(java.lang.Class javaClass, java.lang.String property, java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)` Determine whether the given annotation is present in the object's class or in any of its superclasses.
`boolean`	`isAnnotationPresent(java.lang.Object object, java.lang.String property, java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)` Determine whether the given annotation is present in the object's class or in any of its superclasses.
`boolean`	`isAssignableFrom(MetaClass metaClass, MetaClass other)`
`boolean`	`isCacheable(MetaClass metaClass)`
`boolean`	`isCascade(MetaProperty metaProperty)` Determine whether an object denoted by the given property is merged into persistence context together with the owning object.
`boolean`	`isEmbedded(MetaProperty metaProperty)` Determine whether the given property denotes an embedded object.
`boolean`	`isJpa(MetaProperty metaProperty)` Determine whether the given property is a persistent attribute of a JPA entity or embeddable.
`boolean`	`isJpa(MetaPropertyPath metaPropertyPath)` Determine whether all the properties defined by the given property path are persistent attributes of JPA entities or embeddables.
`boolean`	`isJpaEmbeddable(java.lang.Class<?> aClass)` Determine whether the given entity class is JPA embeddable.
`boolean`	`isJpaEmbeddable(MetaClass metaClass)` Determine whether the given meta-class is JPA embeddable.
`boolean`	`isJpaEntity(java.lang.Class<?> aClass)` Determine whether the given class represents a JPA entity.
`boolean`	`isJpaEntity(MetaClass metaClass)` Determine whether the given meta-class represents a JPA entity.
`boolean`	`isLob(MetaProperty metaProperty)` Determine whether the given property is a LOB.
`boolean`	`isOwningSide(MetaProperty metaProperty)` Determine whether the given property is on the owning side of an association.
`boolean`	`isSoftDeletable(java.lang.Class<?> entityClass)` Determine whether the entity supports Soft Deletion.
`boolean`	`isSystem(MetaProperty metaProperty)` Determine whether the given property is system.
`boolean`	`isSystemLevel(MetaClass metaClass)` Determine whether the given entity is marked as `SystemLevel`.
`boolean`	`isSystemLevel(MetaProperty metaProperty)` Determine whether the given property is marked as `SystemLevel`.
`MetaPropertyPath`	`resolveMetaPropertyPath(MetaClass metaClass, java.lang.String propertyPath)` Returns a `MetaPropertyPath` which can include the special MetaProperty for a dynamic attribute.
`MetaPropertyPath`	`resolveMetaPropertyPathOrNull(MetaClass metaClass, java.lang.String propertyPath)` Returns a `MetaPropertyPath` which can include the special MetaProperty for a dynamic attribute.
`java.util.Collection<MetaPropertyPath>`	`toPropertyPaths(java.util.Collection<MetaProperty> properties)` Converts a collection of properties to collection of `MetaPropertyPath`s containing one property each
`void`	`traverseAttributes(java.lang.Object entity, EntityAttributeVisitor visitor)` Depth-first traversal of the object graph starting from the specified entity instance.
`void`	`traverseAttributesByFetchPlan(FetchPlan fetchPlan, java.lang.Object entity, boolean checkLoaded, EntityAttributeVisitor visitor)` Depth-first traversal of the object graph by the fetch plan starting from the specified entity instance.
`void`	`traverseAttributesByFetchPlan(FetchPlan fetchPlan, java.lang.Object entity, EntityAttributeVisitor visitor)` Depth-first traversal of the object graph by the fetch plan starting from the specified entity instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PRIMARY_KEY_ANN_NAME
```
public static final java.lang.String PRIMARY_KEY_ANN_NAME
```
    See Also:
    
    Constant Field Values
  - EMBEDDED_ANN_NAME
```
public static final java.lang.String EMBEDDED_ANN_NAME
```
    See Also:
    
    Constant Field Values
  - TEMPORAL_ANN_NAME
```
public static final java.lang.String TEMPORAL_ANN_NAME
```
    See Also:
    
    Constant Field Values
  - SYSTEM_ANN_NAME
```
public static final java.lang.String SYSTEM_ANN_NAME
```
    See Also:
    
    Constant Field Values
  - STORE_ANN_NAME
```
public static final java.lang.String STORE_ANN_NAME
```
    See Also:
    
    Constant Field Values
  - LENGTH_ANN_NAME
```
public static final java.lang.String LENGTH_ANN_NAME
```
    See Also:
    
    Constant Field Values
  - UUID_KEY_ANN_NAME
```
public static final java.lang.String UUID_KEY_ANN_NAME
```
    Not applicable for legacy cuba entities
    
    See Also:
    
    Constant Field Values
  - DELETED_DATE_ANN_NAME
```
public static final java.lang.String DELETED_DATE_ANN_NAME
```
  - DELETED_BY_ANN_NAME
```
public static final java.lang.String DELETED_BY_ANN_NAME
```
  - LAST_MODIFIED_DATE_ANN_NAME
```
public static final java.lang.String LAST_MODIFIED_DATE_ANN_NAME
```
  - metadata
```
@Autowired
protected Metadata metadata
```
  - extendedEntities
```
@Autowired
protected ExtendedEntities extendedEntities
```
  - messages
```
@Autowired
protected Messages messages
```
  - instanceNameProvider
```
@Autowired
protected InstanceNameProvider instanceNameProvider
```
  - metadataExtensions
```
@Autowired(required=false)
protected java.util.List<MetadataExtension> metadataExtensions
```
  - currentAuthentication
```
@Autowired
protected CurrentAuthentication currentAuthentication
```
  - datatypeRegistry
```
@Autowired
protected DatatypeRegistry datatypeRegistry
```
  - persistentAttributesLoadChecker
```
@Autowired
protected PersistentAttributesLoadChecker persistentAttributesLoadChecker
```
  - metaPropertyPathResolvers
```
@Autowired(required=false)
protected java.util.Collection<MetaPropertyPathResolver> metaPropertyPathResolvers
```
  - enums
```
protected volatile java.util.Collection<java.lang.Class<?>> enums
```
- Constructor Detail
  - MetadataTools
```
public MetadataTools()
```
    Default constructor used by container at runtime and in server-side integration tests.
- Method Detail
  - format
```
public java.lang.String format(@Nullable
                               java.lang.Object value,
                               MetaProperty property)
```
    Formats a value according to the property type.
    
    Parameters:
    
    value - value of the passed property to format
    
    property - property
    
    Returns:
    
    formatted value as string
  - format
```
public java.lang.String format(@Nullable
                               java.lang.Object value)
```
    Formats a value according to the value type.
    
    Parameters:
    
    value - object to format
    
    Returns:
    
    formatted value as string
  - getInstanceName
```
public java.lang.String getInstanceName(java.lang.Object instance)
```
    Parameters:
    
    instance - instance
    
    Returns:
    
    Instance name as defined by InstanceName or toString().
  - getPrimaryKeyName
```
@Nullable
public java.lang.String getPrimaryKeyName(MetaClass metaClass)
```
    Returns:
    
    name of a primary key attribute, or null if the entity has no primary key (e.g. embeddable)
  - getPrimaryKeyProperty
```
@Nullable
public MetaProperty getPrimaryKeyProperty(MetaClass metaClass)
```
    Returns:
    
    MetaProperty representing a primary key attribute, or null if the entity has no primary key (e.g. embeddable)
  - getPrimaryKeyProperty
```
@Nullable
public MetaProperty getPrimaryKeyProperty(java.lang.Class<?> entityClass)
```
    Returns:
    
    MetaProperty representing a primary key attribute, or null if the entity has no primary key (e.g. embeddable)
  - hasCompositePrimaryKey
```
public boolean hasCompositePrimaryKey(MetaClass metaClass)
```
    Returns:
    
    true if passed MetaClass has a composite primary key
  - hasDbGeneratedPrimaryKey
```
public boolean hasDbGeneratedPrimaryKey(MetaClass metaClass)
```
    Returns:
    
    true if passed MetaClass has a db generated primary key
  - isAssignableFrom
```
public boolean isAssignableFrom(MetaClass metaClass,
                                MetaClass other)
```
    Returns:
    
    true if the first MetaClass is equal or an ancestor of the second.
  - isCascade
```
public boolean isCascade(MetaProperty metaProperty)
```
    Determine whether an object denoted by the given property is merged into persistence context together with the owning object. This is true if the property is ManyToMany, or if it is OneToMany with certain CascadeType defined.
  - isSoftDeletable
```
public boolean isSoftDeletable(java.lang.Class<?> entityClass)
```
    Determine whether the entity supports Soft Deletion.
    
    Parameters:
    
    entityClass - entity class
    
    Returns:
    
    true if the entity has @DeletedDate field
  - isSystem
```
public boolean isSystem(MetaProperty metaProperty)
```
    Determine whether the given property is system. A property is considered system if it has one of the following annotations:
    - Id
    - JmixId
    - JmixGeneratedValue
    - Version
    - CreatedDate
    - CreatedBy
    - LastModifiedDate
    - LastModifiedBy
    - DeletedDate
    - DeletedBy
  - getSystemProperties
```
public java.util.List<java.lang.String> getSystemProperties(MetaClass metaClass)
```
    System Properties - is important properties used for identification, audit, soft-delete and optimistic lock purposes More formally, it is properties with annotations:
    - Id,
    - JmixId,
    - EmbeddedId
    - JmixGeneratedValue
    - CreatedDate
    - CreatedBy
    - LastModifiedDate
    - LastModifiedBy
    - DeletedDate
    - DeletedBy
    - Version
    Returns:
    
    names of system properties used in Entity determined by metaClass parameter
  - isJpa
```
public boolean isJpa(MetaPropertyPath metaPropertyPath)
```
    Determine whether all the properties defined by the given property path are persistent attributes of JPA entities or embeddables.
    
    See Also:
    
    isJpa(io.jmix.core.metamodel.model.MetaProperty)
  - isJpa
```
public boolean isJpa(MetaProperty metaProperty)
```
    Determine whether the given property is a persistent attribute of a JPA entity or embeddable.
  - isEmbedded
```
public boolean isEmbedded(MetaProperty metaProperty)
```
    Determine whether the given property denotes an embedded object.
    
    See Also:
    
    Embedded, EmbeddedId
  - isLob
```
public boolean isLob(MetaProperty metaProperty)
```
    Determine whether the given property is a LOB.
    
    See Also:
    
    Lob
  - isOwningSide
```
public boolean isOwningSide(MetaProperty metaProperty)
```
    Determine whether the given property is on the owning side of an association.
  - isSystemLevel
```
public boolean isSystemLevel(MetaClass metaClass)
```
    Determine whether the given entity is marked as SystemLevel.
  - isSystemLevel
```
public boolean isSystemLevel(MetaProperty metaProperty)
```
    Determine whether the given property is marked as SystemLevel.
  - getMetaAnnotationAttributes
```
public java.util.Map<java.lang.String,java.lang.Object> getMetaAnnotationAttributes(java.util.Map<java.lang.String,java.lang.Object> metaAnnotations,
                                                                                    java.lang.Class metaAnnotationClass)
```
  - getMetaAnnotationValue
```
public <T> T getMetaAnnotationValue(MetaProperty metaProperty,
                                    java.lang.Class metaAnnotationClass)
```
    Returns:
    
    annotation value for specified metaProperty and annotation
  - isAnnotationPresent
```
public boolean isAnnotationPresent(java.lang.Object object,
                                   java.lang.String property,
                                   java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)
```
    Determine whether the given annotation is present in the object's class or in any of its superclasses.
    
    Parameters:
    
    object - entity instance
    
    property - property name
    
    annotationClass - annotation class
  - isAnnotationPresent
```
public boolean isAnnotationPresent(java.lang.Class javaClass,
                                   java.lang.String property,
                                   java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)
```
    Determine whether the given annotation is present in the object's class or in any of its superclasses.
    
    Parameters:
    
    javaClass - entity class
    
    property - property name
    
    annotationClass - annotation class
    
    Returns:
    
    true if the annotation is present
  - isJpaEntity
```
public boolean isJpaEntity(MetaClass metaClass)
```
    Determine whether the given meta-class represents a JPA entity.
  - isJpaEntity
```
public boolean isJpaEntity(java.lang.Class<?> aClass)
```
    Determine whether the given class represents a JPA entity.
  - isJpaEmbeddable
```
public boolean isJpaEmbeddable(MetaClass metaClass)
```
    Determine whether the given meta-class is JPA embeddable.
  - isJpaEmbeddable
```
public boolean isJpaEmbeddable(java.lang.Class<?> aClass)
```
    Determine whether the given entity class is JPA embeddable.
  - isCacheable
```
public boolean isCacheable(MetaClass metaClass)
```
  - getPropertyEnclosingMetaClass
```
public MetaClass getPropertyEnclosingMetaClass(MetaPropertyPath propertyPath)
```
    Get metaclass that contains metaproperty for passed propertyPath. Resolves real metaclass for property in consideration of inherited entity classes and extended classes.
    
    Parameters:
    
    propertyPath - Property path
    
    Returns:
    
    metaclass
  - getInstanceNameRelatedProperties
```
@Nonnull
public java.util.Collection<MetaProperty> getInstanceNameRelatedProperties(MetaClass metaClass)
```
    Return a collection of properties included into entity's name pattern (see InstanceName).
    
    Parameters:
    
    metaClass - entity metaclass
    
    Returns:
    
    collection of the name pattern properties
  - getInstanceNameRelatedProperties
```
@Nonnull
public java.util.Collection<MetaProperty> getInstanceNameRelatedProperties(MetaClass metaClass,
                                                                                    boolean useOriginal)
```
    Return a collection of properties included into entity's name pattern (see InstanceName).
    
    Parameters:
    
    metaClass - entity metaclass
    
    useOriginal - if true, and if the given metaclass doesn't define a InstanceName and if it is an extended entity, this method tries to find a name pattern in an original entity
    
    Returns:
    
    collection of the name pattern properties
  - getPropertyPaths
```
public java.util.Collection<MetaPropertyPath> getPropertyPaths(MetaClass metaClass)
```
    Returns:
    
    collection of properties owned by this metaclass and all its ancestors in the form of MetaPropertyPaths containing one property each
  - toPropertyPaths
```
public java.util.Collection<MetaPropertyPath> toPropertyPaths(java.util.Collection<MetaProperty> properties)
```
    Converts a collection of properties to collection of MetaPropertyPaths containing one property each
  - getFetchPlanPropertyPaths
```
public java.util.Collection<MetaPropertyPath> getFetchPlanPropertyPaths(FetchPlan fetchPlan,
                                                                        MetaClass metaClass)
```
    Collects all meta-properties of the given meta-class included to the given fetchPlan as MetaPropertyPaths.
    
    Parameters:
    
    fetchPlan - fetch plan
    
    metaClass - meta-class
    
    Returns:
    
    collection of paths
  - fetchPlanContainsProperty
```
public boolean fetchPlanContainsProperty(@Nullable
                                         FetchPlan fetchPlan,
                                         MetaPropertyPath propertyPath)
```
    Determine whether the fetch plan contains a property, traversing a fetch plan branch according to the given property path.
    
    Parameters:
    
    fetchPlan - fetch plan instance. If null, return false immediately.
    
    propertyPath - property path defining the property
  - getAllJpaEntityMetaClasses
```
public java.util.Collection<MetaClass> getAllJpaEntityMetaClasses()
```
    Returns:
    
    collection of all meta-classes representing JPA entities
  - getAllJpaEmbeddableMetaClasses
```
public java.util.Collection<MetaClass> getAllJpaEmbeddableMetaClasses()
```
    Returns:
    
    collection of all meta-classes representing JPA embeddable classes
  - getAllEnums
```
public java.util.Collection<java.lang.Class<?>> getAllEnums()
```
    Returns:
    
    collection of all Java enums used as a type of an entity attribute
  - getDatabaseTable
```
@Nullable
public java.lang.String getDatabaseTable(MetaClass metaClass)
```
    Returns:
    
    table name for the given entity, or null if the entity is Embeddable, MappedSuperclass or non-persistent
  - getDatabaseColumn
```
@Nullable
public java.lang.String getDatabaseColumn(MetaProperty metaProperty)
```
  - getDependsOnProperties
```
public java.util.List<java.lang.String> getDependsOnProperties(java.lang.Class<?> entityClass,
                                                               java.lang.String property)
```
    Returns:
    
    list of properties defined in DependsOnProperties or empty list
  - getDependsOnProperties
```
public java.util.List<java.lang.String> getDependsOnProperties(MetaProperty metaProperty)
```
    Returns:
    
    list of properties defined in DependsOnProperties or empty list
  - getDeletedDateProperty
```
public java.lang.String getDeletedDateProperty(java.lang.Object entity)
                                        throws java.lang.IllegalArgumentException
```
    Returns:
    
    field annotated with @DeletedDate
    
    Throws:
    
    java.lang.IllegalArgumentException - if entity has no @DeletedDate field
  - findDeletedDateProperty
```
@Nullable
public java.lang.String findDeletedDateProperty(java.lang.Class<?> clazz)
```
    Returns:
    
    field annotated with @DeletedDate or null if annotation is not present
  - findDeletedByProperty
```
@Nullable
public java.lang.String findDeletedByProperty(java.lang.Class<?> clazz)
```
    Returns:
    
    field annotated with @DeletedBy or null if annotation is not present
  - findLastModifiedDateProperty
```
@Nullable
public java.lang.String findLastModifiedDateProperty(java.lang.Class<?> clazz)
```
    Returns:
    
    field annotated with @LastModifiedDate or null if annotation is not present
  - findPropertyByAnnotation
```
@Nullable
protected java.lang.String findPropertyByAnnotation(java.lang.Class<?> clazz,
                                                              java.lang.String annotationName)
```
  - getSoftDeleteProperties
```
public java.util.List<java.lang.String> getSoftDeleteProperties(java.lang.Class<?> clazz)
```
    Returns:
    
    list contains @DeletedDate, @DeletedBy property names if present.
  - hasUuid
```
public boolean hasUuid(MetaClass metaClass)
```
    Checks whether an entity has uuid key (primary or not)
    
    Returns:
    
    true if entity's EntityEntry implements EntityEntryHasUuid
  - getUuidPropertyName
```
@Nullable
public java.lang.String getUuidPropertyName(java.lang.Class<?> clazz)
```
  - getCrossDataStoreReferenceIdProperty
```
@Nullable
public java.lang.String getCrossDataStoreReferenceIdProperty(java.lang.String thisStore,
                                                                       MetaProperty metaProperty)
```
    If the given property is a reference to an entity from different data store, returns the name of a persistent property which stores the identifier of the related entity.
    
    Parameters:
    
    thisStore - name of a base data store
    
    metaProperty - property
    
    Returns:
    
    name of the ID property or null if the given property is not a cross-datastore reference or it does not satisfy the convention of declaring related properties for such references
  - resolveMetaPropertyPathOrNull
```
@Nullable
public MetaPropertyPath resolveMetaPropertyPathOrNull(MetaClass metaClass,
                                                                java.lang.String propertyPath)
```
    Returns a MetaPropertyPath which can include the special MetaProperty for a dynamic attribute.
    
    Parameters:
    
    metaClass - originating meta-class
    
    propertyPath - path to the attribute
    
    Returns:
    
    MetaPropertyPath instance
  - resolveMetaPropertyPath
```
public MetaPropertyPath resolveMetaPropertyPath(MetaClass metaClass,
                                                java.lang.String propertyPath)
```
    Returns a MetaPropertyPath which can include the special MetaProperty for a dynamic attribute. Throws an IllegalArgumentException if MetaPropertyPath can't be resolved.
    
    Parameters:
    
    metaClass - originating meta-class
    
    propertyPath - path to the attribute
    
    Returns:
    
    MetaPropertyPath instance
  - traverseAttributes
```
public void traverseAttributes(java.lang.Object entity,
                               EntityAttributeVisitor visitor)
```
    Depth-first traversal of the object graph starting from the specified entity instance. Visits all attributes.
    
    Parameters:
    
    entity - entity graph entry point
    
    visitor - the attribute visitor implementation
  - traverseAttributesByFetchPlan
```
public void traverseAttributesByFetchPlan(FetchPlan fetchPlan,
                                          java.lang.Object entity,
                                          EntityAttributeVisitor visitor)
```
    Depth-first traversal of the object graph by the fetch plan starting from the specified entity instance. Visits attributes defined in the fetch plan.
    
    Parameters:
    
    fetchPlan - fetchPlan instance
    
    entity - entity graph entry point
    
    visitor - the attribute visitor implementation
  - traverseAttributesByFetchPlan
```
public void traverseAttributesByFetchPlan(FetchPlan fetchPlan,
                                          java.lang.Object entity,
                                          boolean checkLoaded,
                                          EntityAttributeVisitor visitor)
```
    Depth-first traversal of the object graph by the fetch plan starting from the specified entity instance. Visits attributes defined in the fetch plan.
    
    Parameters:
    
    fetchPlan - fetchPlan instance
    
    entity - entity graph entry point
    
    checkLoaded - if true, skips not loaded attributes
    
    visitor - the attribute visitor implementation
  - copy
```
public <T> T copy(T source)
```
    Create a new instance and make it a shallow copy of the instance given.
    This method copies attributes according to the metadata.
    
    Parameters:
    
    source - source instance
    
    Returns:
    
    new instance of the same Java class as source
  - copy
```
public void copy(java.lang.Object source,
                 java.lang.Object dest)
```
    Make a shallow copy of an instance.
    This method copies attributes according to the metadata.
    The source and destination instances don't have to be of the same Java class or metaclass. Copying is performed in the following scenario: get each source property and copy the value to the destination if it contains a property with the same name and it is not read-only.
    
    Parameters:
    
    source - source instance
    
    dest - destination instance
  - deepCopy
```
public <T> T deepCopy(T source)
```
    Makes a deep copy of the source entity. All referenced entities and collections will be copied as well.
  - deepCopy
```
public void deepCopy(java.lang.Object source,
                     java.lang.Object destination,
                     MetadataTools.EntitiesHolder entitiesHolder)
```
    Copies all property values from source to destination excluding null values.
  - internalTraverseAttributes
```
protected void internalTraverseAttributes(Entity entity,
                                          EntityAttributeVisitor visitor,
                                          java.util.HashSet<java.lang.Object> visited)
```
  - internalTraverseAttributesByFetchPlan
```
protected void internalTraverseAttributesByFetchPlan(FetchPlan fetchPlan,
                                                     java.lang.Object entity,
                                                     EntityAttributeVisitor visitor,
                                                     java.util.Map<java.lang.Object,java.util.Set<FetchPlan>> visited,
                                                     boolean checkLoaded)
```
  - createInstance
```
protected static <T> T createInstance(java.lang.Class<T> aClass)
```
  - createInstanceWithId
```
protected static java.lang.Object createInstanceWithId(java.lang.Class<?> entityClass,
                                                       java.lang.Object id)
```
  - getAdditionalProperties
```
public java.util.Set<MetaProperty> getAdditionalProperties(MetaClass metaClass)
```
    Returns all additional properties which are providing classes implement MetadataExtension interface
    
    Parameters:
    
    metaClass - instance MetaClass for getting additional properties
    
    Returns:
    
    all additional properties
  - isAdditionalProperty
```
public boolean isAdditionalProperty(MetaClass metaClass,
                                    java.lang.String propertyName)
```
    Parameters:
    
    metaClass -
    
    propertyName -

Class MetadataTools

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRIMARY_KEY_ANN_NAME

EMBEDDED_ANN_NAME

TEMPORAL_ANN_NAME

SYSTEM_ANN_NAME

STORE_ANN_NAME

LENGTH_ANN_NAME

UUID_KEY_ANN_NAME

DELETED_DATE_ANN_NAME

DELETED_BY_ANN_NAME

LAST_MODIFIED_DATE_ANN_NAME

metadata

extendedEntities

messages

instanceNameProvider

metadataExtensions

currentAuthentication

datatypeRegistry

persistentAttributesLoadChecker

metaPropertyPathResolvers

enums

Constructor Detail

MetadataTools

Method Detail

format

format

getInstanceName

getPrimaryKeyName

getPrimaryKeyProperty

getPrimaryKeyProperty

hasCompositePrimaryKey

hasDbGeneratedPrimaryKey

isAssignableFrom

isCascade

isSoftDeletable

isSystem

getSystemProperties

isJpa

isJpa

isEmbedded

isLob

isOwningSide

isSystemLevel

isSystemLevel

getMetaAnnotationAttributes

getMetaAnnotationValue

isAnnotationPresent

isAnnotationPresent

isJpaEntity

isJpaEntity

isJpaEmbeddable

isJpaEmbeddable

isCacheable

getPropertyEnclosingMetaClass

getInstanceNameRelatedProperties

getInstanceNameRelatedProperties

getPropertyPaths

toPropertyPaths

getFetchPlanPropertyPaths

fetchPlanContainsProperty

getAllJpaEntityMetaClasses

getAllJpaEmbeddableMetaClasses

getAllEnums

getDatabaseTable

getDatabaseColumn

getDependsOnProperties

getDependsOnProperties

getDeletedDateProperty

findDeletedDateProperty

findDeletedByProperty

findLastModifiedDateProperty

findPropertyByAnnotation

getSoftDeleteProperties

hasUuid