com.goldencode.p2j.convert.db

Class LoggedCollection

java.lang.Object

com.goldencode.p2j.convert.db.LoggedCollection

public class LoggedCollection
extends java.lang.Object

Log all changes to a specified collection, by keeping track of the source AST which made this change.

On incremental conversion, this allows restoration of the collection's state, without the currently parsed and converted ASTs.

All changes are stored in a work table, which has the same name as the main collection's table, followed by a __work suffix.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	LoggedCollection.AstKey A key for a logged change, in a collection.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<LoggedCollection.AstKey,java.lang.Object>	changes The changes made to this collection.
private java.util.Map<LoggedCollection.AstKey,java.lang.Object>	forced Force certain values to be logged for a source AST.

Constructor Summary

Constructors

Constructor and Description
LoggedCollection()

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all changes.
void	compact(long fileId, java.util.function.Consumer<CustomExternalizable> c) Compact the elements of this collection, to reduce the memory footprint.
void	force(long fileId, long astId, java.lang.Object key, java.lang.Object value) Force a change to be logged for the specified source AST.
void	log(long fileId, long astId, java.lang.Object key) Log this change being made to the collection.
void	log(long fileId, long astId, java.lang.Object key, java.lang.Object value) Log this change being made to the collection.
void	persist(java.sql.PreparedStatement ps, java.util.function.BiFunction<LoggedCollection.AstKey,java.lang.Object,java.lang.Object[]> c) Persist all changes to the database, using the specified statement.
void	persist(java.lang.String insertSql, DBHelper helper, java.util.function.BiFunction<LoggedCollection.AstKey,java.lang.Object,java.lang.Object[]> c) Persist all changes to the database.
void	remove(java.lang.Object key) Remove all changes having this key.
void	retainAll(java.util.Set<?> keys) Given a set of keys, retain from the changes only those for which the key exists in this set.

Methods inherited from class java.lang.Object

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

Field Detail

changes

private final java.util.Map<LoggedCollection.AstKey,java.lang.Object> changes

The changes made to this collection. The value may be null in case the collection is not a map.

forced

private final java.util.Map<LoggedCollection.AstKey,java.lang.Object> forced

Force certain values to be logged for a source AST. This allows to identify cases where the map already has a key and a value, but the source AST must keep a different value for this key, even if the values are (almost) identical.

Constructor Detail

LoggedCollection

public LoggedCollection()

Method Detail

log

public void log(long fileId,
                long astId,
                java.lang.Object key,
                java.lang.Object value)

Log this change being made to the collection.

Parameters:

fileId - The AST file ID.

astId - The source AST ID.

key - The collection key.

value - The value, which is non-null only for maps.

log

public void log(long fileId,
                long astId,
                java.lang.Object key)

Log this change being made to the collection.

Parameters:

fileId - The AST file ID.

astId - The source AST ID.

key - The collection key.

force

public void force(long fileId,
                  long astId,
                  java.lang.Object key,
                  java.lang.Object value)

Force a change to be logged for the specified source AST.

Parameters:

fileId - The AST file ID.

astId - The source AST ID.

key - The collection key.

value - The value, which is non-null only for maps.

remove

public void remove(java.lang.Object key)

Remove all changes having this key.

Parameters:

key - The key to be removed.

retainAll

public void retainAll(java.util.Set<?> keys)

Given a set of keys, retain from the changes only those for which the key exists in this set.

This allows the changes to be 'in sync' with the main collection, as certain remove operations on the main collection may not have been logged to the collection.

Parameters:

keys - The keys which need to be retained.

clear

public void clear()

Clear all changes.

persist

public void persist(java.lang.String insertSql,
                    DBHelper helper,
                    java.util.function.BiFunction<LoggedCollection.AstKey,java.lang.Object,java.lang.Object[]> c)

Persist all changes to the database.

Parameters:

insertSql - The SQL used to insert into the table.

helper - The helper to perform SQL operations.

c - A consumer to resolve the arguments for the insert statement.

persist

public void persist(java.sql.PreparedStatement ps,
                    java.util.function.BiFunction<LoggedCollection.AstKey,java.lang.Object,java.lang.Object[]> c)
             throws java.sql.SQLException

Persist all changes to the database, using the specified statement.

Parameters:

ps - The prepared insert statement.

c - A consumer to resolve the arguments for the insert statement.

Throws:

java.sql.SQLException - For SQL-related errors when setting the statement arguments.

compact

public void compact(long fileId,
                    java.util.function.Consumer<CustomExternalizable> c)

Compact the elements of this collection, to reduce the memory footprint.

Parameters:

fileId - The AST file ID which has finished processing.

c - A consumer to process the values.