Package org.eclipse.persistence.internal.jpa.metadata.cache

Class CacheMetadata

java.lang.Object

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

org.eclipse.persistence.internal.jpa.metadata.cache.CacheMetadata

public class CacheMetadata
extends ORMetadata

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.

Since:

TopLink 11g

Author:

Guy Pelletier

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.Boolean	m_alwaysRefresh
protected java.lang.String	m_coordinationType
protected java.lang.String	m_databaseChangeNotificationType
protected java.lang.Boolean	m_disableHits
protected java.lang.Integer	m_expiry
protected TimeOfDayMetadata	m_expiryTimeOfDay
protected java.lang.String	m_isolation
protected java.lang.Boolean	m_refreshOnlyIfNewer
protected java.lang.Boolean	m_shared
protected java.lang.Integer	m_size
protected java.lang.String	m_type

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

m_project

Constructor Summary

Constructors

Constructor	Description
CacheMetadata()	INTERNAL: Used for XML loading.
CacheMetadata(MetadataAnnotation cache, MetadataAccessor accessor)	INTERNAL: Used for annotation loading.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object objectToCompare)	INTERNAL:
java.lang.Boolean	getAlwaysRefresh()	INTERNAL: Used for OX mapping.
java.lang.String	getCoordinationType()	INTERNAL: Used for OX mapping.
java.lang.String	getDatabaseChangeNotificationType()	INTERNAL: Used for OX mapping.
java.lang.Boolean	getDisableHits()	INTERNAL: Used for OX mapping.
java.lang.Integer	getExpiry()	INTERNAL: Used for OX mapping.
TimeOfDayMetadata	getExpiryTimeOfDay()	INTERNAL: Used for OX mapping.
java.lang.String	getIsolation()
java.lang.Boolean	getRefreshOnlyIfNewer()	INTERNAL: Used for OX mapping.
java.lang.Boolean	getShared()	INTERNAL: Used for OX mapping.
java.lang.Integer	getSize()	INTERNAL: Used for OX mapping.
java.lang.String	getType()	INTERNAL: Used for OX mapping.
int	hashCode()
void	process(MetadataDescriptor descriptor, MetadataClass javaClass)	INTERNAL:
void	setAlwaysRefresh(java.lang.Boolean alwaysRefresh)	INTERNAL: Used for OX mapping
void	setCoordinationType(java.lang.String coordinationType)	INTERNAL: Used for OX mapping.
void	setDatabaseChangeNotificationType(java.lang.String databaseChangeNotificationType)	INTERNAL: Used for OX mapping.
void	setDisableHits(java.lang.Boolean disableHits)	INTERNAL: Used for OX mapping.
void	setExpiry(java.lang.Integer expiry)	INTERNAL: Used for OX mapping.
void	setExpiryTimeOfDay(TimeOfDayMetadata expiryTimeOfDay)	INTERNAL: Used for OX mapping.
void	setIsolation(java.lang.String isolation)
void	setRefreshOnlyIfNewer(java.lang.Boolean refreshOnlyIfNewer)	INTERNAL: Used for OX mapping.
void	setShared(java.lang.Boolean shared)	INTERNAL: Used for OX mapping.
void	setSize(java.lang.Integer size)	INTERNAL: Used for OX mapping.
void	setType(java.lang.String type)	INTERNAL: Used for OX mapping.

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

getAccessibleObject, getAccessibleObjectName, getAnnotation, getBoxedType, getDatabaseTypeEnum, getEntityMappings, getFullyQualifiedClassName, getIdentifier, getJavaClass, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getName, getPrimitiveClassForName, getProject, getText, getXMLElement, hasIdentifier, hasText, initXMLClassName, initXMLObject, initXMLObject, initXMLObjects, initXMLTextObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, merge, mergeORObjectLists, mergeORObjects, mergeSimpleObjects, reloadEntity, reloadMappedSuperclass, setAccessibleObject, setEntityMappings, setFieldName, setFieldName, setProject, shouldOverride, valuesMatch, valuesMatch

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_alwaysRefresh

protected java.lang.Boolean m_alwaysRefresh

m_disableHits

protected java.lang.Boolean m_disableHits

m_shared

protected java.lang.Boolean m_shared

m_isolation

protected java.lang.String m_isolation

m_refreshOnlyIfNewer

protected java.lang.Boolean m_refreshOnlyIfNewer

m_coordinationType

protected java.lang.String m_coordinationType

m_databaseChangeNotificationType

protected java.lang.String m_databaseChangeNotificationType

m_type

protected java.lang.String m_type

m_expiry

protected java.lang.Integer m_expiry

m_size

protected java.lang.Integer m_size

m_expiryTimeOfDay

protected TimeOfDayMetadata m_expiryTimeOfDay

Constructor Detail

CacheMetadata

public CacheMetadata()

INTERNAL: Used for XML loading.

CacheMetadata

public CacheMetadata(MetadataAnnotation cache,
                     MetadataAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equals

public boolean equals(java.lang.Object objectToCompare)

INTERNAL:

Specified by:

equals in class ORMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getAlwaysRefresh

public java.lang.Boolean getAlwaysRefresh()

INTERNAL: Used for OX mapping.

getCoordinationType

public java.lang.String getCoordinationType()

INTERNAL: Used for OX mapping.

getDisableHits

public java.lang.Boolean getDisableHits()

INTERNAL: Used for OX mapping.

getExpiry

public java.lang.Integer getExpiry()

INTERNAL: Used for OX mapping.

getExpiryTimeOfDay

public TimeOfDayMetadata getExpiryTimeOfDay()

INTERNAL: Used for OX mapping.

getRefreshOnlyIfNewer

public java.lang.Boolean getRefreshOnlyIfNewer()

INTERNAL: Used for OX mapping.

getShared

public java.lang.Boolean getShared()

INTERNAL: Used for OX mapping.

getIsolation

public java.lang.String getIsolation()

getSize

public java.lang.Integer getSize()

INTERNAL: Used for OX mapping.

getType

public java.lang.String getType()

INTERNAL: Used for OX mapping.

process

public void process(MetadataDescriptor descriptor,
                    MetadataClass javaClass)

INTERNAL:

setAlwaysRefresh

public void setAlwaysRefresh(java.lang.Boolean alwaysRefresh)

INTERNAL: Used for OX mapping

setCoordinationType

public void setCoordinationType(java.lang.String coordinationType)

INTERNAL: Used for OX mapping.

getDatabaseChangeNotificationType

public java.lang.String getDatabaseChangeNotificationType()

INTERNAL: Used for OX mapping.

setDatabaseChangeNotificationType

public void setDatabaseChangeNotificationType(java.lang.String databaseChangeNotificationType)

INTERNAL: Used for OX mapping.

setDisableHits

public void setDisableHits(java.lang.Boolean disableHits)

INTERNAL: Used for OX mapping.

setExpiry

public void setExpiry(java.lang.Integer expiry)

INTERNAL: Used for OX mapping.

setExpiryTimeOfDay

public void setExpiryTimeOfDay(TimeOfDayMetadata expiryTimeOfDay)

INTERNAL: Used for OX mapping.

setRefreshOnlyIfNewer

public void setRefreshOnlyIfNewer(java.lang.Boolean refreshOnlyIfNewer)

INTERNAL: Used for OX mapping.

setShared

public void setShared(java.lang.Boolean shared)

INTERNAL: Used for OX mapping.

setIsolation

public void setIsolation(java.lang.String isolation)

setSize

public void setSize(java.lang.Integer size)

INTERNAL: Used for OX mapping.

setType

public void setType(java.lang.String type)

INTERNAL: Used for OX mapping.