Package liquibase.structure.core

Class Index

java.lang.Object

liquibase.structure.AbstractDatabaseObject

liquibase.structure.core.Index

All Implemented Interfaces:

Comparable, LiquibaseSerializable, DatabaseObject

public class Index
extends AbstractDatabaseObject

Nested Class Summary

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

LiquibaseSerializable.SerializationType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MARK_FOREIGN_KEY	Marks Index as associated with Foreign Key [FK]
static final String	MARK_PRIMARY_KEY	Marks Index as associated with Primary Key [PK]
static final String	MARK_UNIQUE_CONSTRAINT	Marks Index as associated with Unique Constraint [UC]

Fields inherited from class liquibase.structure.AbstractDatabaseObject

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
Index()
Index(String indexName)
Index(String indexName, String catalogName, String schemaName, String tableName, Column... columns)

Method Summary

Modifier and Type	Method	Description
void	addAssociatedWith(String item)
Index	addColumn(Column column)
int	compareTo(Object other)
boolean	equals(Object obj)
Set<String>	getAssociatedWith()
String	getAssociatedWithAsString()
Boolean	getClustered()
String	getColumnNames()
List<Column>	getColumns()
DatabaseObject[]	getContainingObjects()
List<String>	getIncludedColumns()
String	getName()
Relation	getRelation()
Schema	getSchema()
Object	getSerializableFieldValue(String field)
Table	getTable()	Deprecated. Use getRelation()
String	getTablespace()
int	hashCode()
boolean	isAssociatedWith(String keyword)
Boolean	isUnique()
void	load(ParsedNode parsedNode, ResourceAccessor resourceAccessor)
Index	setClustered(Boolean clustered)
Index	setColumns(List<Column> columns)
Index	setName(String name)	Sets the name for the database object.
Index	setRelation(Relation relation)
Index	setTable(Relation table)	Deprecated. Use setRelation(Relation)
Index	setTablespace(String tablespace)
Index	setUnique(Boolean value)
String	toString()	(Try to) provide a human-readable name for the index.

Methods inherited from class liquibase.structure.AbstractDatabaseObject

getAttribute, getAttribute, getAttributes, getObjectTypeName, getSerializableFieldNamespace, getSerializableFields, getSerializableFieldType, getSerializedObjectName, getSerializedObjectNamespace, getSnapshotId, serialize, setAttribute, setSnapshotId, shouldIncludeCatalogInSpecification, snapshotByDefault

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

MARK_PRIMARY_KEY

public static final String MARK_PRIMARY_KEY

Marks Index as associated with Primary Key [PK]

See Also:

• Constant Field Values

MARK_FOREIGN_KEY

public static final String MARK_FOREIGN_KEY

Marks Index as associated with Foreign Key [FK]

See Also:

• Constant Field Values

MARK_UNIQUE_CONSTRAINT

public static final String MARK_UNIQUE_CONSTRAINT

Marks Index as associated with Unique Constraint [UC]

See Also:

• Constant Field Values

Constructor Details

Index

public Index()

Index

public Index(String indexName)

Index

public Index(String indexName,
 String catalogName,
 String schemaName,
 String tableName,
 Column... columns)

Method Details

getContainingObjects

public DatabaseObject[] getContainingObjects()

getName

public String getName()

setName

public Index setName(String name)

Description copied from interface: DatabaseObject

Sets the name for the database object.

Parameters:

name - the new name for the database object

Returns:

a reference to the same object (implementing classes are expected to return a reference to the same object).

getSchema

public Schema getSchema()

getTable

@Deprecated
public Table getTable()

Deprecated.

Use getRelation()

setTable

@Deprecated
public Index setTable(Relation table)

Deprecated.

Use setRelation(Relation)

getRelation

public Relation getRelation()

setRelation

public Index setRelation(Relation relation)

getTablespace

public String getTablespace()

setTablespace

public Index setTablespace(String tablespace)

getColumns

public List<Column> getColumns()

getIncludedColumns

public List<String> getIncludedColumns()

addColumn

public Index addColumn(Column column)

setColumns

public Index setColumns(List<Column> columns)

getColumnNames

public String getColumnNames()

setUnique

public Index setUnique(Boolean value)

isUnique

public Boolean isUnique()

getAssociatedWith

public Set<String> getAssociatedWith()

getAssociatedWithAsString

public String getAssociatedWithAsString()

addAssociatedWith

public void addAssociatedWith(String item)

isAssociatedWith

public boolean isAssociatedWith(String keyword)

getSerializableFieldValue

public Object getSerializableFieldValue(String field)

Specified by:

getSerializableFieldValue in interface LiquibaseSerializable

Overrides:

getSerializableFieldValue in class AbstractDatabaseObject

load

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

Specified by:

load in interface LiquibaseSerializable

Overrides:

load in class AbstractDatabaseObject

Throws:

ParsedNodeException

getClustered

public Boolean getClustered()

setClustered

public Index setClustered(Boolean clustered)

compareTo

public int compareTo(Object other)

Specified by:

compareTo in interface Comparable

Overrides:

compareTo in class AbstractDatabaseObject

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

(Try to) provide a human-readable name for the index.

Overrides:

toString in class AbstractDatabaseObject

Returns:

A (hopefully) human-readable name