Package org.eclipse.persistence.tools.schemaframework

Class IndexDefinition

java.lang.Object

org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

org.eclipse.persistence.tools.schemaframework.IndexDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class IndexDefinition
extends DatabaseObjectDefinition

Purpose: Allow for indexes to be created.

Since:

EclipseLink 2.2

Author:

James Sutherland

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	fields
protected boolean	isUnique
protected String	targetTable

Fields inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

name, qualifier

Constructor Summary

Constructors

Constructor	Description
IndexDefinition()

Method Summary

Modifier and Type	Method	Description
void	addField(String fieldName)	PUBLIC: Add the field to the index.
Writer	buildCreationWriter(AbstractSession session, Writer writer)	INTERNAL: Return the create type statement.
Writer	buildDeletionWriter(AbstractSession session, Writer writer)	INTERNAL: Return the drop type statement.
List<String>	getFields()
String	getTargetTable()
boolean	isUnique()
void	setFields(List<String> fields)
void	setIsUnique(boolean isUnique)
void	setTargetTable(String targetTable)	PUBLIC: set qualified table name.

Methods inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

buildVPDCreationFunctionWriter, buildVPDCreationPolicyWriter, buildVPDDeletionWriter, clone, createDatabaseSchema, createDatabaseSchemaOnDatabase, createObject, createOnDatabase, dropDatabaseSchema, dropDatabaseSchemaOnDatabase, dropFromDatabase, dropObject, getDatabaseSchema, getFieldTypeDefinition, getFieldTypeDefinition, getFullName, getName, getQualifier, hasDatabaseSchema, postCreateObject, preDropObject, setName, setQualifier, shouldCreateDatabaseSchema, shouldCreateVPDCalls, toString

Methods inherited from class java.lang.Object

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

Field Detail

targetTable

protected String targetTable

fields

protected List<String> fields

isUnique

protected boolean isUnique

Constructor Detail

IndexDefinition

public IndexDefinition()

Method Detail

isUnique

public boolean isUnique()

setIsUnique

public void setIsUnique(boolean isUnique)

getTargetTable

public String getTargetTable()

setTargetTable

public void setTargetTable(String targetTable)

PUBLIC: set qualified table name.

addField

public void addField(String fieldName)

PUBLIC: Add the field to the index.

buildCreationWriter

public Writer buildCreationWriter(AbstractSession session,
                                  Writer writer)
                           throws ValidationException

INTERNAL: Return the create type statement.

Specified by:

buildCreationWriter in class DatabaseObjectDefinition

Throws:

ValidationException

buildDeletionWriter

public Writer buildDeletionWriter(AbstractSession session,
                                  Writer writer)
                           throws ValidationException

INTERNAL: Return the drop type statement.

Specified by:

buildDeletionWriter in class DatabaseObjectDefinition

Throws:

ValidationException

getFields

public List<String> getFields()

setFields

public void setFields(List<String> fields)