com.impetus.kundera.metadata.model

Class EntityMetadata

java.lang.Object

com.impetus.kundera.metadata.model.EntityMetadata

public final class EntityMetadata
extends Object

Holds metadata for entities.

Author:

animesh.kumar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityMetadata.Type The Enum Type.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	cacheable Cacheable?.
private Map<Class<?>,List<? extends CallbackMethod>>	callbackMethodsMap The callback methods map.
private Class<?>	entityClazz class corresponding to this meta.
private javax.persistence.metamodel.EntityType	entityType
private javax.persistence.metamodel.SingularAttribute	idAttribute
private String	indexName The index name.
private Map<String,PropertyIndex>	indexPrperties The index prperties.
private boolean	isCounterColumnType
private boolean	isIndexable The is indexable.
private boolean	isParent
private boolean	isRelationViaJoinTable The is relation via join table.
private Map<String,String>	jpaColumnMapping
private String	persistenceUnit Persistence unit of database this entity is to be persisted.
private Method	readIdentifierMethod The read identifier method.
private List<String>	relationNames
private Map<String,Relation>	relationsMap Relationship map, key=>property name, value=>relation.
private String	schema database name.
private String	tableName Name of Persistence Object.
private EntityMetadata.Type	type type.
private Method	writeIdentifierMethod The write identifier method.

Constructor Summary

Constructors

Constructor and Description
EntityMetadata(Class<?> entityClazz) Instantiates a new metadata.

Method Summary

Methods

Modifier and Type	Method and Description
void	addIndexProperty(String columnName, PropertyIndex index) Adds the index property.
void	addJPAColumnMapping(String jpaColumnName, String fieldName)
void	addRelation(String property, Relation relation) Adds the relation.
private void	addRelationName(Relation rField) Method to add specific relation name for given relational field.
private void	addToRelationNameCollection(String relationName) Adds relation name to relation name collection.
List<? extends CallbackMethod>	getCallbackMethods(Class<?> event) Gets the callback methods.
Map<Class<?>,List<? extends CallbackMethod>>	getCallbackMethodsMap() Gets the callback methods map.
Class<?>	getEntityClazz() Gets the entity clazz.
private javax.persistence.metamodel.EntityType	getEntityType()
String	getFieldName(String jpaColumnName)
javax.persistence.metamodel.SingularAttribute	getIdAttribute()
String	getIndexName() Gets the index name.
Map<String,PropertyIndex>	getIndexProperties() Gets the index properties.
private String	getJoinColumnName(Field relation) Gets the relation field name.
String	getPersistenceUnit() Gets the persistence unit.
Method	getReadIdentifierMethod() Gets the read identifier method.
Relation	getRelation(String property) Gets the relation.
List<String>	getRelationNames()
List<Relation>	getRelations() Gets the relations.
String	getSchema() Gets the schema.
String	getTableName() Gets the table name.
EntityMetadata.Type	getType() Gets the type.
Method	getWriteIdentifierMethod() Gets the write identifier method.
boolean	isCacheable() Checks if is cacheable.
boolean	isCounterColumnType()
boolean	isIndexable() Checks if is indexable.
boolean	isParent()
boolean	isRelationViaJoinTable() Getter method for isRelatedViaJoinTable.
void	setCacheable(boolean cacheable) Sets the cacheable.
void	setCallbackMethodsMap(Map<Class<?>,List<? extends CallbackMethod>> callbackMethodsMap) Sets the callback methods map.
void	setCounterColumnType(boolean isCounterColumnType)
void	setEntityType(javax.persistence.metamodel.EntityType entityType)
void	setIdAttribute(javax.persistence.metamodel.SingularAttribute idAttribute)
void	setIndexable(boolean isIndexable) Sets the indexable.
void	setIndexName(String indexName) Sets the index name.
void	setParent(boolean isParent)
void	setPersistenceUnit(String persistenceUnit) Sets the persistence unit.
void	setReadIdentifierMethod(Method readIdentifierMethod) Sets the read identifier method.
void	setRelationViaJoinTable(boolean isRelationViaJoinTable) Setter method for isRelatedViaJoinTable.
void	setSchema(String schema) Sets the schema.
void	setTableName(String tableName) Sets the table name.
void	setType(EntityMetadata.Type type) Sets the type.
void	setWriteIdentifierMethod(Method writeIdentifierMethod) Sets the write identifier method.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

entityClazz

private Class<?> entityClazz

class corresponding to this meta.

tableName

private String tableName

Name of Persistence Object.

schema

private String schema

database name.

persistenceUnit

private String persistenceUnit

Persistence unit of database this entity is to be persisted.

indexName

private String indexName

The index name.

isIndexable

private boolean isIndexable

The is indexable.

cacheable

private boolean cacheable

Cacheable?.

isCounterColumnType

private boolean isCounterColumnType

idAttribute

private javax.persistence.metamodel.SingularAttribute idAttribute

jpaColumnMapping

private Map<String,String> jpaColumnMapping

readIdentifierMethod

private Method readIdentifierMethod

The read identifier method.

writeIdentifierMethod

private Method writeIdentifierMethod

The write identifier method.

indexPrperties

private Map<String,PropertyIndex> indexPrperties

The index prperties.

callbackMethodsMap

private Map<Class<?>,List<? extends CallbackMethod>> callbackMethodsMap

The callback methods map.

relationsMap

private Map<String,Relation> relationsMap

Relationship map, key=>property name, value=>relation.

type

private EntityMetadata.Type type

type.

isRelationViaJoinTable

private boolean isRelationViaJoinTable

The is relation via join table.

relationNames

private List<String> relationNames

isParent

private boolean isParent

entityType

private javax.persistence.metamodel.EntityType entityType

Constructor Detail

EntityMetadata

public EntityMetadata(Class<?> entityClazz)

Instantiates a new metadata.

Parameters:

entityClazz - the entity clazz

Method Detail

getType

public EntityMetadata.Type getType()

Gets the type.

Returns:

the type

setType

public void setType(EntityMetadata.Type type)

Sets the type.

Parameters:

type - the new type

getEntityClazz

public Class<?> getEntityClazz()

Gets the entity clazz.

Returns:

the entity clazz

getTableName

public String getTableName()

Gets the table name.

Returns:

the tableName

getEntityType

private javax.persistence.metamodel.EntityType getEntityType()

setTableName

public void setTableName(String tableName)

Sets the table name.

Parameters:

tableName - the tableName to set

getSchema

public String getSchema()

Gets the schema.

Returns:

the schema

setSchema

public void setSchema(String schema)

Sets the schema.

Parameters:

schema - the schema to set

getPersistenceUnit

public String getPersistenceUnit()

Gets the persistence unit.

Returns:

the persistenceUnit

setPersistenceUnit

public void setPersistenceUnit(String persistenceUnit)

Sets the persistence unit.

Parameters:

persistenceUnit - the persistenceUnit to set

getReadIdentifierMethod

public Method getReadIdentifierMethod()

Gets the read identifier method.

Returns:

the readIdentifierMethod

setReadIdentifierMethod

public void setReadIdentifierMethod(Method readIdentifierMethod)

Sets the read identifier method.

Parameters:

readIdentifierMethod - the readIdentifierMethod to set

getWriteIdentifierMethod

public Method getWriteIdentifierMethod()

Gets the write identifier method.

Returns:

the writeIdentifierMethod

setWriteIdentifierMethod

public void setWriteIdentifierMethod(Method writeIdentifierMethod)

Sets the write identifier method.

Parameters:

writeIdentifierMethod - the writeIdentifierMethod to set

addIndexProperty

public void addIndexProperty(String columnName,
                    PropertyIndex index)

Adds the index property.

Parameters:

index - the index

addRelation

public void addRelation(String property,
               Relation relation)

Adds the relation.

Parameters:

property - the property

relation - the relation

getRelation

public Relation getRelation(String property)

Gets the relation.

Parameters:

property - the property

Returns:

the relation

getRelations

public List<Relation> getRelations()

Gets the relations.

Returns:

the relations

getIndexProperties

public Map<String,PropertyIndex> getIndexProperties()

Gets the index properties.

Returns:

the index properties

getIndexName

public String getIndexName()

Gets the index name.

Returns:

the index name

setIndexName

public void setIndexName(String indexName)

Sets the index name.

Parameters:

indexName - the new index name

isIndexable

public boolean isIndexable()

Checks if is indexable.

Returns:

true, if is indexable

setIndexable

public void setIndexable(boolean isIndexable)

Sets the indexable.

Parameters:

isIndexable - the new indexable

setCallbackMethodsMap

public void setCallbackMethodsMap(Map<Class<?>,List<? extends CallbackMethod>> callbackMethodsMap)

Sets the callback methods map.

Parameters:

callbackMethodsMap - the callback methods map

getCallbackMethodsMap

public Map<Class<?>,List<? extends CallbackMethod>> getCallbackMethodsMap()

Gets the callback methods map.

Returns:

the callback methods map

getCallbackMethods

public List<? extends CallbackMethod> getCallbackMethods(Class<?> event)

Gets the callback methods.

Parameters:

event - the event

Returns:

the callback methods

isCacheable

public boolean isCacheable()

Checks if is cacheable.

Returns:

the cacheable

setCacheable

public void setCacheable(boolean cacheable)

Sets the cacheable.

Parameters:

cacheable - the cacheable to set

toString

public String toString()

Overrides:

toString in class Object

isRelationViaJoinTable

public boolean isRelationViaJoinTable()

Getter method for isRelatedViaJoinTable.

Returns:

true, if holds join table relation, else false.

isParent

public boolean isParent()

Returns:

the isParent

setParent

public void setParent(boolean isParent)

Parameters:

isParent - the isParent to set

setRelationViaJoinTable

public void setRelationViaJoinTable(boolean isRelationViaJoinTable)

Setter method for isRelatedViaJoinTable.

Parameters:

isRelationViaJoinTable - the new relation via join table

getRelationNames

public List<String> getRelationNames()

addRelationName

private void addRelationName(Relation rField)

Method to add specific relation name for given relational field.

Parameters:

rField - relation object.

addToRelationNameCollection

private void addToRelationNameCollection(String relationName)

Adds relation name to relation name collection.

Parameters:

relationName - relational name

getJoinColumnName

private String getJoinColumnName(Field relation)

Gets the relation field name.

Parameters:

relation - the relation

Returns:

the relation field name

isCounterColumnType

public boolean isCounterColumnType()

Returns:

the isCounterColumnType

setCounterColumnType

public void setCounterColumnType(boolean isCounterColumnType)

Parameters:

isCounterColumnType - the isCounterColumnType to set

getIdAttribute

public javax.persistence.metamodel.SingularAttribute getIdAttribute()

Returns:

the idAttribute

setIdAttribute

public void setIdAttribute(javax.persistence.metamodel.SingularAttribute idAttribute)

Parameters:

idAttribute - the idAttribute to set

addJPAColumnMapping

public void addJPAColumnMapping(String jpaColumnName,
                       String fieldName)

getFieldName

public String getFieldName(String jpaColumnName)

setEntityType

public void setEntityType(javax.persistence.metamodel.EntityType entityType)