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

All Superinterfaces:

CoreMetaData, Serializable

All Known Implementing Classes:

BestRowIdentifierBean

public interface BestRowIdentifier
extends CoreMetaData

Provides table's best row identifies specific metadata.

Author:

Sergiy Litsenko

Method Summary

void	addColumn(Column column) Adds column to the best row identifier
void	deleteColumn(Column column) Deletes column from the best row identifier
Column	findColumnByName(String columnName) Searches column by name
Set<Column>	getColumns() Retrieves best row identifier columns
BestRowIdentifierScopeType	getScopeType() Return the scope of best row identifier
void	setScopeType(BestRowIdentifierScopeType scopeType) Sets the scope of best row identifier

Method Detail

getScopeType

BestRowIdentifierScopeType getScopeType()

Return the scope of best row identifier

Returns:

the scope of best row identifier

setScopeType

void setScopeType(BestRowIdentifierScopeType scopeType)

Sets the scope of best row identifier

Parameters:

scopeType - the scope of best row identifier

getColumns

Set<Column> getColumns()

Retrieves best row identifier columns

Returns:

best row identifier columns

addColumn

void addColumn(Column column)

Adds column to the best row identifier

Parameters:

column - the column that part of best row identifier

deleteColumn

void deleteColumn(Column column)

Deletes column from the best row identifier

Parameters:

column - the column that no longer part of best row identifier

findColumnByName

Column findColumnByName(String columnName)

Searches column by name

Parameters:

columnName - the column name to search

Returns:

column if found, otherwise return null