Top Description Fields Constructors Methods
org.eclipse.persistence.tools.schemaframework

public Class IndexDefinition

extends DatabaseObjectDefinition
Class Inheritance
Imports
java.util.*, java.io.*, org.eclipse.persistence.exceptions.*, org.eclipse.persistence.internal.sessions.AbstractSession

Purpose: Allow for indexes to be created.

Author
James Sutherland
Since
EclipseLink 2.2

Field Summary

Modifier and TypeField and Description
protected List<String>
fields

protected boolean
isUnique

protected String
targetTable

Inherited from org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition:
namequalifier

Constructor Summary

AccessConstructor and Description
public
IndexDefinition()

Method Summary

Modifier and TypeMethod and Description
public void
addField(String fieldName)

PUBLIC: Add the field to the index.

public Writer
buildCreationWriter(AbstractSession session, Writer writer)

Implements abstract org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildCreationWriter.

INTERNAL: Return the create type statement.
public Writer
buildDeletionWriter(AbstractSession session, Writer writer)

Implements abstract org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildDeletionWriter.

INTERNAL: Return the drop type statement.
public List<String>
getFields()

public String
getTargetTable()

public boolean
isUnique()

public void
setFields(List<String> fields)

public void
setIsUnique(boolean isUnique)

public void
setTargetTable(String targetTable)

PUBLIC: set qualified table name.

Inherited from org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition:
buildVPDCreationFunctionWriterbuildVPDCreationPolicyWriterbuildVPDDeletionWriterclonecreateDatabaseSchemacreateDatabaseSchemaOnDatabasecreateObjectcreateOnDatabasedropDatabaseSchemadropDatabaseSchemaOnDatabasedropFromDatabasedropObjectgetDatabaseSchemagetFieldTypeDefinitiongetFieldTypeDefinitiongetFullNamegetNamegetQualifierhasDatabaseSchemapostCreateObjectpreDropObjectsetNamesetQualifiershouldCreateDatabaseSchemashouldCreateVPDCallstoString

Field Detail

fieldsback to summary
protected List<String> fields
isUniqueback to summary
protected boolean isUnique
targetTableback to summary
protected String targetTable

Constructor Detail

IndexDefinitionback to summary
public IndexDefinition()

Method Detail

addFieldback to summary
public void addField(String fieldName)

PUBLIC: Add the field to the index.

buildCreationWriterback to summary
public Writer buildCreationWriter(AbstractSession session, Writer writer) throws ValidationException

Implements abstract org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildCreationWriter.

INTERNAL: Return the create type statement.

Annotations
@Override
buildDeletionWriterback to summary
public Writer buildDeletionWriter(AbstractSession session, Writer writer) throws ValidationException

Implements abstract org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildDeletionWriter.

INTERNAL: Return the drop type statement.

Annotations
@Override
getFieldsback to summary
public List<String> getFields()
getTargetTableback to summary
public String getTargetTable()
isUniqueback to summary
public boolean isUnique()
setFieldsback to summary
public void setFields(List<String> fields)
setIsUniqueback to summary
public void setIsUnique(boolean isUnique)
setTargetTableback to summary
public void setTargetTable(String targetTable)

PUBLIC: set qualified table name.