Jackcess 5.2.0 · io.github.spannm.jackcess.Relationship

Modifier and Type	Class and Description
public static enum	Relationship.JoinType The type of join used when this relationship is followed, mirroring Access's own join type options.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if deletes of "from" table rows cascade to delete the corresponding "to" table rows (only meaningful if `hasReferentialIntegrity` is `true`) 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	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`) 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	Returns: `true` if updates to the "from" table's key are cascaded to the "to" table (only meaningful if `hasReferentialIntegrity` is `true`) cascadeUpdates() Returns `true` if updates to the "from" table's key are cascaded to the "to" table (only meaningful if `hasReferentialIntegrity` is `true`).
public List<Column>	Returns: the columns of `getFromTable` which participate in this relationship, in the same order as the corresponding columns returned by `getToColumns` getFromColumns() Returns the columns of `getFromTable` which participate in this relationship, in the same order as the corresponding columns returned by `getToColumns`.
public Table	Returns: the "one" (or referenced) side table of this relationship getFromTable() Returns the "one" (or referenced) side table of this relationship.
public Relationship.JoinType	Returns: the join type used when this relationship is followed getJoinType() Returns the join type used when this relationship is followed.
public String	Returns: the name of this relationship getName() Returns the name of this relationship.
public List<Column>	Returns: the columns of `getToTable` which participate in this relationship, in the same order as the corresponding columns returned by `getFromColumns` getToColumns() Returns the columns of `getToTable` which participate in this relationship, in the same order as the corresponding columns returned by `getFromColumns`.
public Table	Returns: the "many" (or referencing) side table of this relationship getToTable() Returns the "many" (or referencing) side table of this relationship.
public boolean	Returns: `true` if this relationship enforces referential integrity hasReferentialIntegrity() Returns `true` if this relationship enforces referential integrity.
public boolean	Returns: `true` if this relationship is enforced as a left outer join isLeftOuterJoin() Returns `true` if this relationship is enforced as a left outer join.
public boolean	Returns: `true` if this relationship enforces a one-to-one association, `false` if one-to-many isOneToOne() Returns `true` if this relationship enforces a one-to-one association, `false` if one-to-many.
public boolean	Returns: `true` if this relationship is enforced as a right outer join isRightOuterJoin() Returns `true` if this relationship is enforced as a right outer join.

Method Detail

cascadeDeletes back to summary

cascadeDeletes	back to summary
public boolean cascadeDeletes() Returns `true` if deletes of "from" table rows cascade to delete the corresponding "to" table rows (only meaningful if `hasReferentialIntegrity` is `true`). Returns:boolean `true` if deletes of "from" table rows cascade to delete the corresponding "to" table rows (only meaningful if `hasReferentialIntegrity` is `true`)

public boolean cascadeDeletes()

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

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

cascadeNullOnDelete back to summary

cascadeNullOnDelete	back to summary
public boolean 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`). Returns:boolean `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 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).

Returns:boolean: 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)

cascadeUpdates back to summary

cascadeUpdates	back to summary
public boolean cascadeUpdates() Returns `true` if updates to the "from" table's key are cascaded to the "to" table (only meaningful if `hasReferentialIntegrity` is `true`). Returns:boolean `true` if updates to the "from" table's key are cascaded to the "to" table (only meaningful if `hasReferentialIntegrity` is `true`)

public boolean cascadeUpdates()

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

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

getFromColumns back to summary

getFromColumns	back to summary
public List<Column> getFromColumns() Returns the columns of `getFromTable` which participate in this relationship, in the same order as the corresponding columns returned by `getToColumns`. Returns:List<Column> the columns of `getFromTable` which participate in this relationship, in the same order as the corresponding columns returned by `getToColumns`

public List<Column> getFromColumns()

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

Returns:List<Column>: the columns of getFromTable which participate in this relationship, in the same order as the corresponding columns returned by getToColumns

getFromTable	back to summary
public Table getFromTable() Returns the "one" (or referenced) side table of this relationship. Returns:Table the "one" (or referenced) side table of this relationship

getFromTable

back to summary

public Table getFromTable()

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

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

getJoinType	back to summary
public Relationship.JoinType getJoinType() Returns the join type used when this relationship is followed. Returns:Relationship.JoinType the join type used when this relationship is followed

getJoinType

back to summary

public Relationship.JoinType getJoinType()

Returns the join type used when this relationship is followed.

Returns:Relationship.JoinType: the join type used when this relationship is followed

getName	back to summary
public String getName() Returns the name of this relationship. Returns:String the name of this relationship

getName

back to summary

public String getName()

Returns the name of this relationship.

Returns:String: the name of this relationship

getToColumns back to summary

getToColumns	back to summary
public List<Column> getToColumns() Returns the columns of `getToTable` which participate in this relationship, in the same order as the corresponding columns returned by `getFromColumns`. Returns:List<Column> the columns of `getToTable` which participate in this relationship, in the same order as the corresponding columns returned by `getFromColumns`

public List<Column> getToColumns()

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

Returns:List<Column>: the columns of getToTable which participate in this relationship, in the same order as the corresponding columns returned by getFromColumns

getToTable	back to summary
public Table getToTable() Returns the "many" (or referencing) side table of this relationship. Returns:Table the "many" (or referencing) side table of this relationship

getToTable

back to summary

public Table getToTable()

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

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

hasReferentialIntegrity back to summary

hasReferentialIntegrity	back to summary
public boolean hasReferentialIntegrity() Returns `true` if this relationship enforces referential integrity. Returns:boolean `true` if this relationship enforces referential integrity

public boolean hasReferentialIntegrity()

Returns true if this relationship enforces referential integrity.

Returns:boolean: true if this relationship enforces referential integrity

isLeftOuterJoin back to summary

isLeftOuterJoin	back to summary
public boolean isLeftOuterJoin() Returns `true` if this relationship is enforced as a left outer join. Returns:boolean `true` if this relationship is enforced as a left outer join

public boolean isLeftOuterJoin()

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

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

isOneToOne back to summary

isOneToOne	back to summary
public boolean isOneToOne() Returns `true` if this relationship enforces a one-to-one association, `false` if one-to-many. Returns:boolean `true` if this relationship enforces a one-to-one association, `false` if one-to-many

public boolean isOneToOne()

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

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

isRightOuterJoin back to summary

isRightOuterJoin	back to summary
public boolean isRightOuterJoin() Returns `true` if this relationship is enforced as a right outer join. Returns:boolean `true` if this relationship is enforced as a right outer join

public boolean isRightOuterJoin()

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

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

Modifier and Type	Field and Description
public static final Relationship.JoinType	INNER
public static final Relationship.JoinType	LEFT_OUTER
public static final Relationship.JoinType	RIGHT_OUTER

Modifier and Type	Method and Description
public static Relationship.JoinType	valueOf(String name)
public static Relationship.JoinType[]	values()

public Interface Relationship

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum Relationship.JoinType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail