Package org.apache.cayenne.map
Class DbEntity
java.lang.Object
org.apache.cayenne.map.Entity
org.apache.cayenne.map.DbEntity
- All Implemented Interfaces:
Serializable,EventListener,ConfigurationNode,DbAttributeListener,DbEntityListener,DbRelationshipListener,CayenneMapEntry,XMLSerializable
public class DbEntity
extends Entity
implements ConfigurationNode, DbEntityListener, DbAttributeListener, DbRelationshipListener
A DbEntity is a mapping descriptor that defines a structure of a database
table.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Stringprotected Collection<DbAttribute> protected List<DbAttribute> protected DbKeyGeneratorprotected ExpressionQualifier, that will be applied to all select queries and joins with this DbEntityprotected StringFields 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> TacceptVisitor(ConfigurationNodeVisitor<T> visitor) voidaddAttribute(DbAttribute attr) Adds a new attribute to this entity.voidvoidNew attribute has been created/added.voidAttribute property changed.voidAttribute has been removed.voidNew entity has been created/added.voidDbEntity property changed event.voidEntity has been removed.voidRelationship has been created/added.voidRelationship property changed.voidRelationship has been removed.voidencodeAsXML(XMLEncoder encoder, ConfigurationNodeVisitor delegate) Prints itself as XML to the provided XMLEncoder.getAttribute(String attributeName) Returns attribute with nameattributeNameor null if no attribute with this name exists.Returns a Collection of all attributes that either belong to this DbEntity or inherited.Returns the catalog name of the table described by this DbEntity.Returns table name including catalog and schema, if any of those are present.Returns an unmodifiable collection of DbAttributes that are generated by the database.Return the primary key generator for this entity.Returns an unmodifiable collection of DbAttributes representing the primary key of the table described by this DbEntity.getRelationship(String relName) Returns relationship with namerelName.Returns an unmodifiable map of relationships sorted by name.Returns a Collection of relationships from this entity or inherited.Returns database schema of this table.booleanReturns true if there is full replacement id is attached to an ObjectId.lastPathComponent(Expression path, Map aliasMap) Convenience method returning the last component in the path iterator.voidremoveAttribute(String attrName) Removes attribute from the entity, removes any relationship joins containing this attribute.resolvePath(Expression pathExp, Map aliasMap) Returns an Iterable instance over expression path components based on this entity.resolvePathComponents(Expression pathExp) Processes expressionpathExpand returns an Iterator of path components that contains a sequence of Attributes and Relationships.voidsetCatalog(String catalog) Sets the catalog name of the table described by this DbEntity.voidsetPrimaryKeyGenerator(DbKeyGenerator primaryKeyGenerator) Set the primary key generator for this entity.voidsetQualifier(Expression qualifier) Sets qualifier for this entityvoidSets the database schema name of the table described by this DbEntity.translateToRelatedEntity(Expression expression, String relationshipPath) Transforms Expression rooted in this entity to an analogous expression rooted in related entity.Methods inherited from class org.apache.cayenne.map.Entity
addAttribute, addRelationship, clearRelationships, getAnyRelationship, getAttributeMap, getDataMap, getName, getParent, removeRelationship, resolvePathComponents, setDataMap, setName, setParent, toString, updateAttribute
-
Field Details
-
catalog
-
schema
-
-
generatedAttributes
- Since:
- 1.2
-
primaryKeyGenerator
-
qualifier
Qualifier, that will be applied to all select queries and joins with this DbEntity
-
-
Constructor Details
-
DbEntity
public DbEntity()Creates an unnamed DbEntity. -
DbEntity
Creates a named DbEntity.
-
-
Method Details
-
getRelationship
Description copied from class:EntityReturns relationship with namerelName. Will return null if no relationship with this name exists in the entity.- Overrides:
getRelationshipin classEntity
-
getAttribute
Description copied from class:EntityReturns attribute with nameattributeNameor null if no attribute with this name exists.- Overrides:
getAttributein classEntity
-
acceptVisitor
- Specified by:
acceptVisitorin interfaceConfigurationNode- Since:
- 3.1
-
encodeAsXML
Prints itself as XML to the provided XMLEncoder.- Specified by:
encodeAsXMLin interfaceXMLSerializable- Since:
- 1.1
-
getFullyQualifiedName
Returns table name including catalog and schema, if any of those are present. -
getSchema
Returns database schema of this table.- Returns:
- table's schema, null if not set.
-
setSchema
Sets the database schema name of the table described by this DbEntity. -
getCatalog
Returns the catalog name of the table described by this DbEntity. -
setCatalog
Sets the catalog name of the table described by this DbEntity. -
getPrimaryKeys
Returns an unmodifiable collection of DbAttributes representing the primary key of the table described by this DbEntity.- Since:
- 3.0
-
getAttributes
Returns a Collection of all attributes that either belong to this DbEntity or inherited.- Overrides:
getAttributesin classEntity
-
getGeneratedAttributes
Returns an unmodifiable collection of DbAttributes that are generated by the database.- Since:
- 1.2
-
addAttribute
Adds a new attribute to this entity.- Throws:
IllegalArgumentException- if Attribute has no name or there is an existing attribute with the same nameIllegalArgumentException- if a relationship has the same name as this attribute- Since:
- 3.0
-
removeAttribute
Removes attribute from the entity, removes any relationship joins containing this attribute. Does nothing if the attribute name is not found.- Overrides:
removeAttributein classEntity- See Also:
-
clearAttributes
public void clearAttributes()- Overrides:
clearAttributesin classEntity
-
getRelationships
Returns a Collection of relationships from this entity or inherited.- Overrides:
getRelationshipsin classEntity
-
getRelationshipMap
Description copied from class:EntityReturns an unmodifiable map of relationships sorted by name.- Overrides:
getRelationshipMapin classEntity
-
lastPathComponent
Description copied from class:EntityConvenience method returning the last component in the path iterator. If the last component is an alias, it is fully resolved down to the last ObjRelationship.- Overrides:
lastPathComponentin classEntity- Since:
- 3.0
-
resolvePath
public Iterable<PathComponent<DbAttribute,DbRelationship>> resolvePath(Expression pathExp, Map aliasMap) Returns an Iterable instance over expression path components based on this entity.- Specified by:
resolvePathin classEntity- Since:
- 3.0
-
resolvePathComponents
public Iterator<CayenneMapEntry> resolvePathComponents(Expression pathExp) throws ExpressionException Description copied from class:EntityProcesses expressionpathExpand 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:
resolvePathComponentsin classEntity- Throws:
ExpressionException
-
setPrimaryKeyGenerator
Set the primary key generator for this entity. If null is passed, nothing is changed. -
getPrimaryKeyGenerator
Return the primary key generator for this entity. -
dbEntityChanged
DbEntity property changed event. May be name, attribute or relationship added or removed, etc. Attribute and relationship property changes are handled in respective listeners.- Specified by:
dbEntityChangedin interfaceDbEntityListener- Since:
- 1.2
-
dbEntityAdded
New entity has been created/added.- Specified by:
dbEntityAddedin interfaceDbEntityListener
-
dbEntityRemoved
Entity has been removed.- Specified by:
dbEntityRemovedin interfaceDbEntityListener
-
dbAttributeAdded
Description copied from interface:DbAttributeListenerNew attribute has been created/added.- Specified by:
dbAttributeAddedin interfaceDbAttributeListener
-
dbAttributeChanged
Description copied from interface:DbAttributeListenerAttribute property changed.- Specified by:
dbAttributeChangedin interfaceDbAttributeListener
-
dbAttributeRemoved
Description copied from interface:DbAttributeListenerAttribute has been removed.- Specified by:
dbAttributeRemovedin interfaceDbAttributeListener
-
dbRelationshipChanged
Relationship property changed.- Specified by:
dbRelationshipChangedin interfaceDbRelationshipListener
-
dbRelationshipAdded
Relationship has been created/added.- Specified by:
dbRelationshipAddedin interfaceDbRelationshipListener
-
dbRelationshipRemoved
Relationship has been removed.- Specified by:
dbRelationshipRemovedin interfaceDbRelationshipListener
-
getQualifier
- Returns:
- qualifier that will be ANDed to all select queries with this entity
-
setQualifier
Sets qualifier for this entity -
isFullReplacementIdAttached
Returns true if there is full replacement id is attached to an ObjectId. "Full" means that all PK columns are present and only PK columns are present.- Since:
- 1.2
-
mappedObjEntities
-
translateToRelatedEntity
Transforms Expression rooted in this entity to an analogous expression rooted in related entity.- Specified by:
translateToRelatedEntityin classEntity- Since:
- 1.1
-