Top Description Fields Constructors Methods
org.eclipse.persistence.internal.jpa.metadata.cache

public Class CacheIndexMetadata

extends ORMetadata
Class Inheritance
Imports
java.util.ArrayList, .List, org.eclipse.persistence.descriptors.CacheIndex, org.eclipse.persistence.internal.helper.DatabaseField, org.eclipse.persistence.internal.jpa.metadata.MetadataDescriptor, .ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation
INTERNAL: Object to hold onto cache 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.
Author
James Sutherland
Since
EclipseLink 2.2

Field Summary

Modifier and TypeField and Description
private List<String>
m_columnNames

private Boolean
updateable

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
m_project

Constructor Summary

AccessConstructor and Description
public
CacheIndexMetadata()

INTERNAL: Used for OX mapping.

public
CacheIndexMetadata(MetadataAnnotation index, MetadataAccessor accessor)

INTERNAL:

Method Summary

Modifier and TypeMethod 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 List<String>
getColumnNames()

INTERNAL: Used for OX mapping.

private DatabaseField
getField(String name)

public Boolean
getUpdateable()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public void
process(MetadataDescriptor descriptor, String defaultColumnName)

INTERNAL: Process the index metadata

public void
setColumnNames(List<String> columnNames)

INTERNAL: Used for OX mapping.

public void
setUpdateable(Boolean updateable)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
getAccessibleObjectgetAccessibleObjectNamegetAnnotationgetBoxedTypegetDatabaseTypeEnumgetEntityMappingsgetFullyQualifiedClassNamegetIdentifiergetJavaClassgetJavaClassNamegetLoadergetLocationgetLoggergetMetadataClassgetMetadataClassgetMetadataClassgetMetadataFactorygetNamegetPrimitiveClassForNamegetProjectgetTextgetXMLElementhasIdentifierhasTextinitXMLClassNameinitXMLObjectinitXMLObjectinitXMLObjectsinitXMLTextObjectloadedFromAnnotationloadedFromEclipseLinkXMLloadedFromXMLmergemergeORObjectListsmergeORObjectsmergeSimpleObjectsreloadEntityreloadMappedSuperclasssetAccessibleObjectsetEntityMappingssetFieldNamesetFieldNamesetProjectshouldOverridevaluesMatchvaluesMatch

Field Detail

m_columnNamesback to summary
private List<String> m_columnNames
updateableback to summary
private Boolean updateable

Constructor Detail

CacheIndexMetadataback to summary
public CacheIndexMetadata()

INTERNAL: Used for OX mapping.

CacheIndexMetadataback to summary
public CacheIndexMetadata(MetadataAnnotation index, MetadataAccessor accessor)

INTERNAL:

Method Detail

equalsback 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
getColumnNamesback to summary
public List<String> getColumnNames()

INTERNAL: Used for OX mapping.

getFieldback to summary
private DatabaseField getField(String name)
getUpdateableback to summary
public Boolean getUpdateable()

INTERNAL: Used for OX mapping.

hashCodeback 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
processback to summary
public void process(MetadataDescriptor descriptor, String defaultColumnName)

INTERNAL: Process the index metadata

setColumnNamesback to summary
public void setColumnNames(List<String> columnNames)

INTERNAL: Used for OX mapping.

setUpdateableback to summary
public void setUpdateable(Boolean updateable)

INTERNAL: Used for OX mapping.