Top Description Fields Constructors Methods
org.apache.derby.iapi.sql.dictionary

public Class SubKeyConstraintDescriptor

extends SubConstraintDescriptor
Class Inheritance
Imports
org.apache.derby.catalog.UUID, org.apache.derby.shared.common.sanity.SanityManager
This interface is used to get information from a SubKeyConstraintDescriptor. A SubKeyConstraintDescriptor is used within the DataDictionary to get auxiliary constraint information from the system table that is auxiliary to sysconstraints.
Version
0.1

Field Summary

Modifier and TypeField and Description
pack-priv UUID
indexId

Interface for SubKeyConstraintDescriptor is

  1. public UUID getIndexId();
  2. public UUID getKeyConstraintId();
pack-priv UUID
keyConstraintId

pack-priv int
raDeleteRule

pack-priv int
raUpdateRule

Inherited from org.apache.derby.iapi.sql.dictionary.SubConstraintDescriptor:
constraintIdtd

Constructor Summary

AccessConstructor and Description
public
SubKeyConstraintDescriptor(UUID
The UUID of the constraint.
constraintId, UUID
The UUID of the backing index.
indexId)

Constructor for a SubConstraintDescriptorImpl

public
SubKeyConstraintDescriptor(UUID
The UUID of the constraint.
constraintId, UUID
The UUID of the backing index.
indexId, UUID
The UUID of the referenced constraint (fks)
keyConstraintId)

Constructor for a SubConstraintDescriptor

public
SubKeyConstraintDescriptor(UUID
The UUID of the constraint.
constraintId, UUID
The UUID of the backing index.
indexId, UUID
The UUID of the referenced constraint (fks)
keyConstraintId, int
The referential action for delete
raDeleteRule, int
The referential action for update
raUpdateRule)

Constructor for a SubConstraintDescriptor

Method Summary

Modifier and TypeMethod and Description
public UUID

Returns:

The UUID of the backing index.
getIndexId()

Gets the UUID of the backing index.

public UUID

Returns:

The UUID of the referenced key constraint
getKeyConstraintId()

Gets the UUID of the referenced key constraint

public int

Returns:

referential rule defined by the user during foreign key creattion for a delete (like CASCDE , RESTRICT ..etc)
getRaDeleteRule()

Gets a referential action rule on a DELETE

public int

Returns:

referential rule defined by the user during foreign key creattion for an UPDATE (like CASCDE , RESTRICT ..etc)
getRaUpdateRule()

Gets a referential action rule on a UPDATE

public boolean

Returns:

boolean Whether or not there is a backing index for this constraint.
hasBackingIndex()

Implements abstract org.apache.derby.iapi.sql.dictionary.SubConstraintDescriptor.hasBackingIndex.

Does this constraint have a backing index?

public String

Returns:

A String representation of this SubConstraintDescriptor
toString()

Overrides org.apache.derby.iapi.sql.dictionary.SubConstraintDescriptor.toString.

Convert the SubKeyConstraintDescriptor to a String.

Inherited from org.apache.derby.iapi.sql.dictionary.SubConstraintDescriptor:
getTableDescriptorgetUUIDsetConstraintIdsetTableDescriptor

Field Detail

indexIdback to summary
pack-priv UUID indexId

Interface for SubKeyConstraintDescriptor is

  1. public UUID getIndexId();
  2. public UUID getKeyConstraintId();
keyConstraintIdback to summary
pack-priv UUID keyConstraintId
raDeleteRuleback to summary
pack-priv int raDeleteRule
raUpdateRuleback to summary
pack-priv int raUpdateRule

Constructor Detail

SubKeyConstraintDescriptorback to summary
public SubKeyConstraintDescriptor(UUID constraintId, UUID indexId)

Constructor for a SubConstraintDescriptorImpl

Parameters
constraintId:UUID

The UUID of the constraint.

indexId:UUID

The UUID of the backing index.

SubKeyConstraintDescriptorback to summary
public SubKeyConstraintDescriptor(UUID constraintId, UUID indexId, UUID keyConstraintId)

Constructor for a SubConstraintDescriptor

Parameters
constraintId:UUID

The UUID of the constraint.

indexId:UUID

The UUID of the backing index.

keyConstraintId:UUID

The UUID of the referenced constraint (fks)

SubKeyConstraintDescriptorback to summary
public SubKeyConstraintDescriptor(UUID constraintId, UUID indexId, UUID keyConstraintId, int raDeleteRule, int raUpdateRule)

Constructor for a SubConstraintDescriptor

Parameters
constraintId:UUID

The UUID of the constraint.

indexId:UUID

The UUID of the backing index.

keyConstraintId:UUID

The UUID of the referenced constraint (fks)

raDeleteRule:int

The referential action for delete

raUpdateRule:int

The referential action for update

Method Detail

getIndexIdback to summary
public UUID getIndexId()

Gets the UUID of the backing index.

Returns:UUID

The UUID of the backing index.

getKeyConstraintIdback to summary
public UUID getKeyConstraintId()

Gets the UUID of the referenced key constraint

Returns:UUID

The UUID of the referenced key constraint

getRaDeleteRuleback to summary
public int getRaDeleteRule()

Gets a referential action rule on a DELETE

Returns:int

referential rule defined by the user during foreign key creattion for a delete (like CASCDE , RESTRICT ..etc)

getRaUpdateRuleback to summary
public int getRaUpdateRule()

Gets a referential action rule on a UPDATE

Returns:int

referential rule defined by the user during foreign key creattion for an UPDATE (like CASCDE , RESTRICT ..etc)

hasBackingIndexback to summary
public boolean hasBackingIndex()

Implements abstract org.apache.derby.iapi.sql.dictionary.SubConstraintDescriptor.hasBackingIndex.

Does this constraint have a backing index?

Returns:boolean

boolean Whether or not there is a backing index for this constraint.

toStringback to summary
public String toString()

Overrides org.apache.derby.iapi.sql.dictionary.SubConstraintDescriptor.toString.

Convert the SubKeyConstraintDescriptor to a String.

Returns:String

A String representation of this SubConstraintDescriptor