org.eclipse.jpt.jpa.eclipselink.core.context
Interface EclipseLinkCaching

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model

All Known Subinterfaces:

JavaEclipseLinkCaching, OrmEclipseLinkCaching

public interface EclipseLinkCaching
extends JpaContextNode

EclipseLink caching

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

2.1

Version:

2.1

Field Summary

static boolean	DEFAULT_ALWAYS_REFRESH
static java.lang.String	DEFAULT_ALWAYS_REFRESH_PROPERTY
static EclipseLinkCacheCoordinationType	DEFAULT_COORDINATION_TYPE
static java.lang.String	DEFAULT_COORDINATION_TYPE_PROPERTY
static boolean	DEFAULT_DISABLE_HITS
static java.lang.String	DEFAULT_DISABLE_HITS_PROPERTY
static EclipseLinkExistenceType	DEFAULT_EXISTENCE_TYPE
static java.lang.String	DEFAULT_EXISTENCE_TYPE_PROPERTY
static boolean	DEFAULT_REFRESH_ONLY_IF_NEWER
static java.lang.String	DEFAULT_REFRESH_ONLY_IF_NEWER_PROPERTY
static boolean	DEFAULT_SHARED
static java.lang.String	DEFAULT_SHARED_PROPERTY
static int	DEFAULT_SIZE
static java.lang.String	DEFAULT_SIZE_PROPERTY
static EclipseLinkCacheType	DEFAULT_TYPE
static java.lang.String	DEFAULT_TYPE_PROPERTY
static java.lang.String	EXPIRY_PROPERTY
static java.lang.String	EXPIRY_TIME_OF_DAY_PROPERTY
static java.lang.String	SPECIFIED_ALWAYS_REFRESH_PROPERTY
static java.lang.String	SPECIFIED_COORDINATION_TYPE_PROPERTY
static java.lang.String	SPECIFIED_DISABLE_HITS_PROPERTY
static java.lang.String	SPECIFIED_EXISTENCE_TYPE_PROPERTY
static java.lang.String	SPECIFIED_REFRESH_ONLY_IF_NEWER_PROPERTY
static java.lang.String	SPECIFIED_SHARED_PROPERTY
static java.lang.String	SPECIFIED_SIZE_PROPERTY
static java.lang.String	SPECIFIED_TYPE_PROPERTY

Method Summary

EclipseLinkTimeOfDay	addExpiryTimeOfDay() Add Cache expiryTimeOfDay annotation or xml element, this will set Expiry to null as it is not valid to set both expiry and timeOfDayExpiry
EclipseLinkCacheCoordinationType	getCoordinationType() This is the combination of defaultCoordinationType and specifiedCoordinationType.
EclipseLinkCacheCoordinationType	getDefaultCoordinationType()
EclipseLinkExistenceType	getDefaultExistenceType()
int	getDefaultSize()
EclipseLinkCacheType	getDefaultType()
EclipseLinkExistenceType	getExistenceType() This is the combination of defaultExistenceType and specifiedExistenceType.
java.lang.Integer	getExpiry() corresponds to the Cache expiry element.
EclipseLinkTimeOfDay	getExpiryTimeOfDay() corresponds to the Cache expiryTimeOfDay annotation or xml element.
int	getSize() This is the combination of defaultSize and specifiedSize.
java.lang.Boolean	getSpecifiedAlwaysRefresh()
EclipseLinkCacheCoordinationType	getSpecifiedCoordinationType()
java.lang.Boolean	getSpecifiedDisableHits()
EclipseLinkExistenceType	getSpecifiedExistenceType()
java.lang.Boolean	getSpecifiedRefreshOnlyIfNewer()
java.lang.Boolean	getSpecifiedShared()
java.lang.Integer	getSpecifiedSize()
EclipseLinkCacheType	getSpecifiedType()
EclipseLinkCacheType	getType() This is the combination of defaultType and specifiedType.
boolean	isAlwaysRefresh() This is the combination of defaultAlwaysRefresh and specifiedAlwaysRefresh.
boolean	isDefaultAlwaysRefresh()
boolean	isDefaultDisableHits()
boolean	isDefaultRefreshOnlyIfNewer()
boolean	isDefaultShared()
boolean	isDisableHits() This is the combination of defaultDisableHits and specifiedDisableHits.
boolean	isRefreshOnlyIfNewer() This is the combination of defaultRefreshOnlyIfNewer and specifiedRefreshOnlyIfNewer.
boolean	isShared() This is the combination of defaultShared and specifiedShared.
void	removeExpiryTimeOfDay() Removes the Cache expiryTimeOfDay annotation/xml element
void	setExpiry(java.lang.Integer expiry) Setting this to a non-null value will set timeOfDayExpiry to null
void	setSpecifiedAlwaysRefresh(java.lang.Boolean alwaysRefresh)
void	setSpecifiedCoordinationType(EclipseLinkCacheCoordinationType coordinationType)
void	setSpecifiedDisableHits(java.lang.Boolean disableHits)
void	setSpecifiedExistenceType(EclipseLinkExistenceType type)
void	setSpecifiedRefreshOnlyIfNewer(java.lang.Boolean refreshOnlyIfNewer)
void	setSpecifiedShared(java.lang.Boolean shared) Specifying shared false will return the following caching settings to their defaults: type size always refresh refresh only if newer disable hits coordination type Additionally, the following settings will be cleared: expiry expiry time of day These settings do not apply to an unchared cache.
void	setSpecifiedSize(java.lang.Integer size)
void	setSpecifiedType(EclipseLinkCacheType type)

Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextNode

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, synchronizeWithResourceModel, update

Methods inherited from interface org.eclipse.jpt.jpa.core.JpaNode

getJpaProject, getParent, stateChanged

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.common.core.IResourcePart

getResource

Field Detail

SPECIFIED_TYPE_PROPERTY

static final java.lang.String SPECIFIED_TYPE_PROPERTY

See Also:

Constant Field Values

DEFAULT_TYPE_PROPERTY

static final java.lang.String DEFAULT_TYPE_PROPERTY

See Also:

Constant Field Values

DEFAULT_TYPE

static final EclipseLinkCacheType DEFAULT_TYPE

SPECIFIED_SIZE_PROPERTY

static final java.lang.String SPECIFIED_SIZE_PROPERTY

See Also:

Constant Field Values

DEFAULT_SIZE_PROPERTY

static final java.lang.String DEFAULT_SIZE_PROPERTY

See Also:

Constant Field Values

DEFAULT_SIZE

static final int DEFAULT_SIZE

See Also:

Constant Field Values

SPECIFIED_SHARED_PROPERTY

static final java.lang.String SPECIFIED_SHARED_PROPERTY

See Also:

Constant Field Values

DEFAULT_SHARED_PROPERTY

static final java.lang.String DEFAULT_SHARED_PROPERTY

See Also:

Constant Field Values

DEFAULT_SHARED

static final boolean DEFAULT_SHARED

See Also:

Constant Field Values

SPECIFIED_ALWAYS_REFRESH_PROPERTY

static final java.lang.String SPECIFIED_ALWAYS_REFRESH_PROPERTY

See Also:

Constant Field Values

DEFAULT_ALWAYS_REFRESH_PROPERTY

static final java.lang.String DEFAULT_ALWAYS_REFRESH_PROPERTY

See Also:

Constant Field Values

DEFAULT_ALWAYS_REFRESH

static final boolean DEFAULT_ALWAYS_REFRESH

See Also:

Constant Field Values

SPECIFIED_REFRESH_ONLY_IF_NEWER_PROPERTY

static final java.lang.String SPECIFIED_REFRESH_ONLY_IF_NEWER_PROPERTY

See Also:

Constant Field Values

DEFAULT_REFRESH_ONLY_IF_NEWER_PROPERTY

static final java.lang.String DEFAULT_REFRESH_ONLY_IF_NEWER_PROPERTY

See Also:

Constant Field Values

DEFAULT_REFRESH_ONLY_IF_NEWER

static final boolean DEFAULT_REFRESH_ONLY_IF_NEWER

See Also:

Constant Field Values

SPECIFIED_DISABLE_HITS_PROPERTY

static final java.lang.String SPECIFIED_DISABLE_HITS_PROPERTY

See Also:

Constant Field Values

DEFAULT_DISABLE_HITS_PROPERTY

static final java.lang.String DEFAULT_DISABLE_HITS_PROPERTY

See Also:

Constant Field Values

DEFAULT_DISABLE_HITS

static final boolean DEFAULT_DISABLE_HITS

See Also:

Constant Field Values

SPECIFIED_COORDINATION_TYPE_PROPERTY

static final java.lang.String SPECIFIED_COORDINATION_TYPE_PROPERTY

See Also:

Constant Field Values

DEFAULT_COORDINATION_TYPE_PROPERTY

static final java.lang.String DEFAULT_COORDINATION_TYPE_PROPERTY

See Also:

Constant Field Values

DEFAULT_COORDINATION_TYPE

static final EclipseLinkCacheCoordinationType DEFAULT_COORDINATION_TYPE

EXPIRY_PROPERTY

static final java.lang.String EXPIRY_PROPERTY

See Also:

Constant Field Values

EXPIRY_TIME_OF_DAY_PROPERTY

static final java.lang.String EXPIRY_TIME_OF_DAY_PROPERTY

See Also:

Constant Field Values

SPECIFIED_EXISTENCE_TYPE_PROPERTY

static final java.lang.String SPECIFIED_EXISTENCE_TYPE_PROPERTY

See Also:

Constant Field Values

DEFAULT_EXISTENCE_TYPE_PROPERTY

static final java.lang.String DEFAULT_EXISTENCE_TYPE_PROPERTY

See Also:

Constant Field Values

DEFAULT_EXISTENCE_TYPE

static final EclipseLinkExistenceType DEFAULT_EXISTENCE_TYPE

Method Detail

getType

EclipseLinkCacheType getType()

This is the combination of defaultType and specifiedType. If getSpecifiedType() returns null, then return getDefaultType()

getSpecifiedType

EclipseLinkCacheType getSpecifiedType()

setSpecifiedType

void setSpecifiedType(EclipseLinkCacheType type)

getDefaultType

EclipseLinkCacheType getDefaultType()

getSize

int getSize()

This is the combination of defaultSize and specifiedSize. If getSpecifiedSize() returns null, then return getDefaultSize()

getSpecifiedSize

java.lang.Integer getSpecifiedSize()

setSpecifiedSize

void setSpecifiedSize(java.lang.Integer size)

getDefaultSize

int getDefaultSize()

isShared

boolean isShared()

This is the combination of defaultShared and specifiedShared. If getSpecifiedShared() returns null, then return isDefaultShared()

getSpecifiedShared

java.lang.Boolean getSpecifiedShared()

setSpecifiedShared

void setSpecifiedShared(java.lang.Boolean shared)

Specifying shared false will return the following caching settings to their defaults:

• type
• size
• always refresh
• refresh only if newer
• disable hits
• coordination type

Additionally, the following settings will be cleared:

• expiry
• expiry time of day

These settings do not apply to an unchared cache.

isDefaultShared

boolean isDefaultShared()

isAlwaysRefresh

boolean isAlwaysRefresh()

This is the combination of defaultAlwaysRefresh and specifiedAlwaysRefresh. If getSpecifiedAlwaysRefresh() returns null, then return isDefaultAlwaysRefresh()

getSpecifiedAlwaysRefresh

java.lang.Boolean getSpecifiedAlwaysRefresh()

setSpecifiedAlwaysRefresh

void setSpecifiedAlwaysRefresh(java.lang.Boolean alwaysRefresh)

isDefaultAlwaysRefresh

boolean isDefaultAlwaysRefresh()

isRefreshOnlyIfNewer

boolean isRefreshOnlyIfNewer()

This is the combination of defaultRefreshOnlyIfNewer and specifiedRefreshOnlyIfNewer. If getSpecifiedRefreshOnlyIfNewer() returns null, then return isDefaultRefreshOnlyIfNewer()

getSpecifiedRefreshOnlyIfNewer

java.lang.Boolean getSpecifiedRefreshOnlyIfNewer()

setSpecifiedRefreshOnlyIfNewer

void setSpecifiedRefreshOnlyIfNewer(java.lang.Boolean refreshOnlyIfNewer)

isDefaultRefreshOnlyIfNewer

boolean isDefaultRefreshOnlyIfNewer()

isDisableHits

boolean isDisableHits()

This is the combination of defaultDisableHits and specifiedDisableHits. If getSpecifiedDisableHits() returns null, then return getDefaultDisableHits()

getSpecifiedDisableHits

java.lang.Boolean getSpecifiedDisableHits()

setSpecifiedDisableHits

void setSpecifiedDisableHits(java.lang.Boolean disableHits)

isDefaultDisableHits

boolean isDefaultDisableHits()

getCoordinationType

EclipseLinkCacheCoordinationType getCoordinationType()

This is the combination of defaultCoordinationType and specifiedCoordinationType. If getSpecifiedCoordinationType() returns null, then return getDefaultCoordinationType()

getSpecifiedCoordinationType

EclipseLinkCacheCoordinationType getSpecifiedCoordinationType()

setSpecifiedCoordinationType

void setSpecifiedCoordinationType(EclipseLinkCacheCoordinationType coordinationType)

getDefaultCoordinationType

EclipseLinkCacheCoordinationType getDefaultCoordinationType()

getExpiry

java.lang.Integer getExpiry()

corresponds to the Cache expiry element. If this returns a non-null value then getExpiryTimeOfDay will return null. It is not valid to specify both

setExpiry

void setExpiry(java.lang.Integer expiry)

Setting this to a non-null value will set timeOfDayExpiry to null

getExpiryTimeOfDay

EclipseLinkTimeOfDay getExpiryTimeOfDay()

corresponds to the Cache expiryTimeOfDay annotation or xml element. If this returns a non-null value then getExpiry will return null. It is not valid to specify both.

addExpiryTimeOfDay

EclipseLinkTimeOfDay addExpiryTimeOfDay()

Add Cache expiryTimeOfDay annotation or xml element, this will set Expiry to null as it is not valid to set both expiry and timeOfDayExpiry

removeExpiryTimeOfDay

void removeExpiryTimeOfDay()

Removes the Cache expiryTimeOfDay annotation/xml element

getExistenceType

EclipseLinkExistenceType getExistenceType()

This is the combination of defaultExistenceType and specifiedExistenceType. If getSpecifiedExistenceType() returns null, then return getDefaultExistenceType()

getSpecifiedExistenceType

EclipseLinkExistenceType getSpecifiedExistenceType()

setSpecifiedExistenceType

void setSpecifiedExistenceType(EclipseLinkExistenceType type)

getDefaultExistenceType

EclipseLinkExistenceType getDefaultExistenceType()