Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.sql.execute.FKInfo

Field Summary

Modifier and Type	Field and Description
pack-priv int[]	colArray
pack-priv boolean[]	deferrable
pack-priv long[]	fkConglomNumbers
pack-priv String[]	fkConstraintNames
pack-priv UUID[]	fkIds
pack-priv boolean[]	fkIsSelfReferencing
private UUID[]	fkUUIDs
public static final int	FOREIGN_KEY This class implements Formatable.
pack-priv int[]	raRules
pack-priv long	refConglomNumber
pack-priv UUID	refConstraintID
pack-priv boolean	refConstraintIsDeferrable
public static final int	REFERENCED_KEY
pack-priv UUID	refUUID
pack-priv RowLocation	rowLocation
pack-priv String	schemaName
pack-priv int	stmtType
pack-priv String	tableName
pack-priv int	type

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	FKInfo() Niladic constructor for Formattable
public	FKInfo(String[] the foreign key constraint names fkConstraintNames, String the name of the schema of the table being modified schemaName, String the name of the table being modified tableName, int the type of the statement: e.g. StatementType.INSERT stmtType, int either FKInfo.REFERENCED_KEY or FKInfo.FOREIGN_KEY type, UUID UUID of the referenced constraint's supporting index refUUID, long conglomerate number of the referenced key refConglomNumber, UUID UUID of the referenced constraint refConstraintID, boolean `true` iff the referenced key constraint is deferrable refConstraintIsDeferrable, UUID[] an array of fkUUIDs of backing indexes. if FOREIGN_KEY, then just one element, the backing index of the referenced keys. if REFERENCED_KEY, then all the foreign keys fkUUIDs, long[] array of conglomerate numbers, corresponds to fkUUIDs fkConglomNumbers, boolean[] array of conglomerate booleans indicating whether the foreign key references a key in the same table fkIsSelfReferencing, int[] map of columns to the base row that DML is changing. 1 based. Note that this maps the constraint index to a row in the target table of the current DML operation. colArray, RowLocation a row location template for the target table used to pass in a template row to tc.openScan() rowLocation, int[] referential action rules raRules, boolean[] the corresponding constraint is deferrable deferrable, UUID[] the foreign key constraints' uuids. fkIds) Constructor for FKInfo

public

FKInfo()

Niladic constructor for Formattable

public

FKInfo(String[]

the foreign key constraint names

fkConstraintNames, String

the name of the schema of the table being modified

schemaName, String

the name of the table being modified

tableName, int

the type of the statement: e.g. StatementType.INSERT

stmtType, int

either FKInfo.REFERENCED_KEY or FKInfo.FOREIGN_KEY

type, UUID

UUID of the referenced constraint's supporting index

refUUID, long

conglomerate number of the referenced key

refConglomNumber, UUID

UUID of the referenced constraint

refConstraintID, boolean

true iff the referenced key constraint is deferrable

refConstraintIsDeferrable, UUID[]

an array of fkUUIDs of backing indexes. if FOREIGN_KEY, then just one element, the backing index of the referenced keys. if REFERENCED_KEY, then all the foreign keys

fkUUIDs, long[]

array of conglomerate numbers, corresponds to fkUUIDs

fkConglomNumbers, boolean[]

array of conglomerate booleans indicating whether the foreign key references a key in the same table

fkIsSelfReferencing, int[]

map of columns to the base row that DML is changing. 1 based. Note that this maps the constraint index to a row in the target table of the current DML operation.

colArray, RowLocation

a row location template for the target table used to pass in a template row to tc.openScan()

rowLocation, int[]

referential action rules

raRules, boolean[]

the corresponding constraint is deferrable

deferrable, UUID[]

the foreign key constraints' uuids.

fkIds)

Constructor for FKInfo

Method Summary

Modifier and Type	Method and Description
public static FKInfo[]	Returns: array of relevant fkinfos chooseRelevantFKInfos(FKInfo[] array of fkinfos fkInfo, int[] array of columns cols, boolean take all with type == FOREIGN_KEY addAllTypeIsFK) Comb through the FKInfo structures and pick out the ones that have columns that intersect with the input columns.
public int	Returns: the formatID of this class getTypeFormatId() Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId. Get the formatID which corresponds to this class.
public void	readExternal(ObjectInput read this. in) Implements java.io.Externalizable.readExternal. Read this object from a stream of stored objects.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	writeExternal(ObjectOutput write bytes here out) Implements java.io.Externalizable.writeExternal. Write this object out

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

Field Detail

colArray	back to summary
pack-priv int[] colArray

deferrable	back to summary
pack-priv boolean[] deferrable

fkConglomNumbers	back to summary
pack-priv long[] fkConglomNumbers

fkConstraintNames	back to summary
pack-priv String[] fkConstraintNames

fkIds	back to summary
pack-priv UUID[] fkIds

fkIsSelfReferencing	back to summary
pack-priv boolean[] fkIsSelfReferencing

fkUUIDs	back to summary
private UUID[] fkUUIDs

FOREIGN_KEY	back to summary
public static final int FOREIGN_KEY This class implements Formatable. That means that it can write itself to and from a formatted stream. If you add more fields to this class, make sure that you also write/read them with the writeExternal()/readExternal() methods. If, between releases, you add more fields to this class, then you should bump the version number emitted by the getTypeFormatId() method. OR, since this is something that is used in stored prepared statements, it is ok to change it if you make sure that stored prepared statements are invalidated across releases.

FOREIGN_KEY

back to summary

public static final int FOREIGN_KEY

This class implements Formatable. That means that it can write itself to and from a formatted stream. If you add more fields to this class, make sure that you also write/read them with the writeExternal()/readExternal() methods. If, between releases, you add more fields to this class, then you should bump the version number emitted by the getTypeFormatId() method. OR, since this is something that is used in stored prepared statements, it is ok to change it if you make sure that stored prepared statements are invalidated across releases.

raRules	back to summary
pack-priv int[] raRules

refConglomNumber	back to summary
pack-priv long refConglomNumber

refConstraintID	back to summary
pack-priv UUID refConstraintID

refConstraintIsDeferrable	back to summary
pack-priv boolean refConstraintIsDeferrable

REFERENCED_KEY	back to summary
public static final int REFERENCED_KEY

refUUID	back to summary
pack-priv UUID refUUID

rowLocation	back to summary
pack-priv RowLocation rowLocation

schemaName	back to summary
pack-priv String schemaName

stmtType	back to summary
pack-priv int stmtType

tableName	back to summary
pack-priv String tableName

type	back to summary
pack-priv int type

Constructor Detail

FKInfo	back to summary
public FKInfo() Niladic constructor for Formattable

FKInfo back to summary

FKInfo	back to summary
public FKInfo(String[] fkConstraintNames, String schemaName, String tableName, int stmtType, int type, UUID refUUID, long refConglomNumber, UUID refConstraintID, boolean refConstraintIsDeferrable, UUID[] fkUUIDs, long[] fkConglomNumbers, boolean[] fkIsSelfReferencing, int[] colArray, RowLocation rowLocation, int[] raRules, boolean[] deferrable, UUID[] fkIds) Constructor for FKInfo Parameters fkConstraintNames:String[] the foreign key constraint names schemaName:String the name of the schema of the table being modified tableName:String the name of the table being modified stmtType:int the type of the statement: e.g. StatementType.INSERT type:int either FKInfo.REFERENCED_KEY or FKInfo.FOREIGN_KEY refUUID:UUID UUID of the referenced constraint's supporting index refConglomNumber:long conglomerate number of the referenced key refConstraintID:UUID UUID of the referenced constraint refConstraintIsDeferrable:boolean `true` iff the referenced key constraint is deferrable fkUUIDs:UUID[] an array of fkUUIDs of backing indexes. if FOREIGN_KEY, then just one element, the backing index of the referenced keys. if REFERENCED_KEY, then all the foreign keys fkConglomNumbers:long[] array of conglomerate numbers, corresponds to fkUUIDs fkIsSelfReferencing:boolean[] array of conglomerate booleans indicating whether the foreign key references a key in the same table colArray:int[] map of columns to the base row that DML is changing. 1 based. Note that this maps the constraint index to a row in the target table of the current DML operation. rowLocation:RowLocation a row location template for the target table used to pass in a template row to tc.openScan() raRules:int[] referential action rules deferrable:boolean[] the corresponding constraint is deferrable fkIds:UUID[] the foreign key constraints' uuids.

public FKInfo(String[] fkConstraintNames, String schemaName, String tableName, int stmtType, int type, UUID refUUID, long refConglomNumber, UUID refConstraintID, boolean refConstraintIsDeferrable, UUID[] fkUUIDs, long[] fkConglomNumbers, boolean[] fkIsSelfReferencing, int[] colArray, RowLocation rowLocation, int[] raRules, boolean[] deferrable, UUID[] fkIds)

Constructor for FKInfo

Parameters

fkConstraintNames:String[]: the foreign key constraint names
schemaName:String: the name of the schema of the table being modified
tableName:String: the name of the table being modified
stmtType:int: the type of the statement: e.g. StatementType.INSERT
type:int: either FKInfo.REFERENCED_KEY or FKInfo.FOREIGN_KEY
refUUID:UUID: UUID of the referenced constraint's supporting index
refConglomNumber:long: conglomerate number of the referenced key
refConstraintID:UUID: UUID of the referenced constraint
refConstraintIsDeferrable:boolean: true iff the referenced key constraint is deferrable
fkUUIDs:UUID[]: an array of fkUUIDs of backing indexes. if FOREIGN_KEY, then just one element, the backing index of the referenced keys. if REFERENCED_KEY, then all the foreign keys
fkConglomNumbers:long[]: array of conglomerate numbers, corresponds to fkUUIDs
fkIsSelfReferencing:boolean[]: array of conglomerate booleans indicating whether the foreign key references a key in the same table
colArray:int[]: map of columns to the base row that DML is changing. 1 based. Note that this maps the constraint index to a row in the target table of the current DML operation.
rowLocation:RowLocation: a row location template for the target table used to pass in a template row to tc.openScan()
raRules:int[]: referential action rules
deferrable:boolean[]: the corresponding constraint is deferrable
fkIds:UUID[]: the foreign key constraints' uuids.

Method Detail

chooseRelevantFKInfos	back to summary
public static FKInfo[] chooseRelevantFKInfos(FKInfo[] fkInfo, int[] cols, boolean addAllTypeIsFK) Comb through the FKInfo structures and pick out the ones that have columns that intersect with the input columns. Parameters fkInfo:FKInfo[] array of fkinfos cols:int[] array of columns addAllTypeIsFK:boolean take all with type == FOREIGN_KEY Returns:FKInfo[] array of relevant fkinfos

chooseRelevantFKInfos

back to summary

public static FKInfo[] chooseRelevantFKInfos(FKInfo[] fkInfo, int[] cols, boolean addAllTypeIsFK)

Comb through the FKInfo structures and pick out the ones that have columns that intersect with the input columns.

Parameters

fkInfo:FKInfo[]: array of fkinfos
cols:int[]: array of columns
addAllTypeIsFK:boolean: take all with type == FOREIGN_KEY

Returns:FKInfo[]

array of relevant fkinfos

getTypeFormatId	back to summary
public int getTypeFormatId() Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId. Get the formatID which corresponds to this class. Returns:int the formatID of this class

getTypeFormatId

back to summary

public int getTypeFormatId()

Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId.

Get the formatID which corresponds to this class.

Returns:int: the formatID of this class

readExternal	back to summary
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException Implements java.io.Externalizable.readExternal. Read this object from a stream of stored objects. Parameters in:ObjectInput read this. Exceptions IOException: thrown on error ClassNotFoundException: thrown on error

readExternal

back to summary

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Implements java.io.Externalizable.readExternal.

Read this object from a stream of stored objects.

Parameters

in:ObjectInput: read this.

Exceptions

IOException:: thrown on error
ClassNotFoundException:: thrown on error

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. Returns:String a string representation of the object

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.

Returns:String: a string representation of the object

writeExternal	back to summary
public void writeExternal(ObjectOutput out) throws IOException Implements java.io.Externalizable.writeExternal. Write this object out Parameters out:ObjectOutput write bytes here Exceptions IOException: thrown on error

writeExternal

back to summary

public void writeExternal(ObjectOutput out) throws IOException

Implements java.io.Externalizable.writeExternal.

Write this object out

Parameters

out:ObjectOutput: write bytes here

Exceptions

IOException:: thrown on error

public Class FKInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail