net.sf.jailer.entitygraph

Class EntityGraph

java.lang.Object

net.sf.jailer.entitygraph.EntityGraph

Direct Known Subclasses:

LocalEntityGraph, RemoteEntityGraph

public abstract class EntityGraph
extends Object

Persistent graph of entities.

Author:

Ralf Wisser

Field Summary

Fields

Modifier and Type	Field and Description
DataModel	dataModel
static String	DEPENDENCY Name of the dependency-table.
static String	ENTITY Name of the entity-table.
static String	ENTITY_GRAPH Name of the graph-table.
static String	ENTITY_SET_ELEMENT Name of the (helper) set-table.
protected ExecutionContext	executionContext The execution context.
Map<Association,Integer>	explainIdOfAssociation Unique IDs for each association to be used for explanation.
int	graphID The unique ID of the graph.
protected ImportFilterManager	importFilterManager The ImportFilterManager.
protected boolean	inDeleteMode
static long	maxTotalRowcount

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityGraph(int graphID, DataModel dataModel, ExecutionContext executionContext)

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addDependencies(Table from, String fromAlias, Table to, String toAlias, String condition, int aggregationId, int dependencyId, boolean isAssociationReversed) Adds dependencies.
abstract long	addEntities(Table table, String condition, int today) Adds entities to the graph.
abstract void	close() Closes the graph.
abstract EntityGraph	copy(int graphID, Session session) Copies an entity-graph.
abstract long	countEntities(Table table) Counts the entities of a given table in this graph.
static int	createUniqueGraphID() Creates a unique ID for a new graph.
abstract void	delete() Deletes the graph.
abstract long	deleteEntities(Table table) Deletes all entities from a given table.
abstract void	deleteIndependentEntities(Table table) Deletes all entities which are marked as independent.
protected String	dmlTableReference(String tableName, Session session) Gets table reference for DML statements for a given working table.
void	dropMappingTables(OutputStreamWriter result, DBMS targetDBMSConfiguration) Creates the DROP-statements for the mapping tables.
void	fillAndWriteMappingTables(JobManager jobManager, OutputStreamWriter dmlResultWriter, int numberOfEntities, Session targetSession, DBMS targetDBMSConfiguration, DBMS dbmsConfiguration) Insert the values of columns with non-derived-import-filters into the local database.
abstract EntityGraph	find(int graphID, Session session, PrimaryKey universalPrimaryKey) Finds an entity-graph.
abstract int	getAge() Gets the age of the graph.
abstract DataModel	getDatamodel()
abstract Set<Integer>	getDistinctDependencyIDs() Gets distinct association-ids of all edged.
ImportFilterManager	getImportFilterManager() Gets the ImportFilterManager
abstract Session	getSession() Gets the session.
abstract long	getSize() Gets the number of entities in the graph.
long	getSize(Set<Table> tables) Gets the number of entities form given tables in the graph.
abstract Session	getTargetSession()
abstract long	getTotalRowcount() Gets total row-count.
TransformerFactory	getTransformerFactory() Gets the TransformerFactory.
abstract PrimaryKey	getUniversalPrimaryKey() Gets the universal primary key.
int	incLobCount() Increments lob-counter and returns new value.
abstract void	markDependentEntitiesAsTraversed(Association association, ResultSet resultSet, ResultSetMetaData resultSetMetaData, Map<String,Integer> typeCache) Marks all entities which depends on given entity as traversed.
abstract void	markIndependentEntities(Table table) Marks all entities of a given table which don't dependent on other entities, s.t. they can be read and deleted.
abstract void	markRoots(Table table) Marks all rows which are not target of a dependency.
abstract void	readDependentEntities(Table table, Association association, ResultSet resultSet, ResultSetMetaData resultSetMetaData, Session.ResultSetReader reader, Map<String,Integer> typeCache, String selectionSchema, String originalPKAliasPrefix) Reads all entities which depends on given entity.
abstract void	readEntities(Table table, boolean orderByPK) Reads all entities of a given table.
abstract void	readMarkedEntities(Table table, boolean orderByPK) Reads all entities of a given table which are marked as independent or as roots.
abstract void	readMarkedEntities(Table table, Session.ResultSetReader reader, String selectionSchema, String originalPKAliasPrefix, boolean orderByPK) Reads all entities of a given table which are marked as independent or as roots.
abstract void	readNonTraversedDependencies(Table table, Session.ResultSetReader reader) Reads all non-traversed dependencies.
abstract long	readUnfilteredEntityColumns(Table table, List<Column> columns, Session.ResultSetReader reader) Reads some columns of all entities of a given table without using filters.
abstract long	removeAssociatedDestinations(Association association, boolean deletedEntitiesAreMarked) Removes all entities from this graph which are associated with an entity outside the graph.
void	removeDependencies(Association association) Removes all dependencies for a given association.
abstract void	removeReflexiveDependencies(Table table) Removes all reflexive dependencies of given table.
abstract long	resolveAssociation(Table table, Association association, int today) Resolves an association.
abstract void	setAge(int age) Sets the age of the graph.
abstract void	setBirthdayOfSubject(int birthdayOfSubject) Sets birthday of subject rows.
void	setDeleteMode(boolean deleteMode)
abstract void	setExplain(boolean explain) Whether or not to store additional information in order to create a 'explain.log'.
void	setImportFilterManager(ImportFilterManager importFilterManager) Sets the ImportFilterManager
void	setTransformerFactory(TransformerFactory transformerFactory) Sets the TransformerFactory.
abstract void	shutDown() Shuts down statement-executor.
protected int	typeName(Table table)
abstract void	uniteWith(EntityGraph graph) Unites the graph with another one and deletes the other graph.
abstract void	updateEntities(Table table, Set<Column> columns, OutputStreamWriter scriptFileWriter, DBMS targetConfiguration) Updates columns of a table.

Methods inherited from class java.lang.Object

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

Field Detail

ENTITY_GRAPH

public static final String ENTITY_GRAPH

Name of the graph-table.

See Also:

Constant Field Values

ENTITY_SET_ELEMENT

public static final String ENTITY_SET_ELEMENT

Name of the (helper) set-table.

See Also:

Constant Field Values

ENTITY

public static final String ENTITY

Name of the entity-table.

See Also:

Constant Field Values

DEPENDENCY

public static final String DEPENDENCY

Name of the dependency-table.

See Also:

Constant Field Values

dataModel

public final DataModel dataModel

executionContext

protected final ExecutionContext executionContext

The execution context.

inDeleteMode

protected boolean inDeleteMode

graphID

public final int graphID

The unique ID of the graph.

explainIdOfAssociation

public Map<Association,Integer> explainIdOfAssociation

Unique IDs for each association to be used for explanation.

maxTotalRowcount

public static long maxTotalRowcount

importFilterManager

protected ImportFilterManager importFilterManager

The ImportFilterManager.

Constructor Detail

EntityGraph

protected EntityGraph(int graphID,
           DataModel dataModel,
           ExecutionContext executionContext)

Method Detail

setBirthdayOfSubject

public abstract void setBirthdayOfSubject(int birthdayOfSubject)

Sets birthday of subject rows.

Parameters:

birthdayOfSubject - birthday of subject rows

copy

public abstract EntityGraph copy(int graphID,
               Session session)
                          throws SQLException

Copies an entity-graph.

Parameters:

graph - the graph to copy

graphID - the unique ID of the graph

session - for executing SQL-Statements

Returns:

the newly created entity-graph

Throws:

Exception

SQLException

find

public abstract EntityGraph find(int graphID,
               Session session,
               PrimaryKey universalPrimaryKey)
                          throws SQLException,
                                 Exception

Finds an entity-graph.

Parameters:

graphID - the unique ID of the graph

universalPrimaryKey - the universal primary key

session - for executing SQL-Statements

Returns:

the entity-graph

Throws:

Exception

SQLException

getAge

public abstract int getAge()
                    throws SQLException

Gets the age of the graph.

Returns:

the age of the graph

Throws:

SQLException

setAge

public abstract void setAge(int age)
                     throws SQLException

Sets the age of the graph.

Parameters:

age - the age of the graph

Throws:

SQLException

getSize

public abstract long getSize()
                      throws SQLException

Gets the number of entities in the graph.

Returns:

the number of entities in the graph

Throws:

SQLException

getSize

public long getSize(Set<Table> tables)
             throws SQLException

Gets the number of entities form given tables in the graph.

Returns:

the number of entities in the graph

Throws:

SQLException

delete

public abstract void delete()
                     throws SQLException

Deletes the graph.

Throws:

SQLException

addEntities

public abstract long addEntities(Table table,
               String condition,
               int today)
                          throws SQLException

Adds entities to the graph.

Parameters:

table - the table

condition - the condition in SQL that the entities must fulfill

today - the birthday of the new entities

Returns:

row-count

Throws:

SQLException

resolveAssociation

public abstract long resolveAssociation(Table table,
                      Association association,
                      int today)
                                 throws SQLException

Resolves an association. Retrieves and adds all entities associated with an entity born yesterday in the graph and adds the dependencies.

Parameters:

table - the table

association - the association to resolve

today - the birthday of the new entities

Returns:

row-count or -1, if association is ignored

Throws:

SQLException

addDependencies

public abstract void addDependencies(Table from,
                   String fromAlias,
                   Table to,
                   String toAlias,
                   String condition,
                   int aggregationId,
                   int dependencyId,
                   boolean isAssociationReversed)
                              throws SQLException

Adds dependencies.

Parameters:

from - source of dependency

fromAlias - alias for from-table

to - destination of dependency

toAlias - alias for to-table

condition - condition of dependency

aggregationId - id of aggregation association (for XML export), 0 if not applicable

dependencyId - id of dependency

Throws:

SQLException

getDistinctDependencyIDs

public abstract Set<Integer> getDistinctDependencyIDs()
                                               throws SQLException

Gets distinct association-ids of all edged.

Throws:

SQLException

markIndependentEntities

public abstract void markIndependentEntities(Table table)
                                      throws SQLException

Marks all entities of a given table which don't dependent on other entities, s.t. they can be read and deleted.

Throws:

SQLException

markRoots

public abstract void markRoots(Table table)
                        throws SQLException

Marks all rows which are not target of a dependency.

Throws:

SQLException

readMarkedEntities

public abstract void readMarkedEntities(Table table,
                      boolean orderByPK)
                                 throws SQLException

Reads all entities of a given table which are marked as independent or as roots.

Parameters:

table - the table

orderByPK - if true, result will be ordered by primary keys

Throws:

SQLException

readMarkedEntities

public abstract void readMarkedEntities(Table table,
                      Session.ResultSetReader reader,
                      String selectionSchema,
                      String originalPKAliasPrefix,
                      boolean orderByPK)
                                 throws SQLException

Reads all entities of a given table which are marked as independent or as roots.

Parameters:

reader - for reading the result-set

table - the table

orderByPK - if true, result will be ordered by primary keys

Throws:

SQLException

uniteWith

public abstract void uniteWith(EntityGraph graph)
                        throws SQLException

Unites the graph with another one and deletes the other graph.

Parameters:

graph - the graph to be united with this graph

Throws:

SQLException

readEntities

public abstract void readEntities(Table table,
                boolean orderByPK)
                           throws SQLException

Reads all entities of a given table.

Parameters:

table - the table

orderByPK - if true, result will be ordered by primary keys

Throws:

SQLException

updateEntities

public abstract void updateEntities(Table table,
                  Set<Column> columns,
                  OutputStreamWriter scriptFileWriter,
                  DBMS targetConfiguration)
                             throws SQLException

Updates columns of a table.

Parameters:

table - the table

columns - the columns;

Throws:

SQLException

readUnfilteredEntityColumns

public abstract long readUnfilteredEntityColumns(Table table,
                               List<Column> columns,
                               Session.ResultSetReader reader)
                                          throws SQLException

Reads some columns of all entities of a given table without using filters.

Parameters:

table - the table

columns - the columns

reader - to read

Throws:

SQLException

deleteIndependentEntities

public abstract void deleteIndependentEntities(Table table)
                                        throws SQLException

Deletes all entities which are marked as independent.

Throws:

SQLException

deleteEntities

public abstract long deleteEntities(Table table)
                             throws SQLException

Deletes all entities from a given table.

Throws:

SQLException

countEntities

public abstract long countEntities(Table table)
                            throws SQLException

Counts the entities of a given table in this graph.

Parameters:

table - the table

Returns:

the number of entities from table in this graph

Throws:

SQLException

removeAssociatedDestinations

public abstract long removeAssociatedDestinations(Association association,
                                boolean deletedEntitiesAreMarked)
                                           throws SQLException

Removes all entities from this graph which are associated with an entity outside the graph.

Parameters:

deletedEntitiesAreMarked - if true, consider entity as deleted if its birthday is negative

association - the association

Returns:

number of removed entities

Throws:

SQLException

readDependentEntities

public abstract void readDependentEntities(Table table,
                         Association association,
                         ResultSet resultSet,
                         ResultSetMetaData resultSetMetaData,
                         Session.ResultSetReader reader,
                         Map<String,Integer> typeCache,
                         String selectionSchema,
                         String originalPKAliasPrefix)
                                    throws SQLException

Reads all entities which depends on given entity.

Parameters:

table - the table from which to read entities

association - the dependency

resultSet - current row is given entity

reader - reads the entities

selectionSchema - the selection schema

Throws:

SQLException

markDependentEntitiesAsTraversed

public abstract void markDependentEntitiesAsTraversed(Association association,
                                    ResultSet resultSet,
                                    ResultSetMetaData resultSetMetaData,
                                    Map<String,Integer> typeCache)
                                               throws SQLException

Marks all entities which depends on given entity as traversed.

Parameters:

table - the table from which to read entities

association - the dependency

resultSet - current row is given entity

Throws:

SQLException

readNonTraversedDependencies

public abstract void readNonTraversedDependencies(Table table,
                                Session.ResultSetReader reader)
                                           throws SQLException

Reads all non-traversed dependencies.

Parameters:

table - the source of dependencies to look for

reader - reads the entities

Throws:

SQLException

removeReflexiveDependencies

public abstract void removeReflexiveDependencies(Table table)
                                          throws SQLException

Removes all reflexive dependencies of given table.

Parameters:

table - the table

Throws:

SQLException

getTotalRowcount

public abstract long getTotalRowcount()

Gets total row-count.

Returns:

total row-count

setExplain

public abstract void setExplain(boolean explain)

Whether or not to store additional information in order to create a 'explain.log'.

Parameters:

explain - true iff predecessors of each entity must be stored

getUniversalPrimaryKey

public abstract PrimaryKey getUniversalPrimaryKey()

Gets the universal primary key.

Returns:

the universal primary key

shutDown

public abstract void shutDown()
                       throws SQLException

Shuts down statement-executor.

Throws:

SQLException

getSession

public abstract Session getSession()

Gets the session.

Returns:

the session

createUniqueGraphID

public static int createUniqueGraphID()

Creates a unique ID for a new graph.

Returns:

a unique ID

incLobCount

public int incLobCount()

Increments lob-counter and returns new value.

getDatamodel

public abstract DataModel getDatamodel()

close

public abstract void close()
                    throws SQLException

Closes the graph. Deletes the local database.

Throws:

SQLException

removeDependencies

public void removeDependencies(Association association)
                        throws SQLException

Removes all dependencies for a given association.

Parameters:

association - the asociation

Throws:

SQLException

getTargetSession

public abstract Session getTargetSession()

setDeleteMode

public void setDeleteMode(boolean deleteMode)

typeName

protected int typeName(Table table)

setTransformerFactory

public void setTransformerFactory(TransformerFactory transformerFactory)

Sets the TransformerFactory.

Parameters:

transformerFactory - the factory

getTransformerFactory

public TransformerFactory getTransformerFactory()

Gets the TransformerFactory.

Returns:

the factory

setImportFilterManager

public void setImportFilterManager(ImportFilterManager importFilterManager)

Sets the ImportFilterManager

Parameters:

importFilterManager - the ImportFilterManager

getImportFilterManager

public ImportFilterManager getImportFilterManager()

Gets the ImportFilterManager

Returns:

the ImportFilterManager

fillAndWriteMappingTables

public void fillAndWriteMappingTables(JobManager jobManager,
                             OutputStreamWriter dmlResultWriter,
                             int numberOfEntities,
                             Session targetSession,
                             DBMS targetDBMSConfiguration,
                             DBMS dbmsConfiguration)
                               throws SQLException,
                                      IOException

Insert the values of columns with non-derived-import-filters into the local database.

Throws:

SQLException

IOException

dropMappingTables

public void dropMappingTables(OutputStreamWriter result,
                     DBMS targetDBMSConfiguration)
                       throws IOException,
                              SQLException

Creates the DROP-statements for the mapping tables.

Throws:

IOException

SQLException

dmlTableReference

protected String dmlTableReference(String tableName,
                       Session session)
                            throws SQLException

Gets table reference for DML statements for a given working table.

Parameters:

tableName - the working table

session - holds connection to DBMS

Returns:

table reference for the working table

Throws:

SQLException