|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.cayenne.map.Relationship
org.apache.cayenne.map.DbRelationship
public class DbRelationship
A DbRelationship is a descriptor of a database inter-table relationship based on one or more primary key/foreign key pairs.
Field Summary | |
---|---|
protected List |
joins
|
static EventSubject |
PROPERTY_DID_CHANGE
|
protected boolean |
toDependentPK
|
Fields inherited from class org.apache.cayenne.map.Relationship |
---|
name, sourceEntity, targetEntityName, toMany |
Constructor Summary | |
---|---|
DbRelationship()
|
|
DbRelationship(String name)
|
Method Summary | |
---|---|
void |
addJoin(DbJoin join)
Adds a join. |
DbRelationship |
createReverseRelationship()
Creates a new relationship with the same set of joins, but going in the opposite direction. |
void |
encodeAsXML(XMLEncoder encoder)
Prints itself as XML to the provided XMLEncoder. |
protected void |
firePropertyDidChange()
|
List |
getJoins()
Returns a list of joins. |
DbRelationship |
getReverseRelationship()
Returns DbRelationship that is the opposite of this DbRelationship. |
Collection |
getSourceAttributes()
Returns a Collection of source attributes. |
Collection |
getTargetAttributes()
Returns a Collection of target attributes. |
Entity |
getTargetEntity()
Returns a target of this relationship. |
boolean |
isToDependentPK()
Returns true if relationship from source to target points to
dependent primary key. |
boolean |
isToMasterPK()
Returns true if a method isToDependentPK of reverse
relationship of this relationship returns true . |
boolean |
isToPK()
Returns true if the relationship points to at least one of the PK columns of the target entity. |
boolean |
isValidForDepPk()
|
void |
removeAllJoins()
|
void |
removeJoin(DbJoin join)
|
void |
setJoins(Collection newJoins)
|
void |
setToDependentPK(boolean toDependentPK)
|
void |
setToMany(boolean toMany)
Sets relationship multiplicity. |
Map |
srcFkSnapshotWithTargetSnapshot(Map targetSnapshot)
Creates a snapshot of foreign key attributes of a source object of this relationship based on a snapshot of a target. |
Map |
srcPkSnapshotWithTargetSnapshot(Map targetSnapshot)
Creates a snapshot of primary key attributes of a source object of this relationship based on a snapshot of a target. |
Map |
targetPkSnapshotWithSrcSnapshot(Map srcSnapshot)
Creates a snapshot of primary key attributes of a target object of this relationship based on a snapshot of a source. |
Methods inherited from class org.apache.cayenne.map.Relationship |
---|
getName, getParent, getSourceEntity, getTargetEntityName, isToMany, setName, setParent, setSourceEntity, setTargetEntity, setTargetEntityName, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final EventSubject PROPERTY_DID_CHANGE
protected List joins
protected boolean toDependentPK
Constructor Detail |
---|
public DbRelationship()
public DbRelationship(String name)
Method Detail |
---|
public void encodeAsXML(XMLEncoder encoder)
public Entity getTargetEntity()
getTargetEntity
in class Relationship
public Collection getTargetAttributes()
public Collection getSourceAttributes()
public DbRelationship createReverseRelationship()
public DbRelationship getReverseRelationship()
public boolean isToPK()
public boolean isToMasterPK()
true
if a method isToDependentPK
of reverse
relationship of this relationship returns true
.
public boolean isToDependentPK()
true
if relationship from source to target points to
dependent primary key. Dependent PK is a primary key column of the destination
table that is also a FK to the source column.
public void setToDependentPK(boolean toDependentPK)
public boolean isValidForDepPk()
public List getJoins()
public void addJoin(DbJoin join)
public void removeJoin(DbJoin join)
public void removeAllJoins()
public void setJoins(Collection newJoins)
public Map targetPkSnapshotWithSrcSnapshot(Map srcSnapshot)
public Map srcFkSnapshotWithTargetSnapshot(Map targetSnapshot)
public Map srcPkSnapshotWithTargetSnapshot(Map targetSnapshot)
public void setToMany(boolean toMany)
protected void firePropertyDidChange()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |