Package com.exasol.dbbuilder.dialects

Class AbstractDatabaseObject

java.lang.Object

com.exasol.dbbuilder.dialects.AbstractDatabaseObject

All Implemented Interfaces:

DatabaseObject, AutoCloseable

Direct Known Subclasses:

AbstractSchema, AbstractSchemaChild, AbstractUser, ConnectionDefinition, VirtualSchema

public abstract class AbstractDatabaseObject
extends Object
implements DatabaseObject

Base class for database objects.

Database objects in integration tests are in most cases owned by the TDBJ. This means the TDBJ created them and is also responsible for cleaning them up.

On the other hand the TDBJ can also attach to objects that already exist in the database. In that case the TDBJ has a control object, but does not own the database object.

Field Summary

Fields

Modifier and Type	Field	Description
protected com.exasol.db.Identifier	name	Identifier
protected boolean	owned	Is this object owned?

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDatabaseObject(com.exasol.db.Identifier name, boolean owned)	Create a database object.

Method Summary

Modifier and Type	Method	Description
void	drop()	Remove this database object from database incl. all contained objects and mark it as deleted.
protected abstract void	dropInternally()	This is called by drop() to actually execute the DROP statement.
String	getFullyQualifiedName()	Get the name including the parent object names.
String	getName()	Get the name of the database object.
boolean	isOwned()	Check whether the script is a control object for a database object that already existed in the database.
protected void	markDeleted()	Mark this object as deleted.
protected void	verifyNotDeleted()	Checks if this object was deleted and throws an exception in case it was deleted.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.exasol.dbbuilder.dialects.DatabaseObject

close, getParent, getType, hasParent

Field Detail

owned

protected final boolean owned

Is this object owned?

name

protected com.exasol.db.Identifier name

Identifier

Constructor Detail

AbstractDatabaseObject

protected AbstractDatabaseObject(com.exasol.db.Identifier name,
                                 boolean owned)

Create a database object.

Parameters:

name - name of the database object

owned - true if the object is owned by the TDBJ, false if the TDBJ attached to a database object that already existed

Method Detail

getName

public String getName()

Description copied from interface: DatabaseObject

Get the name of the database object.

Specified by:

getName in interface DatabaseObject

Returns:

object name

getFullyQualifiedName

public String getFullyQualifiedName()

Description copied from interface: DatabaseObject

Get the name including the parent object names.

Specified by:

getFullyQualifiedName in interface DatabaseObject

Returns:

fully qualified name

drop

public void drop()

Description copied from interface: DatabaseObject

Remove this database object from database incl. all contained objects and mark it as deleted. Later operations on this object will throw a DatabaseObjectDeletedException Exception.

Specified by:

drop in interface DatabaseObject

markDeleted

protected void markDeleted()

Mark this object as deleted.

dropInternally

protected abstract void dropInternally()

This is called by drop() to actually execute the DROP statement.

verifyNotDeleted

protected void verifyNotDeleted()

Checks if this object was deleted and throws an exception in case it was deleted. This method must be called before each operation that assumes the object still exists in the database.

isOwned

public boolean isOwned()

Description copied from interface: DatabaseObject

Check whether the script is a control object for a database object that already existed in the database.

Specified by:

isOwned in interface DatabaseObject

Returns:

true if this is a control object attached to an existing database object