Class DbEntity

java.lang.Object
org.apache.cayenne.map.Entity<DbEntity, DbAttribute, DbRelationship>
org.apache.cayenne.map.DbEntity
All Implemented Interfaces:
Serializable, ConfigurationNode, CayenneMapEntry, XMLSerializable
public class DbEntity extends Entity<DbEntity, DbAttribute, DbRelationship> implements ConfigurationNode
A DbEntity is a mapping descriptor that defines a structure of a database table.
See Also:

  • Field Details

    • catalog

      protected String catalog

    • schema

      protected String schema

    • primaryKey

      protected List<DbAttribute> primaryKey

    • generatedAttributes

      protected Collection<DbAttribute> generatedAttributes
      Since:
      1.2

    • primaryKeyGenerator

      protected DbKeyGenerator primaryKeyGenerator

    • qualifier

      protected Expression 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

      public DbEntity(String name)
      Creates a named DbEntity.

  • Method Details

    • acceptVisitor

      public <T> T acceptVisitor(ConfigurationNodeVisitor<T> visitor)
      Specified by:
      acceptVisitor in interface ConfigurationNode
      Since:
      3.1

    • encodeAsXML

      public void encodeAsXML(XMLEncoder encoder, ConfigurationNodeVisitor delegate)
      Prints itself as XML to the provided XMLEncoder.
      Specified by:
      encodeAsXML in interface XMLSerializable
      Since:
      1.1

    • getFullyQualifiedName

      public String getFullyQualifiedName()
      Returns table name including catalog and schema, if any of those are present.

    • getSchema

      public String getSchema()
      Returns database schema of this table.
      Returns:
      table's schema, null if not set.

    • setSchema

      public void setSchema(String schema)
      Sets the database schema name of the table described by this DbEntity.

    • getCatalog

      public String getCatalog()
      Returns the catalog name of the table described by this DbEntity.

    • setCatalog

      public void setCatalog(String catalog)
      Sets the catalog name of the table described by this DbEntity.

    • getPrimaryKeys

      public List<DbAttribute> getPrimaryKeys()
      Returns an unmodifiable collection of DbAttributes representing the primary key of the table described by this DbEntity.
      Since:
      3.0

    • getGeneratedAttributes

      public Collection<DbAttribute> getGeneratedAttributes()
      Returns an unmodifiable collection of DbAttributes that are generated by the database.
      Since:
      1.2

    • addAttribute

      public void addAttribute(DbAttribute attr)
      Adds a new attribute to this entity.
      Overrides:
      addAttribute in class Entity<DbEntity, DbAttribute, DbRelationship>
      Throws:
      IllegalArgumentException - if Attribute has no name or there is an existing attribute with the same name
      IllegalArgumentException - if a relationship has the same name as this attribute
      Since:
      3.0

    • removeAttribute

      public void removeAttribute(String attrName)
      Removes attribute from the entity, removes any relationship joins containing this attribute. Does nothing if the attribute name is not found.
      Overrides:
      removeAttribute in class Entity<DbEntity, DbAttribute, DbRelationship>
      See Also:

    • clearAttributes

      public void clearAttributes()
      Overrides:
      clearAttributes in class Entity<DbEntity, DbAttribute, DbRelationship>

    • renameAttribute

      public void renameAttribute(DbAttribute attr, String newName)
      Renames an attribute owned by this entity, re-keying the attribute map and updating all dependent references across the parent DataMap: ObjAttribute paths and DbJoin source/target names.
      Since:
      5.0

    • renameRelationship

      public void renameRelationship(DbRelationship rel, String newName)
      Renames a relationship owned by this entity, re-keying the relationship map and refreshing dependent ObjAttribute db-paths across the parent DataMap.
      Since:
      5.0

    • resolvePath

      public Iterable<PathComponent<DbAttribute, DbRelationship>> resolvePath(Expression pathExp, Map<String,String> aliasMap)
      Returns an Iterable instance over expression path components based on this entity.
      Specified by:
      resolvePath in class Entity<DbEntity, DbAttribute, DbRelationship>
      Since:
      3.0

    • resolvePathComponents

      public Iterator<CayenneMapEntry> resolvePathComponents(Expression pathExp) throws ExpressionException
      Description copied from class: Entity
      Processes expression pathExp 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 class Entity<DbEntity, DbAttribute, DbRelationship>
      Throws:
      ExpressionException

    • setPrimaryKeyGenerator

      public void setPrimaryKeyGenerator(DbKeyGenerator primaryKeyGenerator)
      Set the primary key generator for this entity. If null is passed, nothing is changed.

    • getPrimaryKeyGenerator

      public DbKeyGenerator getPrimaryKeyGenerator()
      Return the primary key generator for this entity.

    • getQualifier

      public Expression getQualifier()
      Returns:
      qualifier that will be ANDed to all select queries with this entity

    • setQualifier

      public void setQualifier(Expression qualifier)
      Sets qualifier for this entity

    • isFullReplacementIdAttached

      public boolean isFullReplacementIdAttached(ObjectId id)
      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

      public Collection<ObjEntity> mappedObjEntities()

    • translateToRelatedEntity

      public Expression translateToRelatedEntity(Expression expression, CayennePath relationshipPath)
      Transforms Expression rooted in this entity to an analogous expression rooted in related entity.
      Specified by:
      translateToRelatedEntity in class Entity<DbEntity, DbAttribute, DbRelationship>
      Since:
      5.0