EclipseLink JPA 4.0.2 · org.eclipse.persistence.internal.jpa.metadata.tables.IndexMetadata

Modifier and Type	Field and Description
private static final char	FIELD_SEP Name parts separator.
private static final String	INDEX Name prefix.
private String	m_catalog
private String	m_columnList
private List<String>	m_columnNames
private String	m_name
private String	m_schema
private String	m_table
private Boolean	m_unique

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

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. objectToCompare) Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals. INTERNAL:
public String	getCatalog() INTERNAL: Used for OX mapping.
public String	getColumnList() INTERNAL: Used for OX mapping.
public List<String>	getColumnNames() INTERNAL: Used for OX mapping.
protected String	getIdentifier() Overrides org.eclipse.persistence.internal.jpa.metadata.ORMetadata.getIdentifier. INTERNAL: Sub classes that can uniquely be identified must override this method to allow the overriding and merging to uniquely identify objects.
public String	getName() INTERNAL: Used for OX mapping.
public String	getSchema() INTERNAL: Used for OX mapping.
public String	getTable() INTERNAL: Used for OX mapping.
public Boolean	getUnique() INTERNAL: Used for OX mapping.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
protected boolean	hasName() INTERNAL: Return true is a name has been specified for this index.
protected boolean	isUnique() INTERNAL: Return true is there is a unique setting for this index.
public void	process(DatabaseTable table) INTERNAL: Process the index metadata.
public void	process(MetadataDescriptor descriptor, String defaultColumnName) INTERNAL: Process the index metadata.
protected String	processName(DatabaseTable table, IndexDefinition indexDefinition) INTERNAL: Process the name.
public void	setCatalog(String catalog) INTERNAL: Used for OX mapping.
public void	setColumnList(String columnList) INTERNAL: Used for OX mapping.
public void	setColumnNames(List<String> columnNames) INTERNAL: Used for OX mapping.
public void	setName(String name) INTERNAL: Used for OX mapping.
public void	setSchema(String schema) INTERNAL: Used for OX mapping.
public void	setTable(String table) INTERNAL: Used for OX mapping.
public void	setUnique(Boolean unique) INTERNAL: Used for OX mapping.

FIELD_SEP	back to summary
private static final char FIELD_SEP Name parts separator.

INDEX	back to summary
private static final String INDEX Name prefix.

m_catalog	back to summary
private String m_catalog

m_columnList	back to summary
private String m_columnList

m_columnNames	back to summary
private List<String> m_columnNames

m_name	back to summary
private String m_name

m_schema	back to summary
private String m_schema

m_table	back to summary
private String m_table

m_unique	back to summary
private Boolean m_unique

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object objectToCompare) Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals. INTERNAL: Parameters objectToCompare:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL:

Parameters

objectToCompare:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getCatalog	back to summary
public String getCatalog() INTERNAL: Used for OX mapping.

getColumnList	back to summary
public String getColumnList() INTERNAL: Used for OX mapping.

getColumnNames	back to summary
public List<String> getColumnNames() INTERNAL: Used for OX mapping.

getIdentifier back to summary

getIdentifier	back to summary
protected String getIdentifier() Overrides org.eclipse.persistence.internal.jpa.metadata.ORMetadata.getIdentifier. INTERNAL: Sub classes that can uniquely be identified must override this method to allow the overriding and merging to uniquely identify objects. It will also be used when logging messages, that is, to provide a more detailed message. Annotations @Override See Also `shouldOverride(ORMetadata)`, `mergeORObjects(ORMetadata, ORMetadata)`, `mergeORObjectLists(List, List)`

protected String getIdentifier()

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

INTERNAL: Sub classes that can uniquely be identified must override this method to allow the overriding and merging to uniquely identify objects. It will also be used when logging messages, that is, to provide a more detailed message.

Annotations

@Override

getName	back to summary
public String getName() INTERNAL: Used for OX mapping.

getSchema	back to summary
public String getSchema() INTERNAL: Used for OX mapping.

getTable	back to summary
public String getTable() INTERNAL: Used for OX mapping.

getUnique	back to summary
public Boolean getUnique() INTERNAL: Used for OX mapping.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

hasName	back to summary
protected boolean hasName() INTERNAL: Return true is a name has been specified for this index.

isUnique	back to summary
protected boolean isUnique() INTERNAL: Return true is there is a unique setting for this index.

process	back to summary
public void process(DatabaseTable table) INTERNAL: Process the index metadata. This is called from all table metadata. CollectionTable, SecondaryTable, JoinTable, Table, TableGenerator.

process	back to summary
public void process(MetadataDescriptor descriptor, String defaultColumnName) INTERNAL: Process the index metadata. This is called from EntityAccessor and BasicAccesor (for Basic, Id and Version)

processName	back to summary
protected String processName(DatabaseTable table, IndexDefinition indexDefinition) INTERNAL: Process the name. If specified it, use it, otherwise create a default. e.g. INDEX_tablename_field1_field2_.....

setCatalog	back to summary
public void setCatalog(String catalog) INTERNAL: Used for OX mapping.

setColumnList	back to summary
public void setColumnList(String columnList) INTERNAL: Used for OX mapping.

setColumnNames	back to summary
public void setColumnNames(List<String> columnNames) INTERNAL: Used for OX mapping.

setName	back to summary
public void setName(String name) INTERNAL: Used for OX mapping.

setSchema	back to summary
public void setSchema(String schema) INTERNAL: Used for OX mapping.

setTable	back to summary
public void setTable(String table) INTERNAL: Used for OX mapping.

setUnique	back to summary
public void setUnique(Boolean unique) INTERNAL: Used for OX mapping.

public Class IndexMetadata

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail