com.impetus.kundera.metadata

Class MetadataUtils

java.lang.Object

com.impetus.kundera.metadata.MetadataUtils

public class MetadataUtils
extends Object

Utility class for entity metadata related funcntionality.

Author:

amresh.singh

Constructor Summary

Constructors

Constructor and Description
MetadataUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	containsBasicElementCollectionField(EntityMetadata m, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata) Checks whether an entity with given metadata contains a collection field
static Map<String,Field>	createColumnsFieldMap(EntityMetadata m, javax.persistence.metamodel.EmbeddableType superColumn) Creates the columns field map.
static Map<String,Field>	createSuperColumnsFieldMap(EntityMetadata m, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata) Creates the super columns field map.
static boolean	defaultTransactionSupported(String persistenceUnit, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata) If client specific to parameterized persistence unit does not support transaction, return true else will return false.
static Set<String>	deserializeKeys(String foreignKeys) Splits foreign keys into Set.
private static void	getAttributeOfEmbedddable(Map<String,Field> columnNameToFieldMap, javax.persistence.metamodel.Metamodel metaModel, javax.persistence.metamodel.Attribute attribute)
private static void	getEmbeddableType(EntityMetadata m, Map<String,Field> columnNameToFieldMap, Map<String,Field> superColumnNameToFieldMap, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata)
static Collection	getEmbeddedCollectionInstance(Field embeddedCollectionField) Gets the embedded collection instance.
static String	getEmbeddedCollectionPostfix(String embeddedCollectionName) Gets the embedded collection postfix.
static String	getEmbeddedCollectionPrefix(String embeddedCollectionName) Gets the embedded collection prefix.
static Object	getEmbeddedGenericObjectInstance(Field embeddedCollectionField) Gets the embedded generic object instance.
static String	getEnclosingEmbeddedFieldName(EntityMetadata m, String criteria, boolean viaColumnName, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata) Gets the enclosing document name.
static String	getMappedName(EntityMetadata parentMetadata, Relation relation, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata) Returns mapped relational name, in case of bi directional mapping, it will return back pKey name of associated entity.
static boolean	indexSearchEnabled(String persistenceUnit, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata) Index based search has to be optional, ideally need to register a callback in case index persistence/search etc is optional.
static boolean	isBasicElementCollectionField(Field collectionField) Checks whether a given field is Element collection field of BASIC type
static boolean	isColumnInEmbeddableIndexable(Field embeddedField, String columnFieldName)
static boolean	isEmbeddedAtributeIndexable(Field embeddedField)
static boolean	isSchemaAttributeRequired(String persistenceUnit, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata)
static boolean	onCheckEmbeddableAttribute(Field attribute) Returns true if an entity contains embedded attribute enabled
static boolean	onCheckValidationConstraints(Field attribute) Returns true if an entity contains attributes with validation constraints enabled
static void	onJPAColumnMapping(javax.persistence.metamodel.EntityType entityType, EntityMetadata entityMetadata)
static void	populateColumnAndSuperColumnMaps(EntityMetadata m, Map<String,Field> columnNameToFieldMap, Map<String,Field> superColumnNameToFieldMap, EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata) Populate column and super column maps.
static String	serializeKeys(Set<String> foreignKeys) Creates a string representation of a set of foreign keys by combining them together separated by "~" character.
static void	setSchemaAndPersistenceUnit(EntityMetadata m, String schemaStr, Map puProperties) Sets the schema and persistence unit.
static boolean	useSecondryIndex(ClientMetadata clientMetadata) Returns true, if use of secondry index is available, else false.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataUtils

public MetadataUtils()

Method Detail

populateColumnAndSuperColumnMaps

public static void populateColumnAndSuperColumnMaps(EntityMetadata m,
                                    Map<String,Field> columnNameToFieldMap,
                                    Map<String,Field> superColumnNameToFieldMap,
                                    EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata)

Populate column and super column maps.

Parameters:

m - the m

columnNameToFieldMap - the column name to field map

superColumnNameToFieldMap - the super column name to field map

createColumnsFieldMap

public static Map<String,Field> createColumnsFieldMap(EntityMetadata m,
                                      javax.persistence.metamodel.EmbeddableType superColumn)

Creates the columns field map.

Parameters:

m - the m

superColumn - the super column

Returns:

the map

createSuperColumnsFieldMap

public static Map<String,Field> createSuperColumnsFieldMap(EntityMetadata m,
                                           EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata)

Creates the super columns field map.

Parameters:

m - the m

Returns:

the map

getEmbeddedCollectionInstance

public static Collection getEmbeddedCollectionInstance(Field embeddedCollectionField)

Gets the embedded collection instance.

Parameters:

embeddedCollectionField - the embedded collection field

Returns:

the embedded collection instance

getEmbeddedGenericObjectInstance

public static Object getEmbeddedGenericObjectInstance(Field embeddedCollectionField)

Gets the embedded generic object instance.

Parameters:

embeddedCollectionField - the embedded collection field

Returns:

the embedded generic object instance

getEmbeddedCollectionPrefix

public static String getEmbeddedCollectionPrefix(String embeddedCollectionName)

Gets the embedded collection prefix.

Parameters:

embeddedCollectionName - the embedded collection name

Returns:

the embedded collection prefix

getEmbeddedCollectionPostfix

public static String getEmbeddedCollectionPostfix(String embeddedCollectionName)

Gets the embedded collection postfix.

Parameters:

embeddedCollectionName - the embedded collection name

Returns:

the embedded collection postfix

serializeKeys

public static String serializeKeys(Set<String> foreignKeys)

Creates a string representation of a set of foreign keys by combining them together separated by "~" character. Note: Assumption is that @Id will never contain "~" character. Checks for this are not added yet.

Parameters:

foreignKeys - the foreign keys

Returns:

the string

deserializeKeys

public static Set<String> deserializeKeys(String foreignKeys)

Splits foreign keys into Set.

Parameters:

foreignKeys - the foreign keys

Returns:

the set

setSchemaAndPersistenceUnit

public static void setSchemaAndPersistenceUnit(EntityMetadata m,
                               String schemaStr,
                               Map puProperties)

Sets the schema and persistence unit.

Parameters:

m - the m

schemaStr - the schema str

puProperties -

useSecondryIndex

public static boolean useSecondryIndex(ClientMetadata clientMetadata)

Returns true, if use of secondry index is available, else false.

Parameters:

persistenceUnit - persistence unit name

Returns:

true, if usage is true in pu. else false.

getMappedName

public static String getMappedName(EntityMetadata parentMetadata,
                   Relation relation,
                   EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata)

Returns mapped relational name, in case of bi directional mapping, it will return back pKey name of associated entity.

Parameters:

relation - holding relation.

Returns:

mapped/join column name.

getEnclosingEmbeddedFieldName

public static String getEnclosingEmbeddedFieldName(EntityMetadata m,
                                   String criteria,
                                   boolean viaColumnName,
                                   EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata)

Gets the enclosing document name.

Parameters:

m - the m

criteria - Input criteria

viaColumnName - true if criteria is column Name, false if criteria is column field name

Returns:

the enclosing document name

getEmbeddableType

private static void getEmbeddableType(EntityMetadata m,
                     Map<String,Field> columnNameToFieldMap,
                     Map<String,Field> superColumnNameToFieldMap,
                     EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata)

getAttributeOfEmbedddable

private static void getAttributeOfEmbedddable(Map<String,Field> columnNameToFieldMap,
                             javax.persistence.metamodel.Metamodel metaModel,
                             javax.persistence.metamodel.Attribute attribute)

isEmbeddedAtributeIndexable

public static boolean isEmbeddedAtributeIndexable(Field embeddedField)

isColumnInEmbeddableIndexable

public static boolean isColumnInEmbeddableIndexable(Field embeddedField,
                                    String columnFieldName)

defaultTransactionSupported

public static boolean defaultTransactionSupported(String persistenceUnit,
                                  EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata)

If client specific to parameterized persistence unit does not support transaction, return true else will return false.

Parameters:

persistenceUnit -

Returns:

isSchemaAttributeRequired

public static boolean isSchemaAttributeRequired(String persistenceUnit,
                                EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata)

indexSearchEnabled

public static boolean indexSearchEnabled(String persistenceUnit,
                         EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata)

Index based search has to be optional, ideally need to register a callback in case index persistence/search etc is optional.

Parameters:

persistenceUnit - persistence unit

Returns:

true, if index based search is enabled.

isBasicElementCollectionField

public static boolean isBasicElementCollectionField(Field collectionField)

Checks whether a given field is Element collection field of BASIC type

Parameters:

collectionField -

Returns:

containsBasicElementCollectionField

public static boolean containsBasicElementCollectionField(EntityMetadata m,
                                          EntityManagerFactoryImpl.KunderaMetadata kunderaMetadata)

Checks whether an entity with given metadata contains a collection field

Parameters:

m -

Returns:

onJPAColumnMapping

public static void onJPAColumnMapping(javax.persistence.metamodel.EntityType entityType,
                      EntityMetadata entityMetadata)

onCheckValidationConstraints

public static boolean onCheckValidationConstraints(Field attribute)

Returns true if an entity contains attributes with validation constraints enabled

Parameters:

attribute -

Returns:

onCheckEmbeddableAttribute

public static boolean onCheckEmbeddableAttribute(Field attribute)

Returns true if an entity contains embedded attribute enabled

Parameters:

attribute -

Returns: