Package com.ibm.fhir.database.utils.model

Class CreateIndex

java.lang.Object

com.ibm.fhir.database.utils.model.BaseObject

com.ibm.fhir.database.utils.model.CreateIndex

All Implemented Interfaces:

IDatabaseObject

public class CreateIndex
extends BaseObject

Index creation definition for creating new indexes after the table has been defined (e.g. in a subsequent version)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateIndex.Builder	Builder to implement fluent construction of CreateIndex objects.

Field Summary

Fields inherited from class com.ibm.fhir.database.utils.model.BaseObject

migrations, version

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CreateIndex(String schemaName, String versionTrackingName, String tableName, int version, IndexDef indexDef, String tenantColumnName)	Protected constructor.

Method Summary

Modifier and Type	Method	Description
void	apply(IDatabaseAdapter target)	Apply the DDL for this object to the target database
void	apply(Integer priorVersion, IDatabaseAdapter target)	Apply migration logic to bring the target database to the current level of this object
static CreateIndex.Builder	builder()	Return a new Builder instance for creating instances of CreateIndex
CreateIndexStatement	createStatement()	Build a CreateIndexStatement from this CreateIndex object
void	drop(IDatabaseAdapter target)	DROP this object from the target database
String	getTableName()	Get the name of the table this index is built on
String	getTypeNameVersion()	Get the qualified name for this object: objectType:objectName:objectVersion
void	visit(DataModelVisitor v)	Visit this IDatabaseObject with the given DataModelVisitor.
void	visitReverse(DataModelVisitor v)	Visit this IDatabaseObject with the given DataModelVisitor.

Methods inherited from class com.ibm.fhir.database.utils.model.BaseObject

addDependencies, addDependency, addPrivilege, addTag, addTags, applyTx, applyVersion, collect, equals, fetchDependenciesTo, getName, getObjectName, getObjectType, getQualifiedName, getSchemaName, getTags, getVersion, grant, grantGroupPrivileges, hashCode, safeSleep, toString, visit

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateIndex

protected CreateIndex(String schemaName,
                      String versionTrackingName,
                      String tableName,
                      int version,
                      IndexDef indexDef,
                      String tenantColumnName)

Protected constructor. Use the Builder to create instance.

Parameters:

schemaName -

indexName -

version -

Method Detail

builder

public static CreateIndex.Builder builder()

Return a new Builder instance for creating instances of CreateIndex

Returns:

createStatement

public CreateIndexStatement createStatement()

Build a CreateIndexStatement from this CreateIndex object

Returns:

getTableName

public String getTableName()

Get the name of the table this index is built on

Returns:

getTypeNameVersion

public String getTypeNameVersion()

Description copied from interface: IDatabaseObject

Get the qualified name for this object: objectType:objectName:objectVersion

Specified by:

getTypeNameVersion in interface IDatabaseObject

Overrides:

getTypeNameVersion in class BaseObject

Returns:

apply

public void apply(IDatabaseAdapter target)

Description copied from interface: IDatabaseObject

Apply the DDL for this object to the target database

Parameters:

target - the database target

apply

public void apply(Integer priorVersion,
                  IDatabaseAdapter target)

Description copied from interface: IDatabaseObject

Apply migration logic to bring the target database to the current level of this object

target - the database target

drop

public void drop(IDatabaseAdapter target)

Description copied from interface: IDatabaseObject

DROP this object from the target database

visit

public void visit(DataModelVisitor v)

Description copied from interface: IDatabaseObject

Visit this IDatabaseObject with the given DataModelVisitor. Any sub-objects should be visited in creation order.

visitReverse

public void visitReverse(DataModelVisitor v)

Description copied from interface: IDatabaseObject

Visit this IDatabaseObject with the given DataModelVisitor. Any sub-objects should be visited in reverse order.