org.apache.openjpa.conf
Class Compatibility

java.lang.Object
  org.apache.openjpa.conf.Compatibility

public class Compatibility
extends Object

Struct encompassing backwards-compatibility options.

Constructor Summary

Compatibility()

Method Summary

boolean	getCloseOnManagedCommit() Whether to close the broker when the managed transaction commits.
boolean	getCopyObjectIds() Whether to copy identity objects before returning them to client code.
boolean	getFlushBeforeDetach() Whether OpenJPA should flush changes before detaching or serializing an entity.
boolean	getNonOptimisticVersionCheck() Whether or not to perform a version check on instances being updated in a datastore transaction.
boolean	getQuotedNumbersInQueries() Whether to interpret quoted numbers in query strings as numbers.
boolean	getStrictIdentityValues() Whether to require exact identity value types when creating object ids from a class and value.
boolean	getValidateFalseReturnsHollow() Whether to return hollow instances to broker lookups with a validate parameter of false.
boolean	getValidateTrueChecksStore() Whether to check the datastore for the existence of a nontransactional cached object in broker lookups with a validate parameter of true.
void	setCloseOnManagedCommit(boolean close) Whether to close the broker when the managed transaction commits.
void	setCopyObjectIds(boolean copy) Whether to copy identity objects before returning them to client code.
void	setFlushBeforeDetach(boolean beforeDetach) Whether OpenJPA should flush changes before detaching or serializing an entity.
void	setNonOptimisticVersionCheck(boolean nonOptimisticVersionCheck) Whether or not to perform a version check on instances being updated in a datastore transaction.
void	setQuotedNumbersInQueries(boolean quotedNumbers) Whether to interpret quoted numbers in query strings as numbers.
void	setStrictIdentityValues(boolean strictVals) Whether to require exact identity value types when creating object ids from a class and value.
void	setValidateFalseReturnsHollow(boolean hollow) Whether to return hollow instances to broker lookups with a validate parameter of false.
void	setValidateTrueChecksStore(boolean check) Whether to check the datastore for the existence of a nontransactional cached object in broker lookups with a validate parameter of true.

Methods inherited from class java.lang.Object

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

Constructor Detail

Compatibility

public Compatibility()

Method Detail

getStrictIdentityValues

public boolean getStrictIdentityValues()

Whether to require exact identity value types when creating object ids from a class and value. Defaults to false.

setStrictIdentityValues

public void setStrictIdentityValues(boolean strictVals)

Whether to require exact identity value types when creating object ids from a class and value. Defaults to false.

getQuotedNumbersInQueries

public boolean getQuotedNumbersInQueries()

Whether to interpret quoted numbers in query strings as numbers. OpenJPA versions 0.3.1 and prior treated them as numbers; more recent versions treat them as strings.

setQuotedNumbersInQueries

public void setQuotedNumbersInQueries(boolean quotedNumbers)

Whether to interpret quoted numbers in query strings as numbers. OpenJPA versions 0.3.1 and prior treated them as numbers; more recent versions treat them as strings.

getValidateFalseReturnsHollow

public boolean getValidateFalseReturnsHollow()

Whether to return hollow instances to broker lookups with a validate parameter of false. OpenJPA versions prior to 0.4.0 did not return hollow instances without special configuration (the ObjectLookupMode). Beginning with 0.4.0, hollow objects are the default.

setValidateFalseReturnsHollow

public void setValidateFalseReturnsHollow(boolean hollow)

Whether to return hollow instances to broker lookups with a validate parameter of false. OpenJPA versions prior to 0.4.0 did not return hollow instances without special configuration (the ObjectLookupMode). Beginning with 0.4.0, hollow objects are the default.

getValidateTrueChecksStore

public boolean getValidateTrueChecksStore()

Whether to check the datastore for the existence of a nontransactional cached object in broker lookups with a validate parameter of true. OpenJPA versions prior to 0.4.0 checked the datastore.

setValidateTrueChecksStore

public void setValidateTrueChecksStore(boolean check)

Whether to check the datastore for the existence of a nontransactional cached object in broker lookups with a validate parameter of true. OpenJPA versions prior to 0.4.0 checked the datastore.

getCopyObjectIds

public boolean getCopyObjectIds()

Whether to copy identity objects before returning them to client code. Versions of OpenJPA prior to 0.3.0 always copied identity objects. Also, you should configure OpenJPA to copy identity objects if you mutate them after use.

setCopyObjectIds

public void setCopyObjectIds(boolean copy)

Whether to copy identity objects before returning them to client code. Versions of OpenJPA prior to 0.3.0 always copied identity objects. Also, you should configure OpenJPA to copy identity objects if you mutate them after use.

getCloseOnManagedCommit

public boolean getCloseOnManagedCommit()

Whether to close the broker when the managed transaction commits. Versions of OpenJPA prior to 0.3.0 did not close the broker.

setCloseOnManagedCommit

public void setCloseOnManagedCommit(boolean close)

Whether to close the broker when the managed transaction commits. Versions of OpenJPA prior to 0.3.0 did not close the broker.

setNonOptimisticVersionCheck

public void setNonOptimisticVersionCheck(boolean nonOptimisticVersionCheck)

Whether or not to perform a version check on instances being updated in a datastore transaction. Version of OpenJPA prior to 0.4.1 always forced a version check.

getNonOptimisticVersionCheck

public boolean getNonOptimisticVersionCheck()

Whether or not to perform a version check on instances being updated in a datastore transaction. Version of OpenJPA prior to 0.4.1 always forced a version check.

getFlushBeforeDetach

public boolean getFlushBeforeDetach()

Whether OpenJPA should flush changes before detaching or serializing an entity. In JPA this is usually false, but other persistence frameworks (ie JDO) may expect it to be true.

Prior to version 1.0.3 and 1.2.0 changes were always flushed.

Returns:

true if changes should be flushed, otherwise false.

Since:

1.0.3, 1.2.0

setFlushBeforeDetach

public void setFlushBeforeDetach(boolean beforeDetach)

Whether OpenJPA should flush changes before detaching or serializing an entity. In JPA this is usually false, but other persistence frameworks (ie JDO) may expect it to be true.

Prior to version 1.0.3 and 1.2.0 changes were always flushed.

Parameters:

beforeDetach - if true changes will be flushed before detaching or serializing an entity.

Since:

1.0.3, 1.2.0