it.unibz.inf.ontop.dbschema

Class DatabaseRelationDefinition

java.lang.Object

it.unibz.inf.ontop.dbschema.RelationDefinition

it.unibz.inf.ontop.dbschema.DatabaseRelationDefinition

public class DatabaseRelationDefinition
extends RelationDefinition

Represents a database relation (either a table or a view)

Author:

Roman Kontchakov

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DatabaseRelationDefinition(RelationID name) used only in DBMetadata

Method Summary

Modifier and Type	Method and Description
Attribute	addAttribute(QuotedID id, String typeName, DBTermType termType, boolean canNull) creates a new attribute
void	addForeignKeyConstraint(ForeignKeyConstraint fk) adds a foreign key constraints
void	addFunctionalDependency(FunctionalDependency constraint)
void	addUniqueConstraint(UniqueConstraint uc) adds a unique constraint (a primary key or a unique constraint proper)
Attribute	getAttribute(int index) gets attribute with the specified position
Attribute	getAttribute(QuotedID attributeId) return an attribute with the specified ID
List<Attribute>	getAttributes() returns the list of attributes
com.google.common.collect.ImmutableList<ForeignKeyConstraint>	getForeignKeys() returns the list of foreign key constraints
com.google.common.collect.ImmutableList<FunctionalDependency>	getOtherFunctionalDependencies()
UniqueConstraint	getPrimaryKey() return primary key (if present) or null (otherwise)
com.google.common.collect.ImmutableList<UniqueConstraint>	getUniqueConstraints() returns the list of unique constraints (including the primary key if present)
String	toString()

Methods inherited from class it.unibz.inf.ontop.dbschema.RelationDefinition

getAtomPredicate, getID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DatabaseRelationDefinition

protected DatabaseRelationDefinition(RelationID name)

used only in DBMetadata

Parameters:

name -

Method Detail

addAttribute

public Attribute addAttribute(QuotedID id,
                              String typeName,
                              DBTermType termType,
                              boolean canNull)

creates a new attribute

Parameters:

id -

typeName -

termType -

canNull -

getAttribute

public Attribute getAttribute(QuotedID attributeId)

return an attribute with the specified ID

Parameters:

attributeId -

Returns:

getAttribute

public Attribute getAttribute(int index)

gets attribute with the specified position

Specified by:

getAttribute in class RelationDefinition

Parameters:

index - is position starting at 1

Returns:

attribute at the position

getAttributes

public List<Attribute> getAttributes()

returns the list of attributes

Specified by:

getAttributes in class RelationDefinition

Returns:

list of attributes

addUniqueConstraint

public void addUniqueConstraint(UniqueConstraint uc)

adds a unique constraint (a primary key or a unique constraint proper)

Parameters:

uc -

getUniqueConstraints

public com.google.common.collect.ImmutableList<UniqueConstraint> getUniqueConstraints()

returns the list of unique constraints (including the primary key if present)

Specified by:

getUniqueConstraints in class RelationDefinition

Returns:

addFunctionalDependency

public void addFunctionalDependency(FunctionalDependency constraint)

getOtherFunctionalDependencies

public com.google.common.collect.ImmutableList<FunctionalDependency> getOtherFunctionalDependencies()

Specified by:

getOtherFunctionalDependencies in class RelationDefinition

getPrimaryKey

public UniqueConstraint getPrimaryKey()

return primary key (if present) or null (otherwise)

Specified by:

getPrimaryKey in class RelationDefinition

Returns:

addForeignKeyConstraint

public void addForeignKeyConstraint(ForeignKeyConstraint fk)

adds a foreign key constraints

Parameters:

fk - a foreign key

getForeignKeys

public com.google.common.collect.ImmutableList<ForeignKeyConstraint> getForeignKeys()

returns the list of foreign key constraints

Specified by:

getForeignKeys in class RelationDefinition

Returns:

list of foreign keys

toString

public String toString()

Overrides:

toString in class Object