Package org.apache.cayenne.map
Class ObjEntity
java.lang.Object
org.apache.cayenne.map.Entity<ObjEntity,ObjAttribute,ObjRelationship>
org.apache.cayenne.map.ObjEntity
- All Implemented Interfaces:
Serializable
,EventListener
,ConfigurationNode
,ObjEntityListener
,CayenneMapEntry
,XMLSerializable
public class ObjEntity
extends Entity<ObjEntity,ObjAttribute,ObjRelationship>
implements ObjEntityListener, ConfigurationNode
ObjEntity is a mapping descriptor for a Persistent Java class. It contains
the information about the Java class itself, as well as its mapping to the
DbEntity layer.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
protected Map
<String, CayennePath> protected CallbackMap
protected String
protected String
protected static final Collection
<String> A collection of default "generic" entity classes excluded from class generation.static final int
static final int
protected int
protected Expression
protected boolean
protected String
protected String
Fields inherited from class org.apache.cayenne.map.Entity
attributes, dataMap, name, OUTER_JOIN_INDICATOR, PATH_SEPARATOR, relationships
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription<T> T
acceptVisitor
(ConfigurationNodeVisitor<T> visitor) void
addAttributeOverride
(String attributeName, String dbPath) void
addAttributeOverride
(String attributeName, CayennePath dbPath) void
Clears all the mapping between this obj entity and its current db entity.void
encodeAsXML
(XMLEncoder encoder, ConfigurationNodeVisitor delegate) Prints itself as XML to the provided XMLEncoder.getAttribute
(String name) Returns a named attribute that is either declared in this ObjEntity or is inherited.getAttributeForDbAttribute
(DbAttribute dbAttribute) Returns ObjAttribute of this entity that maps todbAttribute
parameter.Returns a Map of all attributes that either belong to this ObjEntity or inherited.Returns a Collection of all attributes that either belong to this ObjEntity or inherited.Returns an object that stores callback methods of this entity.Returns the name of Persistent class described by this entity.Returns a DbEntity associated with this ObjEntity.Returns the name of the underlying DbEntity.getDeclaredAttribute
(String name) Finds attribute declared by this ObjEntity, excluding inherited attributes.Returns a Collection of all attributes that belong to this ObjEntity, excluding inherited attributes.int
Returns the type of lock used by this ObjEntity, regardless of what locking type is used by super entities.Returns a qualifier that imposes a restriction on what objects belong to this entity.Returns a Collection of all relationships that belong to this ObjEntity, excluding inherited attributes.Returns a non-null class name.int
Returns the type of lock used by this ObjEntity.Returns the names of DbAtributes that comprise the primary key of the parent DbEntity.Returns an unmodifiable collection of ObjAttributes representing the primary key of the table described by this DbEntity.getRelationship
(String name) Returns a named Relationship that either belongs to this ObjEntity or is inherited.getRelationshipForDbRelationship
(DbRelationship dbRelationship) Returns ObjRelationship of this entity that maps todbRelationship
parameter.Returns an unmodifiable map of relationships sorted by name.Returns an unmodifiable collection of Relationships that exist in this entity.Returns a fully-qualified name of the super class of the Persistent class.Returns a "super" entity in the entity inheritance hierarchy.Returns an entity name for a parent entity in the inheritance hierarchy.boolean
boolean
Returns whether this entity is "generic", meaning it is not mapped to a unique Java class.boolean
Returnstrue
if this ObjEntity represents a set of read-only objects.boolean
isSubentityOf
(ObjEntity entity) Returns true if this entity directly or indirectly inherits from a given entity, false otherwise.void
New entity has been created/added.void
ObjEntity property changed.void
Entity has been removed.void
removeAttributeOverride
(String attributeName) resolvePath
(Expression pathExp, Map<String, String> aliasMap) Returns an Iterable instance over expression path components based on this entity.resolvePathComponents
(Expression pathExp) Processes expressionpathExp
and returns an Iterator of path components that contains a sequence of Attributes and Relationships.void
setAbstract
(boolean isAbstract) Sets whether this entity is abstract only.void
setClassName
(String className) Sets the name of the Persistent class described by this entity.void
setDbEntity
(DbEntity dbEntity) Sets the DbEntity used by this ObjEntity.void
setDbEntityName
(String string) Sets the name of underlying DbEntity.void
setDeclaredLockType
(int i) Sets the type of lock used by this ObjEntity.void
setDeclaredQualifier
(Expression qualifier) Sets a qualifier that imposes a limit on what objects belong to this entity.void
setReadOnly
(boolean readOnly) void
setSuperClassName
(String superClassName) Sets a fully-qualified name of the super class of the Persistent class.void
setSuperEntityName
(String superEntityName) Sets an entity name for a parent entity in the inheritance hierarchy.translateToDbPath
(Expression expression) Transforms an Expression to an analogous expression in terms of the underlying DbEntity.translateToRelatedEntity
(Expression expression, String relationshipPath) Transforms an Expression rooted in this entity to an analogous expression rooted in related entity.translateToRelatedEntity
(Expression expression, CayennePath relationshipPath) Transforms an Expression rooted in this entity to an analogous expression rooted in related entity.Methods inherited from class org.apache.cayenne.map.Entity
addAttribute, addRelationship, clearAttributes, clearRelationships, getAnyRelationship, getDataMap, getName, getParent, lastPathComponent, removeAttribute, removeRelationship, resolvePathComponents, resolvePathComponents, setDataMap, setName, setParent, toString, updateAttribute
-
Field Details
-
LOCK_TYPE_NONE
public static final int LOCK_TYPE_NONE- See Also:
-
LOCK_TYPE_OPTIMISTIC
public static final int LOCK_TYPE_OPTIMISTIC- See Also:
-
DEFAULT_GENERIC_CLASSES
A collection of default "generic" entity classes excluded from class generation.- Since:
- 1.2
-
superClassName
-
className
-
dbEntityName
-
superEntityName
-
qualifier
-
readOnly
protected boolean readOnly -
lockType
protected int lockType -
_abstract
protected boolean _abstract -
callbacks
-
attributeOverrides
-
-
Constructor Details
-
ObjEntity
public ObjEntity() -
ObjEntity
-
-
Method Details
-
acceptVisitor
- Specified by:
acceptVisitor
in interfaceConfigurationNode
- Since:
- 3.1
-
encodeAsXML
Prints itself as XML to the provided XMLEncoder.- Specified by:
encodeAsXML
in interfaceXMLSerializable
- Since:
- 1.1
-
getJavaClassName
Returns a non-null class name. For generic entities with no class specified explicitly, default DataMap superclass is used, and if it is not set - GenericPersistentObject is used.- Since:
- 4.0
-
getCallbackMap
Returns an object that stores callback methods of this entity.- Since:
- 3.0
-
getLockType
public int getLockType()Returns the type of lock used by this ObjEntity. If this entity is not locked, this method would look in a super entity recursively, until it finds a lock somewhere in the inheritance hierarchy.- Since:
- 1.1
-
getDeclaredLockType
public int getDeclaredLockType()Returns the type of lock used by this ObjEntity, regardless of what locking type is used by super entities.- Since:
- 1.1
-
setDeclaredLockType
public void setDeclaredLockType(int i) Sets the type of lock used by this ObjEntity.- Since:
- 1.1
-
isGeneric
public boolean isGeneric()Returns whether this entity is "generic", meaning it is not mapped to a unique Java class. Criterion for generic entities is that it either has no Java class mapped or its class is the same as DataMap's default superclass, or it is GenericPersistentObject.- Since:
- 1.2
-
isAbstract
public boolean isAbstract() -
setAbstract
public void setAbstract(boolean isAbstract) Sets whether this entity is abstract only. -
getDeclaredQualifier
Returns a qualifier that imposes a restriction on what objects belong to this entity. Returned qualifier is the one declared in this entity, and does not include qualifiers declared in super entities.- Since:
- 1.1
-
getSuperEntityName
Returns an entity name for a parent entity in the inheritance hierarchy.- Since:
- 1.1
-
setDeclaredQualifier
Sets a qualifier that imposes a limit on what objects belong to this entity.- Since:
- 1.1
-
setSuperEntityName
Sets an entity name for a parent entity in the inheritance hierarchy.- Since:
- 1.1
-
getClassName
Returns the name of Persistent class described by this entity. -
setClassName
Sets the name of the Persistent class described by this entity. -
getSuperClassName
Returns a fully-qualified name of the super class of the Persistent class. This value is used as a hint for class generation. If the entity inherits from another entity, a superclass is the class of that entity. -
setSuperClassName
Sets a fully-qualified name of the super class of the Persistent class. This value is used as a hint for class generation.An attempt to set superclass on an inherited entity has no effect, since a class of the super entity is always used as a superclass.
-
getSuperEntity
Returns a "super" entity in the entity inheritance hierarchy.- Since:
- 1.1
-
getDbEntity
Returns a DbEntity associated with this ObjEntity. -
setDbEntity
Sets the DbEntity used by this ObjEntity.Setting DbEntity on an inherited entity has no effect, since a class of the super entity is always used as a superclass.
-
getPrimaryKeys
Returns an unmodifiable collection of ObjAttributes representing the primary key of the table described by this DbEntity. Note that since PK is very often not an object property, the returned collection may contain "synthetic" ObjAttributes that are created on the fly and are not a part of ObjEntity and will not be a part of entity.getAttributes().- Since:
- 3.0
-
getAttribute
Returns a named attribute that is either declared in this ObjEntity or is inherited. In any case returned attribute 'getEntity' method will return this entity. Returns null if no matching attribute is found.- Overrides:
getAttribute
in classEntity<ObjEntity,
ObjAttribute, ObjRelationship>
-
getAttributeMap
Returns a Map of all attributes that either belong to this ObjEntity or inherited.- Overrides:
getAttributeMap
in classEntity<ObjEntity,
ObjAttribute, ObjRelationship>
-
addAttributeOverride
- Since:
- 3.0
- See Also:
-
addAttributeOverride
- Since:
- 5.0
-
removeAttributeOverride
- Since:
- 4.0
-
getDeclaredAttributeOverrides
- Since:
- 3.0, 5.0 result map uses
CayennePath
instead of String as values
-
getAttributes
Returns a Collection of all attributes that either belong to this ObjEntity or inherited.- Overrides:
getAttributes
in classEntity<ObjEntity,
ObjAttribute, ObjRelationship>
-
getDeclaredAttributes
Returns a Collection of all attributes that belong to this ObjEntity, excluding inherited attributes.- Since:
- 1.1
-
getDeclaredAttribute
Finds attribute declared by this ObjEntity, excluding inherited attributes.- Parameters:
name
- of the attribute- Returns:
- declared attribute or null if no attribute is found
- Since:
- 4.0
- See Also:
-
getRelationship
Returns a named Relationship that either belongs to this ObjEntity or is inherited. Returns null if no matching attribute is found.- Overrides:
getRelationship
in classEntity<ObjEntity,
ObjAttribute, ObjRelationship>
-
getRelationshipMap
Description copied from class:Entity
Returns an unmodifiable map of relationships sorted by name.- Overrides:
getRelationshipMap
in classEntity<ObjEntity,
ObjAttribute, ObjRelationship>
-
getRelationships
Description copied from class:Entity
Returns an unmodifiable collection of Relationships that exist in this entity.- Overrides:
getRelationships
in classEntity<ObjEntity,
ObjAttribute, ObjRelationship>
-
getDeclaredRelationships
Returns a Collection of all relationships that belong to this ObjEntity, excluding inherited attributes.- Since:
- 1.1
-
getAttributeForDbAttribute
Returns ObjAttribute of this entity that maps todbAttribute
parameter. Returns null if no such attribute is found. -
getPrimaryKeyNames
Returns the names of DbAtributes that comprise the primary key of the parent DbEntity.- Since:
- 3.0
-
getRelationshipForDbRelationship
Returns ObjRelationship of this entity that maps todbRelationship
parameter. Returns null if no such relationship is found. -
clearDbMapping
public void clearDbMapping()Clears all the mapping between this obj entity and its current db entity. Clears mapping between entities, attributes and relationships. -
isReadOnly
public boolean isReadOnly()Returnstrue
if this ObjEntity represents a set of read-only objects.- Returns:
- boolean
-
setReadOnly
public void setReadOnly(boolean readOnly) -
isSubentityOf
Returns true if this entity directly or indirectly inherits from a given entity, false otherwise.- Since:
- 1.1
-
resolvePath
public Iterable<PathComponent<ObjAttribute,ObjRelationship>> resolvePath(Expression pathExp, Map<String, String> aliasMap) Returns an Iterable instance over expression path components based on this entity.- Specified by:
resolvePath
in classEntity<ObjEntity,
ObjAttribute, ObjRelationship> - Since:
- 3.0
-
resolvePathComponents
public Iterator<CayenneMapEntry> resolvePathComponents(Expression pathExp) throws ExpressionException Description copied from class:Entity
Processes expressionpathExp
and returns an Iterator of path components that contains a sequence of Attributes and Relationships. Note that if path is invalid and can not be resolved from this entity, this method will still return an Iterator, but an attempt to read the first invalid path component will result in ExpressionException.- Specified by:
resolvePathComponents
in classEntity<ObjEntity,
ObjAttribute, ObjRelationship> - Throws:
ExpressionException
-
translateToDbPath
Transforms an Expression to an analogous expression in terms of the underlying DbEntity.- Since:
- 1.1
-
translateToRelatedEntity
Transforms an Expression rooted in this entity to an analogous expression rooted in related entity.- Overrides:
translateToRelatedEntity
in classEntity<ObjEntity,
ObjAttribute, ObjRelationship> - Since:
- 1.1
- See Also:
-
translateToRelatedEntity
Transforms an Expression rooted in this entity to an analogous expression rooted in related entity.- Specified by:
translateToRelatedEntity
in classEntity<ObjEntity,
ObjAttribute, ObjRelationship> - Parameters:
expression
- expression to translaterelationshipPath
- path to the related entity- Returns:
- transformed expression
- Since:
- 5.0
-
getCallbackMethods
- Since:
- 4.0
-
getDbEntityName
Returns the name of the underlying DbEntity.- Since:
- 1.1
-
setDbEntityName
Sets the name of underlying DbEntity.- Since:
- 1.1
-
objEntityChanged
ObjEntity property changed. May be name, attribute or relationship added or removed, etc. Attribute and relationship property changes are handled in respective listeners.- Specified by:
objEntityChanged
in interfaceObjEntityListener
- Since:
- 1.2
-
objEntityAdded
New entity has been created/added.- Specified by:
objEntityAdded
in interfaceObjEntityListener
-
objEntityRemoved
Entity has been removed.- Specified by:
objEntityRemoved
in interfaceObjEntityListener
-