Jackcess 5.2.0 · io.github.spannm.jackcess.impl.RelationshipImpl

Field Summary

Modifier and Type	Field and Description
public static final int	CASCADE_DELETES_FLAG flag indicating cascading deletes (requires referential integrity)
public static final int	CASCADE_NULL_FLAG flag indicating cascading null on delete (requires referential integrity)
public static final int	CASCADE_UPDATES_FLAG flag indicating cascading updates (requires referential integrity)
private final int	flags the various flags describing this relationship
private final List<Column>	fromColumns the columns in the "to" table in this relationship (aligned w/ toColumns list)
private final Table	fromTable the "from" table in this relationship
public static final int	LEFT_OUTER_JOIN_FLAG flag indicating left outer join
private final String	name the name of this relationship
public static final int	NO_REFERENTIAL_INTEGRITY_FLAG flag indicating no referential integrity
public static final int	ONE_TO_ONE_FLAG flag indicating one-to-one relationship
public static final int	RIGHT_OUTER_JOIN_FLAG flag indicating right outer join
private final List<Column>	toColumns the columns in the "from" table in this relationship (aligned w/ toColumns list)
private final Table	toTable the "to" table in this relationship

Constructor Summary

Access	Constructor and Description
public	RelationshipImpl(String name, Table fromTable, Table toTable, int flags, int numCols)
public	RelationshipImpl(String name, Table fromTable, Table toTable, int flags, List<? extends Column> fromCols, List<? extends Column> toCols)

Method Summary

Modifier and Type	Method and Description
public boolean	cascadeDeletes() Implements io.github.spannm.jackcess.Relationship.cascadeDeletes. Returns `true` if deletes of "from" table rows cascade to delete the corresponding "to" table rows (only meaningful if `hasReferentialIntegrity` is `true`).
public boolean	cascadeNullOnDelete() Implements io.github.spannm.jackcess.Relationship.cascadeNullOnDelete. Returns `true` if deletes of "from" table rows null out the corresponding foreign key in the "to" table rows, rather than deleting them (only meaningful if `hasReferentialIntegrity` is `true`).
public boolean	cascadeUpdates() Implements io.github.spannm.jackcess.Relationship.cascadeUpdates. Returns `true` if updates to the "from" table's key are cascaded to the "to" table (only meaningful if `hasReferentialIntegrity` is `true`).
public int	getFlags()
public List<Column>	getFromColumns() Implements io.github.spannm.jackcess.Relationship.getFromColumns. Returns the columns of `getFromTable` which participate in this relationship, in the same order as the corresponding columns returned by `getToColumns`.
public Table	getFromTable() Implements io.github.spannm.jackcess.Relationship.getFromTable. Returns the "one" (or referenced) side table of this relationship.
public Relationship.JoinType	getJoinType() Implements io.github.spannm.jackcess.Relationship.getJoinType. Returns the join type used when this relationship is followed.
public String	getName() Implements io.github.spannm.jackcess.Relationship.getName. Returns the name of this relationship.
public List<Column>	getToColumns() Implements io.github.spannm.jackcess.Relationship.getToColumns. Returns the columns of `getToTable` which participate in this relationship, in the same order as the corresponding columns returned by `getFromColumns`.
public Table	getToTable() Implements io.github.spannm.jackcess.Relationship.getToTable. Returns the "many" (or referencing) side table of this relationship.
private boolean	hasFlag(int flagMask)
public boolean	hasReferentialIntegrity() Implements io.github.spannm.jackcess.Relationship.hasReferentialIntegrity. Returns `true` if this relationship enforces referential integrity.
public boolean	isLeftOuterJoin() Implements io.github.spannm.jackcess.Relationship.isLeftOuterJoin. Returns `true` if this relationship is enforced as a left outer join.
public boolean	isOneToOne() Implements io.github.spannm.jackcess.Relationship.isOneToOne. Returns `true` if this relationship enforces a one-to-one association, `false` if one-to-many.
public boolean	isRightOuterJoin() Implements io.github.spannm.jackcess.Relationship.isRightOuterJoin. Returns `true` if this relationship is enforced as a right outer join.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

CASCADE_DELETES_FLAG	back to summary
public static final int CASCADE_DELETES_FLAG flag indicating cascading deletes (requires referential integrity)

CASCADE_NULL_FLAG	back to summary
public static final int CASCADE_NULL_FLAG flag indicating cascading null on delete (requires referential integrity)

CASCADE_UPDATES_FLAG	back to summary
public static final int CASCADE_UPDATES_FLAG flag indicating cascading updates (requires referential integrity)

flags	back to summary
private final int flags the various flags describing this relationship

fromColumns	back to summary
private final List<Column> fromColumns the columns in the "to" table in this relationship (aligned w/ toColumns list)

fromTable	back to summary
private final Table fromTable the "from" table in this relationship

LEFT_OUTER_JOIN_FLAG	back to summary
public static final int LEFT_OUTER_JOIN_FLAG flag indicating left outer join

name	back to summary
private final String name the name of this relationship

NO_REFERENTIAL_INTEGRITY_FLAG	back to summary
public static final int NO_REFERENTIAL_INTEGRITY_FLAG flag indicating no referential integrity

ONE_TO_ONE_FLAG	back to summary
public static final int ONE_TO_ONE_FLAG flag indicating one-to-one relationship

RIGHT_OUTER_JOIN_FLAG	back to summary
public static final int RIGHT_OUTER_JOIN_FLAG flag indicating right outer join

toColumns	back to summary
private final List<Column> toColumns the columns in the "from" table in this relationship (aligned w/ toColumns list)

toTable	back to summary
private final Table toTable the "to" table in this relationship

Constructor Detail

RelationshipImpl	back to summary
public RelationshipImpl(String name, Table fromTable, Table toTable, int flags, int numCols)

RelationshipImpl	back to summary
public RelationshipImpl(String name, Table fromTable, Table toTable, int flags, List<? extends Column> fromCols, List<? extends Column> toCols)

Method Detail

cascadeDeletes back to summary

cascadeDeletes	back to summary
public boolean cascadeDeletes() Implements io.github.spannm.jackcess.Relationship.cascadeDeletes. Doc from io.github.spannm.jackcess.Relationship.cascadeDeletes. Returns `true` if deletes of "from" table rows cascade to delete the corresponding "to" table rows (only meaningful if `hasReferentialIntegrity` is `true`). Annotations @Override

public boolean cascadeDeletes()

Implements io.github.spannm.jackcess.Relationship.cascadeDeletes.

Doc from io.github.spannm.jackcess.Relationship.cascadeDeletes.

Returns true if deletes of "from" table rows cascade to delete the corresponding "to" table rows (only meaningful if hasReferentialIntegrity is true).

Annotations

@Override

cascadeNullOnDelete back to summary

cascadeNullOnDelete	back to summary
public boolean cascadeNullOnDelete() Implements io.github.spannm.jackcess.Relationship.cascadeNullOnDelete. Doc from io.github.spannm.jackcess.Relationship.cascadeNullOnDelete. Returns `true` if deletes of "from" table rows null out the corresponding foreign key in the "to" table rows, rather than deleting them (only meaningful if `hasReferentialIntegrity` is `true`). Annotations @Override

public boolean cascadeNullOnDelete()

Implements io.github.spannm.jackcess.Relationship.cascadeNullOnDelete.

Doc from io.github.spannm.jackcess.Relationship.cascadeNullOnDelete.

Returns true if deletes of "from" table rows null out the corresponding foreign key in the "to" table rows, rather than deleting them (only meaningful if hasReferentialIntegrity is true).

Annotations

@Override

cascadeUpdates back to summary

cascadeUpdates	back to summary
public boolean cascadeUpdates() Implements io.github.spannm.jackcess.Relationship.cascadeUpdates. Doc from io.github.spannm.jackcess.Relationship.cascadeUpdates. Returns `true` if updates to the "from" table's key are cascaded to the "to" table (only meaningful if `hasReferentialIntegrity` is `true`). Annotations @Override

public boolean cascadeUpdates()

Implements io.github.spannm.jackcess.Relationship.cascadeUpdates.

Doc from io.github.spannm.jackcess.Relationship.cascadeUpdates.

Returns true if updates to the "from" table's key are cascaded to the "to" table (only meaningful if hasReferentialIntegrity is true).

Annotations

@Override

getFlags	back to summary
public int getFlags()

getFromColumns back to summary

getFromColumns	back to summary
public List<Column> getFromColumns() Implements io.github.spannm.jackcess.Relationship.getFromColumns. Doc from io.github.spannm.jackcess.Relationship.getFromColumns. Returns the columns of `getFromTable` which participate in this relationship, in the same order as the corresponding columns returned by `getToColumns`. Annotations @Override

public List<Column> getFromColumns()

Implements io.github.spannm.jackcess.Relationship.getFromColumns.

Doc from io.github.spannm.jackcess.Relationship.getFromColumns.

Returns the columns of getFromTable which participate in this relationship, in the same order as the corresponding columns returned by getToColumns.

Annotations

@Override

getFromTable	back to summary
public Table getFromTable() Implements io.github.spannm.jackcess.Relationship.getFromTable. Doc from io.github.spannm.jackcess.Relationship.getFromTable. Returns the "one" (or referenced) side table of this relationship. Annotations @Override

getFromTable

back to summary

public Table getFromTable()

Implements io.github.spannm.jackcess.Relationship.getFromTable.

Doc from io.github.spannm.jackcess.Relationship.getFromTable.

Returns the "one" (or referenced) side table of this relationship.

Annotations

@Override

getJoinType	back to summary
public Relationship.JoinType getJoinType() Implements io.github.spannm.jackcess.Relationship.getJoinType. Doc from io.github.spannm.jackcess.Relationship.getJoinType. Returns the join type used when this relationship is followed. Annotations @Override

getJoinType

back to summary

public Relationship.JoinType getJoinType()

Implements io.github.spannm.jackcess.Relationship.getJoinType.

Doc from io.github.spannm.jackcess.Relationship.getJoinType.

Returns the join type used when this relationship is followed.

Annotations

@Override

getName	back to summary
public String getName() Implements io.github.spannm.jackcess.Relationship.getName. Doc from io.github.spannm.jackcess.Relationship.getName. Returns the name of this relationship. Annotations @Override

getName

back to summary

public String getName()

Implements io.github.spannm.jackcess.Relationship.getName.

Doc from io.github.spannm.jackcess.Relationship.getName.

Returns the name of this relationship.

Annotations

@Override

getToColumns back to summary

getToColumns	back to summary
public List<Column> getToColumns() Implements io.github.spannm.jackcess.Relationship.getToColumns. Doc from io.github.spannm.jackcess.Relationship.getToColumns. Returns the columns of `getToTable` which participate in this relationship, in the same order as the corresponding columns returned by `getFromColumns`. Annotations @Override

public List<Column> getToColumns()

Implements io.github.spannm.jackcess.Relationship.getToColumns.

Doc from io.github.spannm.jackcess.Relationship.getToColumns.

Returns the columns of getToTable which participate in this relationship, in the same order as the corresponding columns returned by getFromColumns.

Annotations

@Override

getToTable	back to summary
public Table getToTable() Implements io.github.spannm.jackcess.Relationship.getToTable. Doc from io.github.spannm.jackcess.Relationship.getToTable. Returns the "many" (or referencing) side table of this relationship. Annotations @Override

getToTable

back to summary

public Table getToTable()

Implements io.github.spannm.jackcess.Relationship.getToTable.

Doc from io.github.spannm.jackcess.Relationship.getToTable.

Returns the "many" (or referencing) side table of this relationship.

Annotations

@Override

hasFlag	back to summary
private boolean hasFlag(int flagMask)

hasReferentialIntegrity back to summary

hasReferentialIntegrity	back to summary
public boolean hasReferentialIntegrity() Implements io.github.spannm.jackcess.Relationship.hasReferentialIntegrity. Doc from io.github.spannm.jackcess.Relationship.hasReferentialIntegrity. Returns `true` if this relationship enforces referential integrity. Annotations @Override

public boolean hasReferentialIntegrity()

Implements io.github.spannm.jackcess.Relationship.hasReferentialIntegrity.

Doc from io.github.spannm.jackcess.Relationship.hasReferentialIntegrity.

Returns true if this relationship enforces referential integrity.

Annotations

@Override

isLeftOuterJoin back to summary

isLeftOuterJoin	back to summary
public boolean isLeftOuterJoin() Implements io.github.spannm.jackcess.Relationship.isLeftOuterJoin. Doc from io.github.spannm.jackcess.Relationship.isLeftOuterJoin. Returns `true` if this relationship is enforced as a left outer join. Annotations @Override

public boolean isLeftOuterJoin()

Implements io.github.spannm.jackcess.Relationship.isLeftOuterJoin.

Doc from io.github.spannm.jackcess.Relationship.isLeftOuterJoin.

Returns true if this relationship is enforced as a left outer join.

Annotations

@Override

isOneToOne back to summary

isOneToOne	back to summary
public boolean isOneToOne() Implements io.github.spannm.jackcess.Relationship.isOneToOne. Doc from io.github.spannm.jackcess.Relationship.isOneToOne. Returns `true` if this relationship enforces a one-to-one association, `false` if one-to-many. Annotations @Override

public boolean isOneToOne()

Implements io.github.spannm.jackcess.Relationship.isOneToOne.

Doc from io.github.spannm.jackcess.Relationship.isOneToOne.

Returns true if this relationship enforces a one-to-one association, false if one-to-many.

Annotations

@Override

isRightOuterJoin back to summary

isRightOuterJoin	back to summary
public boolean isRightOuterJoin() Implements io.github.spannm.jackcess.Relationship.isRightOuterJoin. Doc from io.github.spannm.jackcess.Relationship.isRightOuterJoin. Returns `true` if this relationship is enforced as a right outer join. Annotations @Override

public boolean isRightOuterJoin()

Implements io.github.spannm.jackcess.Relationship.isRightOuterJoin.

Doc from io.github.spannm.jackcess.Relationship.isRightOuterJoin.

Returns true if this relationship is enforced as a right outer join.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class RelationshipImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail