Package liquibase.structure

Class AbstractDatabaseObject

java.lang.Object

liquibase.structure.AbstractDatabaseObject

All Implemented Interfaces:

Comparable, LiquibaseSerializable, DatabaseObject

Direct Known Subclasses:

Catalog, Column, Data, ForeignKey, Index, PrimaryKey, Relation, Schema, Sequence, StoredDatabaseLogic, UniqueConstraint

public abstract class AbstractDatabaseObject
extends Object
implements DatabaseObject

Template class for all types of database objects can be manipulated using ChangeSets. Objects represented by subclasses are not specific to any RDBMS and thus only contain "high-level" properties that can be found in most DBMS. Examples for things that are represented are Table, PrimaryKey and Column.

Core features of this class include the functionality for the attributes collection ( getAttributes() } and the ability to load an object from a serialised form load(ParsedNode, ResourceAccessor) .

Nested Class Summary

Nested classes/interfaces inherited from interface liquibase.serializer.LiquibaseSerializable

LiquibaseSerializable.SerializationType

Field Summary

Fields

Modifier and Type	Field	Description
static Pattern	CURLY_BRACKET_PATTERN

Fields inherited from interface liquibase.serializer.LiquibaseSerializable

GENERIC_CHANGELOG_EXTENSION_NAMESPACE, GENERIC_SNAPSHOT_EXTENSION_NAMESPACE, STANDARD_CHANGELOG_NAMESPACE, STANDARD_SNAPSHOT_NAMESPACE

Constructor Summary

Constructors

Constructor	Description
AbstractDatabaseObject()

Method Summary

Modifier and Type	Method	Description
int	compareTo(Object o)
<T> T	getAttribute(String attribute, Class<T> type)	Retrieves the value of a DatabaseObject's attributes and cast it into the desired type.
<T> T	getAttribute(String attribute, T defaultValue)	Retrieves the value of a DatabaseObject's attributes and cast it into the desired type.
Set<String>	getAttributes()	Returns the name of all attributes currently stored for this DatabaseObject.
String	getObjectTypeName()
String	getSerializableFieldNamespace(String field)
Set<String>	getSerializableFields()
LiquibaseSerializable.SerializationType	getSerializableFieldType(String field)
Object	getSerializableFieldValue(String field)
String	getSerializedObjectName()
String	getSerializedObjectNamespace()
String	getSnapshotId()
void	load(ParsedNode parsedNode, ResourceAccessor resourceAccessor)
ParsedNode	serialize()
DatabaseObject	setAttribute(String attribute, Object value)	Sets a given attribute for this object to the specified value.
void	setSnapshotId(String snapshotId)
boolean	shouldIncludeCatalogInSpecification()	Returns a boolean value indicating whether the object types should include the catalog name in their specification.
boolean	snapshotByDefault()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface liquibase.structure.DatabaseObject

getContainingObjects, getName, getSchema, setName

Field Detail

CURLY_BRACKET_PATTERN

public static final Pattern CURLY_BRACKET_PATTERN

Constructor Detail

AbstractDatabaseObject

public AbstractDatabaseObject()

Method Detail

getObjectTypeName

public String getObjectTypeName()

Specified by:

getObjectTypeName in interface DatabaseObject

getSnapshotId

public String getSnapshotId()

Specified by:

getSnapshotId in interface DatabaseObject

setSnapshotId

public void setSnapshotId(String snapshotId)

Specified by:

setSnapshotId in interface DatabaseObject

snapshotByDefault

public boolean snapshotByDefault()

Specified by:

snapshotByDefault in interface DatabaseObject

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

getAttributes

public Set<String> getAttributes()

Description copied from interface: DatabaseObject

Returns the name of all attributes currently stored for this DatabaseObject.

Specified by:

getAttributes in interface DatabaseObject

Returns:

the Set of all attribute names

getAttribute

public <T> T getAttribute(String attribute,
                          Class<T> type)

Description copied from interface: DatabaseObject

Retrieves the value of a DatabaseObject's attributes and cast it into the desired type.

Specified by:

getAttribute in interface DatabaseObject

Type Parameters:

T - the desired type of the value

Parameters:

attribute - case-sensitive name of the attribute for which the value will be retrieved

type - class compatible with the desired type T of the return value

Returns:

• if the attribute name exists, and the current value can be cast into the desired class, then the value is returned in the desired form. Note that null is a valid value, too.
• if the attribute name does not exist, null is returned.
• if the attribute has a value, but that value cannot be cast into the desired class, a RuntimeException will occur.

getAttribute

public <T> T getAttribute(String attribute,
                          T defaultValue)

Description copied from interface: DatabaseObject

Retrieves the value of a DatabaseObject's attributes and cast it into the desired type.

Specified by:

getAttribute in interface DatabaseObject

Type Parameters:

T - the desired type of the value

Parameters:

attribute - case-sensitive name of the attribute for which the value will be retrieved

defaultValue - the value to be returned if no value (not even null) is stored for the attribute name in the object.

Returns:

• if the attribute name exists, and the current value can be cast into a type compatible with T, then value is returned in the desired form. Note that null is a valid value, too.
• if the attribute name does not exist, defaultValue is returned.
• if the attribute has a value, but that value cannot be cast into a type compatible with T, a RuntimeException will occur.

setAttribute

public DatabaseObject setAttribute(String attribute,
                                   Object value)

Description copied from interface: DatabaseObject

Sets a given attribute for this object to the specified value.

Specified by:

setAttribute in interface DatabaseObject

Parameters:

attribute - case-sensitive name of the attribute

value - value to be set

Returns:

a reference to the same object

getSerializedObjectName

public String getSerializedObjectName()

Specified by:

getSerializedObjectName in interface LiquibaseSerializable

getSerializedObjectNamespace

public String getSerializedObjectNamespace()

Specified by:

getSerializedObjectNamespace in interface LiquibaseSerializable

getSerializableFieldNamespace

public String getSerializableFieldNamespace(String field)

Specified by:

getSerializableFieldNamespace in interface LiquibaseSerializable

getSerializableFields

public Set<String> getSerializableFields()

Specified by:

getSerializableFields in interface LiquibaseSerializable

getSerializableFieldValue

public Object getSerializableFieldValue(String field)

Specified by:

getSerializableFieldValue in interface LiquibaseSerializable

getSerializableFieldType

public LiquibaseSerializable.SerializationType getSerializableFieldType(String field)

Specified by:

getSerializableFieldType in interface LiquibaseSerializable

load

public void load(ParsedNode parsedNode,
                 ResourceAccessor resourceAccessor)
          throws ParsedNodeException

Specified by:

load in interface LiquibaseSerializable

Throws:

ParsedNodeException

serialize

public ParsedNode serialize()

Specified by:

serialize in interface LiquibaseSerializable

toString

public String toString()

Overrides:

toString in class Object

shouldIncludeCatalogInSpecification

public boolean shouldIncludeCatalogInSpecification()

Returns a boolean value indicating whether the object types should include the catalog name in their specification. This method checks the current value of the INCLUDE_CATALOG_IN_SPECIFICATION setting in the GlobalConfiguration.

Returns:

true if the object types should include the catalog name in their specification, otherwise false.