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

public Class CacheMetadata

extends ORMetadata
Class Inheritance
Imports
org.eclipse.persistence.annotations.CacheCoordinationType, .CacheType, .DatabaseChangeNotificationType, org.eclipse.persistence.config.CacheIsolationType, org.eclipse.persistence.descriptors.ClassDescriptor, org.eclipse.persistence.descriptors.invalidation.DailyCacheInvalidationPolicy, .TimeToLiveCacheInvalidationPolicy, org.eclipse.persistence.exceptions.ValidationException, 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, .MetadataClass
Object to hold onto cache 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
Guy Pelletier
Since
TopLink 11g

Field Summary

Modifier and TypeField and Description
protected Boolean
m_alwaysRefresh

protected String
m_coordinationType

protected String
m_databaseChangeNotificationType

protected Boolean
m_disableHits

protected Integer
m_expiry

protected TimeOfDayMetadata
m_expiryTimeOfDay

protected String
m_isolation

protected Boolean
m_refreshOnlyIfNewer

protected Integer
m_size

protected String
m_type

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

Constructor Summary

AccessConstructor and Description
public
CacheMetadata()

INTERNAL: Used for XML loading.

public
CacheMetadata(MetadataAnnotation cache, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

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 Boolean
getAlwaysRefresh()

INTERNAL: Used for OX mapping.

public String
getCoordinationType()

INTERNAL: Used for OX mapping.

public String
getDatabaseChangeNotificationType()

INTERNAL: Used for OX mapping.

public Boolean
getDisableHits()

INTERNAL: Used for OX mapping.

public Integer
getExpiry()

INTERNAL: Used for OX mapping.

public TimeOfDayMetadata
getExpiryTimeOfDay()

INTERNAL: Used for OX mapping.

public String
getIsolation()

public Boolean
getRefreshOnlyIfNewer()

INTERNAL: Used for OX mapping.

public Integer
getSize()

INTERNAL: Used for OX mapping.

public String
getType()

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, MetadataClass javaClass)

INTERNAL:

public void
setAlwaysRefresh(Boolean alwaysRefresh)

INTERNAL: Used for OX mapping

public void
setCoordinationType(String coordinationType)

INTERNAL: Used for OX mapping.

public void
setDatabaseChangeNotificationType(String databaseChangeNotificationType)

INTERNAL: Used for OX mapping.

public void
setDisableHits(Boolean disableHits)

INTERNAL: Used for OX mapping.

public void
setExpiry(Integer expiry)

INTERNAL: Used for OX mapping.

public void
setExpiryTimeOfDay(TimeOfDayMetadata expiryTimeOfDay)

INTERNAL: Used for OX mapping.

public void
setIsolation(String isolation)

public void
setRefreshOnlyIfNewer(Boolean refreshOnlyIfNewer)

INTERNAL: Used for OX mapping.

public void
setSize(Integer size)

INTERNAL: Used for OX mapping.

public void
setType(String type)

INTERNAL: Used for OX mapping.

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

Field Detail

m_alwaysRefreshback to summary
protected Boolean m_alwaysRefresh
m_coordinationTypeback to summary
protected String m_coordinationType
m_databaseChangeNotificationTypeback to summary
protected String m_databaseChangeNotificationType
m_disableHitsback to summary
protected Boolean m_disableHits
m_expiryback to summary
protected Integer m_expiry
m_expiryTimeOfDayback to summary
protected TimeOfDayMetadata m_expiryTimeOfDay
m_isolationback to summary
protected String m_isolation
m_refreshOnlyIfNewerback to summary
protected Boolean m_refreshOnlyIfNewer
m_sizeback to summary
protected Integer m_size
m_typeback to summary
protected String m_type

Constructor Detail

CacheMetadataback to summary
public CacheMetadata()

INTERNAL: Used for XML loading.

CacheMetadataback to summary
public CacheMetadata(MetadataAnnotation cache, MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

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
getAlwaysRefreshback to summary
public Boolean getAlwaysRefresh()

INTERNAL: Used for OX mapping.

getCoordinationTypeback to summary
public String getCoordinationType()

INTERNAL: Used for OX mapping.

getDatabaseChangeNotificationTypeback to summary
public String getDatabaseChangeNotificationType()

INTERNAL: Used for OX mapping.

getDisableHitsback to summary
public Boolean getDisableHits()

INTERNAL: Used for OX mapping.

getExpiryback to summary
public Integer getExpiry()

INTERNAL: Used for OX mapping.

getExpiryTimeOfDayback to summary
public TimeOfDayMetadata getExpiryTimeOfDay()

INTERNAL: Used for OX mapping.

getIsolationback to summary
public String getIsolation()
getRefreshOnlyIfNewerback to summary
public Boolean getRefreshOnlyIfNewer()

INTERNAL: Used for OX mapping.

getSizeback to summary
public Integer getSize()

INTERNAL: Used for OX mapping.

getTypeback to summary
public String getType()

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, MetadataClass javaClass)

INTERNAL:

setAlwaysRefreshback to summary
public void setAlwaysRefresh(Boolean alwaysRefresh)

INTERNAL: Used for OX mapping

setCoordinationTypeback to summary
public void setCoordinationType(String coordinationType)

INTERNAL: Used for OX mapping.

setDatabaseChangeNotificationTypeback to summary
public void setDatabaseChangeNotificationType(String databaseChangeNotificationType)

INTERNAL: Used for OX mapping.

setDisableHitsback to summary
public void setDisableHits(Boolean disableHits)

INTERNAL: Used for OX mapping.

setExpiryback to summary
public void setExpiry(Integer expiry)

INTERNAL: Used for OX mapping.

setExpiryTimeOfDayback to summary
public void setExpiryTimeOfDay(TimeOfDayMetadata expiryTimeOfDay)

INTERNAL: Used for OX mapping.

setIsolationback to summary
public void setIsolation(String isolation)
setRefreshOnlyIfNewerback to summary
public void setRefreshOnlyIfNewer(Boolean refreshOnlyIfNewer)

INTERNAL: Used for OX mapping.

setSizeback to summary
public void setSize(Integer size)

INTERNAL: Used for OX mapping.

setTypeback to summary
public void setType(String type)

INTERNAL: Used for OX mapping.