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

public Interface ConsInfo

extends Formatable
Known Direct Implementers
org.apache.derby.impl.sql.execute.ConstraintInfo
Imports
org.apache.derby.iapi.services.io.Formatable, org.apache.derby.shared.common.error.StandardException

This interface describes the columns in a referenced constraint. Added to be the protocol version of ConstraintInfo.
Version
0.1

Method Summary

Modifier and TypeMethod and Description
public String[]

Returns:

array of referenced column names
getReferencedColumnNames
()

This ConsInfo describes columns in a referenced table.

public TableDescriptor

Returns:

referenced table
getReferencedTableDescriptor
(DataDictionary
data dictionary to search for table
dd
)

This ConsInfo describes columns in a referenced table.

public String

Returns:

referenced table name
getReferencedTableName
()

Get the name of the table that these column live in.

public SchemaDescriptor

Returns:

schema that referenced table lives in
getReferencedTableSchemaDescriptor
(DataDictionary
data dictionary to search for schema
dd
)

This ConsInfo describes columns in a referenced table.

public int

Returns:

referential Action Delete rule
getReferentialActionDeleteRule
()

Get the referential Action for a Delete.

public int

Returns:

referential Action for update
getReferentialActionUpdateRule
()

Get the referential Action for an Update.

Method Detail

getReferencedColumnNamesback to summary
public String[] getReferencedColumnNames()

This ConsInfo describes columns in a referenced table. What are their names?

Returns:String[]

array of referenced column names

getReferencedTableDescriptorback to summary
public TableDescriptor getReferencedTableDescriptor(DataDictionary dd) throws StandardException

This ConsInfo describes columns in a referenced table. What is that table?

Parameters
dd:DataDictionary

data dictionary to search for table

Returns:TableDescriptor

referenced table

Exceptions
StandardException:
thrown on oops
getReferencedTableNameback to summary
public String getReferencedTableName()

Get the name of the table that these column live in.

Returns:String

referenced table name

getReferencedTableSchemaDescriptorback to summary
public SchemaDescriptor getReferencedTableSchemaDescriptor(DataDictionary dd) throws StandardException

This ConsInfo describes columns in a referenced table. What is the schema that the referenced table lives in?

Parameters
dd:DataDictionary

data dictionary to search for schema

Returns:SchemaDescriptor

schema that referenced table lives in

Exceptions
StandardException:
thrown on oops
getReferentialActionDeleteRuleback to summary
public int getReferentialActionDeleteRule()

Get the referential Action for a Delete.

Returns:int

referential Action Delete rule

getReferentialActionUpdateRuleback to summary
public int getReferentialActionUpdateRule()

Get the referential Action for an Update.

Returns:int

referential Action for update