org.jboss.dna.common.jdbc.model.api
Interface PrimaryKey

All Superinterfaces:

CoreMetaData, DatabaseNamedObject, SchemaObject, Serializable

All Known Implementing Classes:

PrimaryKeyBean

public interface PrimaryKey
extends SchemaObject

Provides database table's primary key specific metadata.

Author:

Sergiy Litsenko

Method Summary

void	addColumn(PrimaryKeyColumn primaryKeyColumn) Adds PrimaryKeyColumn
void	deleteColumn(PrimaryKeyColumn primaryKeyColumn) deletes PrimaryKeyColumn
PrimaryKeyColumn	findColumnByName(String columnName) Returns table column for specified column name or null
Set<PrimaryKeyColumn>	getColumns() Retrieves primary key columns

Methods inherited from interface org.jboss.dna.common.jdbc.model.api.SchemaObject

getCatalog, getSchema, setCatalog, setSchema

Methods inherited from interface org.jboss.dna.common.jdbc.model.api.DatabaseNamedObject

addExtraProperty, deleteExtraProperty, getExtraProperties, getExtraProperty, getName, getRemarks, setName, setRemarks

Method Detail

getColumns

Set<PrimaryKeyColumn> getColumns()

Retrieves primary key columns

Returns:

primary key columns

addColumn

void addColumn(PrimaryKeyColumn primaryKeyColumn)

Adds PrimaryKeyColumn

Parameters:

primaryKeyColumn - the PrimaryKeyColumn

deleteColumn

void deleteColumn(PrimaryKeyColumn primaryKeyColumn)

deletes PrimaryKeyColumn

Parameters:

primaryKeyColumn - the PrimaryKeyColumn

findColumnByName

PrimaryKeyColumn findColumnByName(String columnName)

Returns table column for specified column name or null

Parameters:

columnName - the name of column

Returns:

table column for specified column name or null.