# Uses of Class
org.apache.cayenne.map.Relationship

Packages that use Relationship
Package
Description
org.apache.cayenne.map
Contains O/R mapping classes that store relational database metadata information and map it to Java classes.
org.apache.cayenne.map.event

- ## Uses of Relationship in org.apache.cayenne.map

  Classes in org.apache.cayenne.map with type parameters of type Relationship
  Modifier and Type
  Interface
  Description
  `interface`
  `PathComponent<T extends Attribute,U extends Relationship>`
  A component in a path chain.
  Subclasses of Relationship in org.apache.cayenne.map
  Modifier and Type
  Class
  Description
  `class`
  `DbRelationship`
  A DbRelationship is a descriptor of a database inter-table relationship based on one or more primary key/foreign key pairs.
  `class`
  `ObjRelationship`
  Describes an association between two Java classes mapped as source and target ObjEntity.
  Fields in org.apache.cayenne.map with type parameters of type Relationship
  Modifier and Type
  Field
  Description
  `protected final Map<String,Relationship>`
  Entity.`relationships`
  Methods in org.apache.cayenne.map with type parameters of type Relationship
  Modifier and Type
  Method
  Description
  `<T extends Attribute, U extends Relationship>
  PathComponent<T,U>`
  Entity.`lastPathComponent(Expression path, Map aliasMap)`
  Convenience method returning the last component in the path iterator.
  `abstract <T extends Attribute, U extends Relationship>
  Iterable<PathComponent<T,U>>`
  Entity.`resolvePath(Expression pathExp, Map aliasMap)`
  Returns an Iterable over the path components with elements represented as `PathComponent` instances, encapsulating a relationship, an attribute or a subpath alias.
  Methods in org.apache.cayenne.map that return Relationship
  Modifier and Type
  Method
  Description
  `Relationship`
  Entity.`getAnyRelationship(Entity targetEntity)`
  Returns a relationship that has a specified entity as a target.
  `Relationship`
  Entity.`getRelationship(String relName)`
  Returns relationship with name `relName`.
  `abstract Relationship`
  Relationship.`getReverseRelationship()`
  Returns a "complimentary" relationship going in the opposite direction.
  Methods in org.apache.cayenne.map that return types with arguments of type Relationship
  Modifier and Type
  Method
  Description
  `Map<String,? extends Relationship>`
  Entity.`getRelationshipMap()`
  Returns an unmodifiable map of relationships sorted by name.
  `Collection<? extends Relationship>`
  Entity.`getRelationships()`
  Returns an unmodifiable collection of Relationships that exist in this entity.
  Methods in org.apache.cayenne.map with parameters of type Relationship
  Modifier and Type
  Method
  Description
  `void`
  Entity.`addRelationship(Relationship relationship)`
  Adds new relationship to the entity.

- ## Uses of Relationship in org.apache.cayenne.map.event

  Fields in org.apache.cayenne.map.event declared as Relationship
  Modifier and Type
  Field
  Description
  `protected Relationship`
  RelationshipEvent.`relationship`
  Methods in org.apache.cayenne.map.event that return Relationship
  Modifier and Type
  Method
  Description
  `Relationship`
  RelationshipEvent.`getRelationship()`
  Returns relationship associated with this event.
  Methods in org.apache.cayenne.map.event with parameters of type Relationship
  Modifier and Type
  Method
  Description
  `void`
  RelationshipEvent.`setRelationship(Relationship relationship)`
  Sets relationship associated with this event.
  Constructors in org.apache.cayenne.map.event with parameters of type Relationship
  Modifier
  Constructor
  Description
  ``
  `RelationshipEvent(Object src, Relationship rel, Entity entity)`
  Creates a Relationship change event.
  ``
  `RelationshipEvent(Object src, Relationship rel, Entity entity, int id)`
  Creates a Relationship event of a specified type.
  ``
  `RelationshipEvent(Object src, Relationship rel, Entity entity, String oldName)`
  Creates a Relationship name change event.