EclipseLink Core 4.0.2 · org.eclipse.persistence.history.HistoryPolicy

Modifier and Type	Field and Description
protected ClassDescriptor	descriptor
protected List<DatabaseField>	endFields
protected List<DatabaseTable>	historicalTables
protected DatabaseMapping	mapping
protected boolean	shouldHandleWrites
protected List<DatabaseField>	startFields
protected boolean	usesLocalTime

Access	Constructor and Description
public	HistoryPolicy()

Method Summary

Modifier and Type	Method and Description
public void	addEndFieldName(String endFieldName) PUBLIC:
public void	addHistoryTableName(String name) PUBLIC: Use to specify the names of the mirroring historical tables.
public void	addHistoryTableName(String sourceTableName, String historyTableName) PUBLIC: Use to specify the names of the mirroring historical tables.
public Expression	additionalHistoryExpression(Expression context, Expression base) INTERNAL: Add any temporal querying conditions to this object expression.
public Expression	additionalHistoryExpression(Expression context, Expression base, Integer not null indicates that only expression for a single table should be returned. tableIndex) INTERNAL: Add any temporal querying conditions to this object expression.
public void	addStartFieldName(String startFieldName) PUBLIC: Sets the name of the start field.
protected boolean	checkWastedVersioning(AbstractRecord modifyRow, DatabaseTable table) INTERNAL: Checks for the case where an object has multiple tables but only some are part of a minimal update.
public Object	clone() Overrides java.lang.Object.clone. PUBLIC: Performs a sufficiently deep clone.
public Object	getCurrentTime(AbstractSession session) PUBLIC: Whenever a historical record is logically deleted (updated) or inserted, the end and start fields respectively will be set to this value.
public ClassDescriptor	getDescriptor() PUBLIC: Return the descriptor of the policy.
protected DatabaseField	getEnd() INTERNAL:
protected DatabaseField	getEnd(int i) INTERNAL:
public String	getEndFieldName() PUBLIC:
public List<DatabaseField>	getEndFields() INTERNAL:
public final List<DatabaseTable>	getHistoricalTables() INTERNAL:
public List<String>	getHistoryTableNames() PUBLIC:
public DatabaseMapping	getMapping() PUBLIC:
public long	getMinimumTimeIncrement(AbstractSession session) INTERNAL: Return a minimal time increment supported by the platform.
protected DatabaseField	getStart() INTERNAL:
protected DatabaseField	getStart(int i) INTERNAL:
public String	getStartFieldName() PUBLIC: Answers the name of the start field.
public List<DatabaseField>	getStartFields() INTERNAL:
public void	initialize(AbstractSession session) INTERNAL: Initialize a HistoryPolicy.
public void	logicalDelete(ModifyQuery writeQuery, boolean isUpdate) INTERNAL: Performs a logical delete (update) on the historical schema.
public void	logicalDelete(ModifyQuery writeQuery, boolean isUpdate, boolean isShallow) INTERNAL: Performs a logical delete (update) on the historical schema.
public void	logicalInsert(ObjectLevelModifyQuery writeQuery, boolean isUpdate) INTERNAL: Perform a logical insert into the historical schema, creating a new version of an object.
public void	mappingLogicalDelete(ModifyQuery originalQuery, AbstractRecord arguments, AbstractSession session) INTERNAL: Performs a logical delete (update) on the historical schema.
public void	mappingLogicalInsert(DataModifyQuery originalQuery, AbstractRecord arguments, AbstractSession session) INTERNAL: Performs a logical insert into the historical schema.
public void	postDelete(ModifyQuery deleteQuery) INTERNAL:
public void	postInsert(ObjectLevelModifyQuery writeQuery) INTERNAL:
public void	postUpdate(ObjectLevelModifyQuery writeQuery) INTERNAL:
public void	postUpdate(ObjectLevelModifyQuery writeQuery, boolean isShallow) INTERNAL:
public void	setDescriptor(ClassDescriptor descriptor) PUBLIC:
protected void	setEndFields(List<DatabaseField> endFields) INTERNAL:
public void	setEndFieldType(String fieldName, Class<?> type) ADVANCED:
public void	setHistoricalTables(List<DatabaseTable> historicalTables) INTERNAL:
public void	setMapping(DatabaseMapping mapping) INTERNAL:
public void	setShouldHandleWrites(boolean value) Sets if TopLink is responsible for writing history.
public void	setShouldUseDatabaseTime(boolean if false uses localTime (default) instead value) Sets if the Timestamp used in maintainaing history should be the current time according to the database.
protected void	setStartFields(List<DatabaseField> startFields) INTERNAL:
public void	setStartFieldType(Class<?> type) ADVANCED: Sets the type of all start fields.
public boolean	Returns: true by default shouldHandleWrites() Answers if TopLink is responsible for writing history.
public boolean	Returns: false by default shouldUseDatabaseTime() Answers if the Timestamp used in maintaining history should be the current time according to the database.
public boolean	Returns: true by default shouldUseLocalTime() Answers if the Timestamp used in maintaining history should be System.currentTimeMillis();
public void	useDatabaseTime() Answers if the Timestamp used in maintaining history should be the current time according to the database.
public void	useLocalTime() Answers if the Timestamp used in maintaining history should be System.currentTimeMillis();
protected void	verifyTableQualifiers(DatasourcePlatform platform) INTERNAL: Check that the qualifiers on the historical tables are properly set.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

descriptor	back to summary
protected ClassDescriptor descriptor

endFields	back to summary
protected List<DatabaseField> endFields

historicalTables	back to summary
protected List<DatabaseTable> historicalTables

mapping	back to summary
protected DatabaseMapping mapping

shouldHandleWrites	back to summary
protected boolean shouldHandleWrites

startFields	back to summary
protected List<DatabaseField> startFields

usesLocalTime	back to summary
protected boolean usesLocalTime

HistoryPolicy	back to summary
public HistoryPolicy()

Method Detail

addEndFieldName back to summary

addEndFieldName	back to summary
public void addEndFieldName(String endFieldName) PUBLIC: See Also `addStartFieldName`

public void addEndFieldName(String endFieldName)

PUBLIC:

See Also: addStartFieldName

addHistoryTableName	back to summary
public void addHistoryTableName(String name) PUBLIC: Use to specify the names of the mirroring historical tables. Assumes that the order in which tables are added with descriptor.addTableName() matches the order in which mirroring historical tables are added with descriptor.addHistoryTableName().

addHistoryTableName

back to summary

public void addHistoryTableName(String name)

PUBLIC: Use to specify the names of the mirroring historical tables.

Assumes that the order in which tables are added with descriptor.addTableName() matches the order in which mirroring historical tables are added with descriptor.addHistoryTableName().

addHistoryTableName back to summary

addHistoryTableName	back to summary
public void addHistoryTableName(String sourceTableName, String historyTableName) PUBLIC: Use to specify the names of the mirroring historical tables. Explicitly states that `sourceTableName` is mirrored by history table `historyTableName`. The order in which tables are added with descriptor.addTableName() should still match the order in which mirroring historical tables are added with descriptor.addMirroringHistoryTableName().

public void addHistoryTableName(String sourceTableName, String historyTableName)

PUBLIC: Use to specify the names of the mirroring historical tables.

Explicitly states that sourceTableName is mirrored by history table historyTableName. The order in which tables are added with descriptor.addTableName() should still match the order in which mirroring historical tables are added with descriptor.addMirroringHistoryTableName().

additionalHistoryExpression	back to summary
public Expression additionalHistoryExpression(Expression context, Expression base) INTERNAL: Add any temporal querying conditions to this object expression.

additionalHistoryExpression	back to summary
public Expression additionalHistoryExpression(Expression context, Expression base, Integer tableIndex) INTERNAL: Add any temporal querying conditions to this object expression. Parameters tableIndex:Integer not null indicates that only expression for a single table should be returned.

additionalHistoryExpression

back to summary

public Expression additionalHistoryExpression(Expression context, Expression base, Integer tableIndex)

INTERNAL: Add any temporal querying conditions to this object expression.

Parameters

tableIndex:Integer: not null indicates that only expression for a single table should be returned.

addStartFieldName back to summary

addStartFieldName	back to summary
public void addStartFieldName(String startFieldName) PUBLIC: Sets the name of the start field. By default all tables belonging to a descriptor have the same primary key field names, and so the same start field names also. However, if `startFieldName` is qualified, i.e. of the form "EMPLOYEE_HIST.EMP_START", then this call will only set the start field name for a single historical table.

public void addStartFieldName(String startFieldName)

PUBLIC: Sets the name of the start field.

By default all tables belonging to a descriptor have the same primary key field names, and so the same start field names also.

However, if startFieldName is qualified, i.e. of the form "EMPLOYEE_HIST.EMP_START", then this call will only set the start field name for a single historical table.

checkWastedVersioning	back to summary
protected boolean checkWastedVersioning(AbstractRecord modifyRow, DatabaseTable table) INTERNAL: Checks for the case where an object has multiple tables but only some are part of a minimal update.

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. PUBLIC: Performs a sufficiently deep clone. Use to quickly setup standard policies on multiple descriptors. Returns:Object Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override

clone

back to summary

public Object clone()

Overrides java.lang.Object.clone.

PUBLIC: Performs a sufficiently deep clone. Use to quickly setup standard policies on multiple descriptors.

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

getCurrentTime	back to summary
public Object getCurrentTime(AbstractSession session) PUBLIC: Whenever a historical record is logically deleted (updated) or inserted, the end and start fields respectively will be set to this value.

getDescriptor	back to summary
public ClassDescriptor getDescriptor() PUBLIC: Return the descriptor of the policy.

getEnd	back to summary
protected DatabaseField getEnd() INTERNAL:

getEnd	back to summary
protected DatabaseField getEnd(int i) INTERNAL:

getEndFieldName	back to summary
public String getEndFieldName() PUBLIC:

getEndFields	back to summary
public List<DatabaseField> getEndFields() INTERNAL:

getHistoricalTables	back to summary
public final List<DatabaseTable> getHistoricalTables() INTERNAL:

getHistoryTableNames	back to summary
public List<String> getHistoryTableNames() PUBLIC:

getMapping	back to summary
public DatabaseMapping getMapping() PUBLIC:

getMinimumTimeIncrement	back to summary
public long getMinimumTimeIncrement(AbstractSession session) INTERNAL: Return a minimal time increment supported by the platform.

getStart	back to summary
protected DatabaseField getStart() INTERNAL:

getStart	back to summary
protected DatabaseField getStart(int i) INTERNAL:

getStartFieldName	back to summary
public String getStartFieldName() PUBLIC: Answers the name of the start field. Assumes that multiple tables for a descriptor have the same field names.

getStartFields	back to summary
public List<DatabaseField> getStartFields() INTERNAL:

initialize	back to summary
public void initialize(AbstractSession session) INTERNAL: Initialize a HistoryPolicy.

logicalDelete	back to summary
public void logicalDelete(ModifyQuery writeQuery, boolean isUpdate) INTERNAL: Performs a logical delete (update) on the historical schema.

logicalDelete	back to summary
public void logicalDelete(ModifyQuery writeQuery, boolean isUpdate, boolean isShallow) INTERNAL: Performs a logical delete (update) on the historical schema.

logicalInsert	back to summary
public void logicalInsert(ObjectLevelModifyQuery writeQuery, boolean isUpdate) INTERNAL: Perform a logical insert into the historical schema, creating a new version of an object. Called by postInsert() and also postUpdate() (which first does a logicalDelete of the previous version).

logicalInsert

back to summary

public void logicalInsert(ObjectLevelModifyQuery writeQuery, boolean isUpdate)

INTERNAL: Perform a logical insert into the historical schema, creating a new version of an object.

Called by postInsert() and also postUpdate() (which first does a logicalDelete of the previous version).

mappingLogicalDelete	back to summary
public void mappingLogicalDelete(ModifyQuery originalQuery, AbstractRecord arguments, AbstractSession session) INTERNAL: Performs a logical delete (update) on the historical schema. Direct collections and many to many mappings are maintained through the session events.

mappingLogicalInsert	back to summary
public void mappingLogicalInsert(DataModifyQuery originalQuery, AbstractRecord arguments, AbstractSession session) INTERNAL: Performs a logical insert into the historical schema. Direct collections and many to many mappings are maintained through the session events.

postDelete	back to summary
public void postDelete(ModifyQuery deleteQuery) INTERNAL:

postInsert	back to summary
public void postInsert(ObjectLevelModifyQuery writeQuery) INTERNAL:

postUpdate	back to summary
public void postUpdate(ObjectLevelModifyQuery writeQuery) INTERNAL:

postUpdate	back to summary
public void postUpdate(ObjectLevelModifyQuery writeQuery, boolean isShallow) INTERNAL:

setDescriptor	back to summary
public void setDescriptor(ClassDescriptor descriptor) PUBLIC:

setEndFields	back to summary
protected void setEndFields(List<DatabaseField> endFields) INTERNAL:

setEndFieldType back to summary

setEndFieldType	back to summary
public void setEndFieldType(String fieldName, Class<?> type) ADVANCED: See Also `setStartFieldType`

public void setEndFieldType(String fieldName, Class<?> type)

ADVANCED:

See Also: setStartFieldType

setHistoricalTables	back to summary
public void setHistoricalTables(List<DatabaseTable> historicalTables) INTERNAL:

setMapping	back to summary
public void setMapping(DatabaseMapping mapping) INTERNAL:

setShouldHandleWrites	back to summary
public void setShouldHandleWrites(boolean value) Sets if TopLink is responsible for writing history. If history is maintained via low level database triggers or application logic a policy is still needed for point in time querying. If Oracle flashback is used no HistoryPolicy is needed. Setting this to false lets you use History for many other applications. For instance a table that tracks available flights or hotel deals may benefit from a HistoryPolicy just to simplify temporal querying. If all hotel discounts have a start and end date, you could query on all discounts available at a certain date.

setShouldHandleWrites

back to summary

public void setShouldHandleWrites(boolean value)

Sets if TopLink is responsible for writing history.

If history is maintained via low level database triggers or application logic a policy is still needed for point in time querying.

If Oracle flashback is used no HistoryPolicy is needed.

Setting this to false lets you use History for many other applications. For instance a table that tracks available flights or hotel deals may benefit from a HistoryPolicy just to simplify temporal querying.

If all hotel discounts have a start and end date, you could query on all discounts available at a certain date.

setShouldUseDatabaseTime	back to summary
public void setShouldUseDatabaseTime(boolean value) Sets if the Timestamp used in maintainaing history should be the current time according to the database. Parameters value:boolean if false uses localTime (default) instead

setShouldUseDatabaseTime

back to summary

public void setShouldUseDatabaseTime(boolean value)

Sets if the Timestamp used in maintainaing history should be the current time according to the database.

Parameters

value:boolean: if false uses localTime (default) instead

setStartFields	back to summary
protected void setStartFields(List<DatabaseField> startFields) INTERNAL:

setStartFieldType	back to summary
public void setStartFieldType(Class<?> type) ADVANCED: Sets the type of all start fields. Not required to be set as the default of Timestamp is assumed.

shouldHandleWrites back to summary

public boolean shouldHandleWrites()

Answers if TopLink is responsible for writing history.

If history is maintained via low level database triggers or application logic a policy is still usefull for point in time querying.

If Oracle flashback is used no HistoryPolicy is needed.

Returns:boolean: true by default
See Also: setShouldHandleWrites

shouldUseDatabaseTime back to summary

public boolean shouldUseDatabaseTime()

Answers if the Timestamp used in maintaining history should be the current time according to the database.

Returns:boolean: false by default
See Also: shouldUseLocalTime, useDatabaseTime

shouldUseLocalTime back to summary

public boolean shouldUseLocalTime()

Answers if the Timestamp used in maintaining history should be System.currentTimeMillis();

Returns:boolean: true by default
See Also: shouldUseDatabaseTime, useLocalTime

useDatabaseTime back to summary

public void useDatabaseTime()

Answers if the Timestamp used in maintaining history should be the current time according to the database.

See Also: useLocalTime, shouldUseDatabaseTime

useLocalTime back to summary

public void useLocalTime()

Answers if the Timestamp used in maintaining history should be System.currentTimeMillis();

See Also: useDatabaseTime, shouldUseLocalTime

verifyTableQualifiers

back to summary

protected void verifyTableQualifiers(DatasourcePlatform platform)

INTERNAL: Check that the qualifiers on the historical tables are properly set.

A similar method exists on ClassDescriptor.

public Class HistoryPolicy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail