com.haulmont.cuba.core.global

Class MetadataTools

java.lang.Object

com.haulmont.cuba.core.global.MetadataTools

Direct Known Subclasses:

TestMetadataTools

@Component(value="cuba_MetadataTools")
public class MetadataTools
extends java.lang.Object

Utility class to provide common metadata-related functionality.
Implemented as Spring bean to allow extension in application projects.
A reference to this class can be obtained either via DI or by Metadata.getTools().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataTools.CachingEntitiesHolder
static interface	MetadataTools.EntitiesHolder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMBEDDED_ANN_NAME
static java.lang.String	NAME
static java.lang.String	PERSISTENT_ANN_NAME
static java.lang.String	PRIMARY_KEY_ANN_NAME
static java.lang.String	STORE_ANN_NAME
static java.lang.String	SYSTEM_ANN_NAME
static java.util.List<java.lang.Class>	SYSTEM_INTERFACES
static java.lang.String	TEMPORAL_ANN_NAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	copy(Instance source, Instance dest) Make a shallow copy of an instance.
<T extends Instance> T	copy(T source) Create a new instance and make it a shallow copy of the instance given.
void	deepCopy(Entity source, Entity destination, MetadataTools.EntitiesHolder entitiesHolder) Copies all property values from source to destination excluding null values.
<T extends Entity> T	deepCopy(T source) Makes a deep copy of the source entity.
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.Collection<MetaClass>	getAllEmbeddableMetaClasses()
java.util.Collection<java.lang.Class>	getAllEnums()
java.util.Collection<MetaClass>	getAllPersistentMetaClasses()
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	getEntityName(java.lang.Class<?> entityClass)
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.util.Collection<MetaProperty>	getNamePatternProperties(MetaClass metaClass) Return a collection of properties included into entity's name pattern (see NamePattern).
java.util.Collection<MetaProperty>	getNamePatternProperties(MetaClass metaClass, boolean useOriginal) Return a collection of properties included into entity's name pattern (see NamePattern).
java.lang.String	getPrimaryKeyName(MetaClass metaClass)
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>	getRelatedProperties(java.lang.Class<?> entityClass, java.lang.String property)
java.util.List<java.lang.String>	getRelatedProperties(MetaProperty metaProperty)
java.lang.String	getStoreName(MetaClass metaClass)
java.util.Collection<MetaPropertyPath>	getViewPropertyPaths(View view, MetaClass metaClass) Collects all meta-properties of the given meta-class included to the given view as MetaPropertyPaths.
boolean	hasCompositePrimaryKey(MetaClass metaClass)
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	isEmbeddable(MetaClass metaClass) Determine whether the given metaclass is embeddable.
boolean	isEmbedded(MetaProperty metaProperty) Determine whether the given property denotes an embedded object.
boolean	isLob(MetaProperty metaProperty) Determine whether the given property is a LOB.
boolean	isNotPersistent(java.lang.Class aClass) Determine whether the given class represents a non-persistent entity.
boolean	isNotPersistent(MetaClass metaClass) Determine whether the given metaclass represents a non-persistent entity.
boolean	isNotPersistent(MetaClass metaClass, MetaProperty metaProperty) Determine whether the given property is not persistent.
boolean	isNotPersistent(MetaProperty metaProperty) Determine whether the given property is not persistent.
boolean	isNotPersistent(java.lang.Object object, java.lang.String property) Determine whether the given property is not persistent.
boolean	isOwningSide(MetaProperty metaProperty) Determine whether the given property is on the owning side of an association.
boolean	isPersistent(java.lang.Class aClass) Determine whether the given class represents a persistent entity.
boolean	isPersistent(MetaClass metaClass) Determine whether the given metaclass represents a persistent entity.
boolean	isPersistent(MetaClass metaClass, MetaProperty metaProperty) Determine whether the given property is persistent, that is managed by ORM.
boolean	isPersistent(MetaProperty metaProperty) Determine whether the given property is persistent, that is managed by ORM.
boolean	isPersistent(MetaPropertyPath metaPropertyPath) Determine whether all the properties defined by the given property path are persistent.
boolean	isSoftDeleted(java.lang.Class entityClass) Determine whether the entity supports Soft Deletion.
boolean	isSystem(MetaProperty metaProperty) Determine whether the given property is system-level.
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.
boolean	isTransient(java.lang.Class aClass) Deprecated.
boolean	isTransient(MetaClass metaClass) Deprecated.
boolean	isTransient(MetaProperty metaProperty) Deprecated.
boolean	isTransient(java.lang.Object object, java.lang.String property) Deprecated.
MetaPropertyPath	resolveMetaPropertyPath(MetaClass metaClass, java.lang.String propertyPath) Returns a MetaPropertyPath which can include the special MetaProperty for a dynamic attribute.
MetaPropertyPath	resolveMetaPropertyPathNN(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 MetaPropertyPaths containing one property each
void	traverseAttributes(Entity entity, EntityAttributeVisitor visitor) Depth-first traversal of the object graph starting from the specified entity instance.
void	traverseAttributesByView(View view, Entity entity, EntityAttributeVisitor visitor) Depth-first traversal of the object graph by the view starting from the specified entity instance.
void	traverseLoadedAttributesByView(View view, Entity entity, EntityAttributeVisitor visitor) Depth-first traversal of the object graph by the view starting from the specified entity instance.
boolean	viewContainsProperty(View view, MetaPropertyPath propertyPath) Determine whether the view contains a property, traversing a view branch according to the given property path.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

PERSISTENT_ANN_NAME

public static final java.lang.String PERSISTENT_ANN_NAME

See Also:

Constant Field Values

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

SYSTEM_INTERFACES

public static final java.util.List<java.lang.Class> SYSTEM_INTERFACES

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 - object to format

property - metadata

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

getStoreName

@Nullable
public java.lang.String getStoreName(MetaClass metaClass)

Returns:

name of a data store of the given entity or null if the entity is not persistent and no data store is defined for it

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)

hasCompositePrimaryKey

public boolean hasCompositePrimaryKey(MetaClass metaClass)

Returns:

true if passed MetaClass has a composite 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.

isSoftDeleted

public boolean isSoftDeleted(java.lang.Class entityClass)

Determine whether the entity supports Soft Deletion.

Parameters:

entityClass - entity class

Returns:

true if the entity implements SoftDelete

isSystem

public boolean isSystem(MetaProperty metaProperty)

Determine whether the given property is system-level. A property is considered system if it is defined not in an entity class but in one of its base interfaces: Entity, Creatable, Updatable, SoftDelete, Versioned, HasUuid

isPersistent

public boolean isPersistent(MetaPropertyPath metaPropertyPath)

Determine whether all the properties defined by the given property path are persistent.

See Also:

isPersistent(com.haulmont.chile.core.model.MetaProperty)

isPersistent

public boolean isPersistent(MetaProperty metaProperty)

Determine whether the given property is persistent, that is managed by ORM.

A property is persistent if it is defined in a class registered in persistence.xml and the corresponding attribute is managed by ORM, i.e. has an annotation like @Column, @JoinColumn, etc.

Note that for properties of non-persistent classes inherited from base classes like BaseUuidEntity this method returns true. This is because a meta-property belongs to a class where it is defined, and this method has no input identifying the real class of interest. E.g. if you have class Foo extends BaseUuidEntity, then for the Foo.id attribute the method returns true even if the Foo is defined in metadata.xml and hence not persistent.

If you need a strict check of whether a certain attribute of an entity is stored in the database via ORM, use isPersistent(MetaClass, MetaProperty).

isPersistent

public boolean isPersistent(MetaClass metaClass,
                            MetaProperty metaProperty)

Determine whether the given property is persistent, that is managed by ORM.

isNotPersistent

public boolean isNotPersistent(java.lang.Object object,
                               java.lang.String property)

Determine whether the given property is not persistent. Inverse of isPersistent(MetaClass, MetaProperty).

For objects and properties not registered in metadata this method returns true.

isNotPersistent

public boolean isNotPersistent(MetaProperty metaProperty)

Determine whether the given property is not persistent. Inverse of isPersistent(MetaProperty).

isNotPersistent

public boolean isNotPersistent(MetaClass metaClass,
                               MetaProperty metaProperty)

Determine whether the given property is not persistent. Inverse of isPersistent(MetaClass, MetaProperty).

isEmbedded

public boolean isEmbedded(MetaProperty metaProperty)

Determine whether the given property denotes an embedded object.

See Also:

Embedded

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:

isPersistent

public boolean isPersistent(MetaClass metaClass)

Determine whether the given metaclass represents a persistent entity.

A persistent entity is an entity that is managed by ORM (i.e. registered in a persistence.xml file) and is not a MappedSuperclass or Embeddable.

isPersistent

public boolean isPersistent(java.lang.Class aClass)

Determine whether the given class represents a persistent entity.

A persistent entity is an entity that is managed by ORM (i.e. registered in a persistence.xml file) and is not a MappedSuperclass or Embeddable.

isNotPersistent

public boolean isNotPersistent(MetaClass metaClass)

Determine whether the given metaclass represents a non-persistent entity.

A non-persistent entity is not managed by ORM (i.e. registered in a metadata.xml file).

Note that isNotPersistent() is not the same as !isPersistent(), because the latter does not include MappedSuperclass and Embeddable entities that a still managed by ORM.

isNotPersistent

public boolean isNotPersistent(java.lang.Class aClass)

Determine whether the given class represents a non-persistent entity.

A non-persistent entity is not managed by ORM (i.e. registered in a metadata.xml file).

Note that isNotPersistent() is not the same as !isPersistent(), because the latter does not include MappedSuperclass and Embeddable entities that a still managed by ORM.

isEmbeddable

public boolean isEmbeddable(MetaClass metaClass)

Determine whether the given metaclass is 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

getNamePatternProperties

@Nonnull
public java.util.Collection<MetaProperty> getNamePatternProperties(MetaClass metaClass)

Return a collection of properties included into entity's name pattern (see NamePattern).

Parameters:

metaClass - entity metaclass

Returns:

collection of the name pattern properties

getNamePatternProperties

@Nonnull
public java.util.Collection<MetaProperty> getNamePatternProperties(MetaClass metaClass,
                                                                            boolean useOriginal)

Return a collection of properties included into entity's name pattern (see NamePattern).

Parameters:

metaClass - entity metaclass

useOriginal - if true, and if the given metaclass doesn't define a NamePattern 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

getViewPropertyPaths

public java.util.Collection<MetaPropertyPath> getViewPropertyPaths(View view,
                                                                   MetaClass metaClass)

Collects all meta-properties of the given meta-class included to the given view as MetaPropertyPaths.

Parameters:

view - view

metaClass - meta-class

Returns:

collection of paths

viewContainsProperty

public boolean viewContainsProperty(@Nullable
                                    View view,
                                    MetaPropertyPath propertyPath)

Determine whether the view contains a property, traversing a view branch according to the given property path.

Parameters:

view - view instance. If null, return false immediately.

propertyPath - property path defining the property

getAllPersistentMetaClasses

public java.util.Collection<MetaClass> getAllPersistentMetaClasses()

Returns:

collection of all persistent entities

getAllEmbeddableMetaClasses

public java.util.Collection<MetaClass> getAllEmbeddableMetaClasses()

Returns:

collection of all embeddable entities

getAllEnums

public java.util.Collection<java.lang.Class> getAllEnums()

Returns:

collection of all Java enums used as a type of an entity attribute

getEntityName

public java.lang.String getEntityName(java.lang.Class<?> entityClass)

Parameters:

entityClass - entity class

Returns:

entity name as defined in Entity annotation

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)

getRelatedProperties

public java.util.List<java.lang.String> getRelatedProperties(java.lang.Class<?> entityClass,
                                                             java.lang.String property)

Returns:

list of related properties defined in MetaProperty.related() or empty list

getRelatedProperties

public java.util.List<java.lang.String> getRelatedProperties(MetaProperty metaProperty)

Returns:

list of related properties defined in MetaProperty.related() or empty list

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

resolveMetaPropertyPath

@Nullable
public MetaPropertyPath resolveMetaPropertyPath(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

resolveMetaPropertyPathNN

public MetaPropertyPath resolveMetaPropertyPathNN(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(Entity 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

traverseAttributesByView

public void traverseAttributesByView(View view,
                                     Entity entity,
                                     EntityAttributeVisitor visitor)

Depth-first traversal of the object graph by the view starting from the specified entity instance. Visits attributes defined in the view.

Parameters:

view - view instance

entity - entity graph entry point

visitor - the attribute visitor implementation

traverseLoadedAttributesByView

public void traverseLoadedAttributesByView(View view,
                                           Entity entity,
                                           EntityAttributeVisitor visitor)

Depth-first traversal of the object graph by the view starting from the specified entity instance. Visits attributes defined in the view. Not loaded attributes by the view aren't visited.

Parameters:

view - view instance

entity - entity graph entry point

visitor - the attribute visitor implementation

copy

public <T extends Instance> 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 and relies on Instance.getMetaClass() method which should not return null.

Parameters:

source - source instance

Returns:

new instance of the same Java class as source

copy

public void copy(Instance source,
                 Instance dest)

Make a shallow copy of an instance.
This method copies attributes according to the metadata and relies on Instance.getMetaClass() method which should not return null for both objects.
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 extends Entity> 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(Entity source,
                     Entity destination,
                     MetadataTools.EntitiesHolder entitiesHolder)

Copies all property values from source to destination excluding null values.

isTransient

@Deprecated
public boolean isTransient(MetaClass metaClass)

Deprecated.

DEPRECATED! Use isNotPersistent(MetaClass).

isTransient

@Deprecated
public boolean isTransient(java.lang.Class aClass)

Deprecated.

DEPRECATED! Use isNotPersistent(Class).

isTransient

@Deprecated
public boolean isTransient(java.lang.Object object,
                                       java.lang.String property)

Deprecated.

DEPRECATED! Use isNotPersistent(Object, String).

isTransient

@Deprecated
public boolean isTransient(MetaProperty metaProperty)

Deprecated.

DEPRECATED! Use isNotPersistent(MetaProperty).