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

All Superinterfaces:

CoreMetaData, Serializable

All Known Subinterfaces:

Attribute, Catalog, Column, ForeignKey, ForeignKeyColumn, Index, IndexColumn, KeyColumn, Parameter, PrimaryKey, PrimaryKeyColumn, Schema, SchemaObject, SqlTypeInfo, StoredProcedure, Table, TableColumn, TableType, UserDefinedType

All Known Implementing Classes:

AttributeBean, CatalogBean, ColumnBean, DatabaseNamedObjectBean, ForeignKeyBean, ForeignKeyColumnBean, IndexBean, IndexColumnBean, KeyColumnBean, ParameterBean, PrimaryKeyBean, PrimaryKeyColumnBean, SchemaBean, SchemaObjectBean, SqlTypeInfoBean, StoredProcedureBean, TableBean, TableColumnBean, TableTypeBean, UserDefinedTypeBean

public interface DatabaseNamedObject
extends CoreMetaData

Provides database named object specific metadata.

Author:

Sergiy Litsenko

Method Summary

void	addExtraProperty(String key, Object value) Adds extra property
void	deleteExtraProperty(String key) deletes extra property
Map<String,Object>	getExtraProperties() Gets extra (non standard) properties if provided by database.
Object	getExtraProperty(String key) Gets extra (non standard) property if provided by database.
String	getName() Gets database named object name
String	getRemarks() Gets explanatory comment on the database named object
void	setName(String name) Sets database named object name
void	setRemarks(String remarks) Sets explanatory comment on the database named object

Method Detail

getName

String getName()

Gets database named object name

Returns:

database named object name

setName

void setName(String name)

Sets database named object name

Parameters:

name - the database named object name

getRemarks

String getRemarks()

Gets explanatory comment on the database named object

Returns:

explanatory comment on the database named object

setRemarks

void setRemarks(String remarks)

Sets explanatory comment on the database named object

Parameters:

remarks - the explanatory comment on the database named object

getExtraProperties

Map<String,Object> getExtraProperties()

Gets extra (non standard) properties if provided by database.

Returns:

extra properties if provided by database

getExtraProperty

Object getExtraProperty(String key)

Gets extra (non standard) property if provided by database.

Parameters:

key - the key

Returns:

extra property if provided by database

addExtraProperty

void addExtraProperty(String key,
                      Object value)

Adds extra property

Parameters:

key - the key

value - the value

deleteExtraProperty

void deleteExtraProperty(String key)

deletes extra property

Parameters:

key - the key