org.apache.derby.iapi.sql.dictionary
Interface ConsInfo

All Superinterfaces:

java.io.Externalizable, Formatable, java.io.Serializable, TypedFormat

All Known Implementing Classes:

ConstraintInfo

public interface ConsInfo

extends Formatable

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

Version:

0.1

Author:

Rick Hillegas

Method Summary

java.lang.String[]	getReferencedColumnNames() This ConsInfo describes columns in a referenced table.
TableDescriptor	getReferencedTableDescriptor(DataDictionary dd) This ConsInfo describes columns in a referenced table.
java.lang.String	getReferencedTableName() Get the name of the table that these column live in.
SchemaDescriptor	getReferencedTableSchemaDescriptor(DataDictionary dd) This ConsInfo describes columns in a referenced table.
int	getReferentialActionDeleteRule() Get the referential Action for a Delete.
int	getReferentialActionUpdateRule() Get the referential Action for an Update.

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Methods inherited from interface org.apache.derby.iapi.services.io.TypedFormat

getTypeFormatId

Method Detail

getReferencedTableSchemaDescriptor

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 - data dictionary to search for schema

Returns:

schema that referenced table lives in

Throws:

StandardException - thrown on oops

getReferencedTableDescriptor

public TableDescriptor getReferencedTableDescriptor(DataDictionary dd)
                                             throws StandardException

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

Parameters:

dd - data dictionary to search for table

Returns:

referenced table

Throws:

StandardException - thrown on oops

getReferencedColumnNames

public java.lang.String[] getReferencedColumnNames()

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

Returns:

array of referenced column names

getReferencedTableName

public java.lang.String getReferencedTableName()

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

Returns:

referenced table name

getReferentialActionUpdateRule

public int getReferentialActionUpdateRule()

Get the referential Action for an Update.

Returns:

referential Action for update

getReferentialActionDeleteRule

public int getReferentialActionDeleteRule()

Get the referential Action for a Delete.

Returns:

referential Action Delete rule