org.eclipse.persistence.internal.jpa.metadata.tables

Class IndexMetadata

java.lang.Object

org.eclipse.persistence.internal.jpa.metadata.ORMetadata

org.eclipse.persistence.internal.jpa.metadata.tables.IndexMetadata

public class IndexMetadata
extends ORMetadata

INTERNAL: Object to hold onto database index metadata. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - when loading from annotations, the constructor accepts the metadata accessor this metadata was loaded from. Used it to look up any 'companion' annotation needed for processing. - methods should be preserved in alphabetical order.

Since:

EclipseLink 2.2

Author:

James Sutherland

Constructor Summary

Constructors

Constructor and Description
IndexMetadata() INTERNAL: Used for OX mapping.
IndexMetadata(MetadataAnnotation index, MetadataAccessor accessor) INTERNAL:

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object objectToCompare) INTERNAL:
java.lang.String	getCatalog() INTERNAL: Used for OX mapping.
java.lang.String	getColumnList() INTERNAL: Used for OX mapping.
java.util.List<java.lang.String>	getColumnNames() INTERNAL: Used for OX mapping.
java.lang.String	getName() INTERNAL: Used for OX mapping.
java.lang.String	getSchema() INTERNAL: Used for OX mapping.
java.lang.String	getTable() INTERNAL: Used for OX mapping.
java.lang.Boolean	getUnique() INTERNAL: Used for OX mapping.
void	process(DatabaseTable table) INTERNAL: Process the index metadata.
void	process(MetadataDescriptor descriptor, java.lang.String defaultColumnName) INTERNAL: Process the index metadata.
void	setCatalog(java.lang.String catalog) INTERNAL: Used for OX mapping.
void	setColumnList(java.lang.String columnList) INTERNAL: Used for OX mapping.
void	setColumnNames(java.util.List<java.lang.String> columnNames) INTERNAL: Used for OX mapping.
void	setName(java.lang.String name) INTERNAL: Used for OX mapping.
void	setSchema(java.lang.String schema) INTERNAL: Used for OX mapping.
void	setTable(java.lang.String table) INTERNAL: Used for OX mapping.
void	setUnique(java.lang.Boolean unique) INTERNAL: Used for OX mapping.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

getAccessibleObjectName, getAnnotation, getEntityMappings, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getProject, initXMLObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, setAccessibleObject, setEntityMappings, setProject, shouldOverride

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexMetadata

public IndexMetadata()

INTERNAL: Used for OX mapping.

IndexMetadata

public IndexMetadata(MetadataAnnotation index,
                     MetadataAccessor accessor)

INTERNAL:

Method Detail

equals

public boolean equals(java.lang.Object objectToCompare)

INTERNAL:

Specified by:

equals in class ORMetadata

getCatalog

public java.lang.String getCatalog()

INTERNAL: Used for OX mapping.

getColumnList

public java.lang.String getColumnList()

INTERNAL: Used for OX mapping.

getColumnNames

public java.util.List<java.lang.String> getColumnNames()

INTERNAL: Used for OX mapping.

getName

public java.lang.String getName()

INTERNAL: Used for OX mapping.

getSchema

public java.lang.String getSchema()

INTERNAL: Used for OX mapping.

getTable

public java.lang.String getTable()

INTERNAL: Used for OX mapping.

getUnique

public java.lang.Boolean getUnique()

INTERNAL: Used for OX mapping.

process

public void process(DatabaseTable table)

INTERNAL: Process the index metadata. This is called from all table metadata. CollectionTable, SecondaryTable, JoinTable, Table, TableGenerator.

process

public void process(MetadataDescriptor descriptor,
                    java.lang.String defaultColumnName)

INTERNAL: Process the index metadata. This is called from EntityAccessor and BasicAccesor (for Basic, Id and Version)

setCatalog

public void setCatalog(java.lang.String catalog)

INTERNAL: Used for OX mapping.

setColumnList

public void setColumnList(java.lang.String columnList)

INTERNAL: Used for OX mapping.

setColumnNames

public void setColumnNames(java.util.List<java.lang.String> columnNames)

INTERNAL: Used for OX mapping.

setName

public void setName(java.lang.String name)

INTERNAL: Used for OX mapping.

setSchema

public void setSchema(java.lang.String schema)

INTERNAL: Used for OX mapping.

setTable

public void setTable(java.lang.String table)

INTERNAL: Used for OX mapping.

setUnique

public void setUnique(java.lang.Boolean unique)

INTERNAL: Used for OX mapping.