LocalEntityGraph (Jailer Subsetter API)

java.lang.Object
- net.sf.jailer.entitygraph.EntityGraph
- - net.sf.jailer.entitygraph.local.LocalEntityGraph

```
public class LocalEntityGraph
extends EntityGraph
```
Persistent graph of entities. Persists the graph in a local database.

Author:

Ralf Wisser

Field Summary
- Fields inherited from class net.sf.jailer.entitygraph.EntityGraph
  dataModel, DEPENDENCY, ENTITY, ENTITY_GRAPH, ENTITY_SET_ELEMENT, executionContext, explainIdOfAssociation, graphID, importFilterManager, inDeleteMode, maxTotalRowcount

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addDependencies(Table from, String fromAlias, Table to, String toAlias, String condition, int aggregationId, int dependencyId, boolean isAssociationReversed)` Adds dependencies.
`long`	`addEntities(Table table, String condition, int today)` Adds entities to the graph.
`void`	`close()` Closes the graph.
`EntityGraph`	`copy(int newGraphID, Session globalSession)` Copies an entity-graph.
`long`	`countEntities(Table table)` Counts the entities of a given table in this graph.
`static LocalEntityGraph`	`create(DataModel dataModel, int graphID, Session remoteSession, ExecutionContext executionContext)` Creates a new entity-graph.
`void`	`delete()` Deletes the graph.
`long`	`deleteEntities(Table table)` Deletes all entities from a given table.
`void`	`deleteIndependentEntities(Table table)` Deletes all entities which are marked as independent.
`EntityGraph`	`find(int graphID, Session localSession, PrimaryKey universalPrimaryKey)` Finds an entity-graph.
`int`	`getAge()` Gets the age of the graph.
`DataModel`	`getDatamodel()`
`Set<Integer>`	`getDistinctDependencyIDs()` Gets distinct association-ids of all edged.
`Session`	`getSession()` Gets the session.
`long`	`getSize()` Gets the number of entities in the graph.
`Session`	`getTargetSession()`
`long`	`getTotalRowcount()` Gets total row-count.
`PrimaryKey`	`getUniversalPrimaryKey()` Gets the universal primary key.
`void`	`markDependentEntitiesAsTraversed(Association association, ResultSet resultSet, ResultSetMetaData resultSetMetaData, Map<String,Integer> typeCache)` Marks all entities which depends on given entity as traversed.
`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.
`void`	`markRoots(Table table)` Marks all rows which are not target of a dependency.
`void`	`readDependentEntities(Table table, Association association, ResultSet resultSet, ResultSetMetaData resultSetMetaData, Session.ResultSetReader reader, Map<String,Integer> theTypeCache, String selectionSchema, String originalPKAliasPrefix)` Reads all entities which depends on given entity.
`void`	`readEntities(Table table, boolean orderByPK)` Reads all entities of a given table.
`void`	`readMarkedEntities(Table table, boolean orderByPK)` Reads all entities of a given table which are marked as independent or as roots.
`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.
`void`	`readNonTraversedDependencies(Table table, Session.ResultSetReader reader)` Reads all non-traversed dependencies.
`long`	`readUnfilteredEntityColumns(Table table, List<Column> columns, Session.ResultSetReader reader)` Reads some columns of all entities of a given table without using filters.
`long`	`removeAssociatedDestinations(Association association, boolean deletedEntitiesAreMarked)` Removes all entities from this graph which are associated with an entity outside the graph.
`void`	`removeReflexiveDependencies(Table table)` Removes all reflexive dependencies of given table.
`long`	`resolveAssociation(Table table, Association association, int today)` Resolves an association.
`void`	`setAge(int age)` Sets the age of the graph.
`void`	`setBirthdayOfSubject(int birthdayOfSubject)` Sets birthday of subject rows.
`void`	`setExplain(boolean explain)` Whether or not to store additional information in order to create a 'explain.log'.
`void`	`shutDown()` Shuts down statement-executor.
`void`	`uniteWith(EntityGraph graph)` Unites the graph with another one and deletes the other graph.
`void`	`updateEntities(Table table, Set<Column> columns, OutputStreamWriter scriptFileWriter, DBMS targetConfiguration)` Updates columns of a table.

Methods inherited from class net.sf.jailer.entitygraph.EntityGraph
createUniqueGraphID, dmlTableReference, dropMappingTables, fillAndWriteMappingTables, getImportFilterManager, getSize, getTransformerFactory, incLobCount, removeDependencies, setDeleteMode, setImportFilterManager, setTransformerFactory, typeName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - close
```
public void close()
           throws SQLException
```
    Closes the graph. Deletes the local database.
    
    Specified by:
    
    close in class EntityGraph
    
    Throws:
    
    SQLException
  - setBirthdayOfSubject
```
public void setBirthdayOfSubject(int birthdayOfSubject)
```
    Sets birthday of subject rows.
    
    Specified by:
    
    setBirthdayOfSubject in class EntityGraph
    
    Parameters:
    birthdayOfSubject - birthday of subject rows
  - create
```
public static LocalEntityGraph create(DataModel dataModel,
                      int graphID,
                      Session remoteSession,
                      ExecutionContext executionContext)
                               throws IOException,
                                      SQLException
```
    Creates a new entity-graph.
    
    Parameters:
    graphID - the unique ID of the graph
    remoteSession - for executing SQL-Statements
    universalPrimaryKey - the universal primary key
    
    Returns:
    the newly created entity-graph
    
    Throws:
    
    IOException
    
    SQLException
  - copy
```
public EntityGraph copy(int newGraphID,
               Session globalSession)
                 throws SQLException
```
    Copies an entity-graph.
    
    Specified by:
    
    copy in class EntityGraph
    
    Parameters:
    newGraphID - the unique ID of the new graph
    localSession - for executing SQL-Statements
    
    Returns:
    the newly created entity-graph
    
    Throws:
    
    SQLException
  - find
```
public EntityGraph find(int graphID,
               Session localSession,
               PrimaryKey universalPrimaryKey)
                 throws IOException,
                        SQLException
```
    Finds an entity-graph.
    
    Specified by:
    
    find in class EntityGraph
    
    Parameters:
    graphID - the unique ID of the graph
    universalPrimaryKey - the universal primary key
    localSession - for executing SQL-Statements
    
    Returns:
    the entity-graph
    
    Throws:
    
    IOException
    
    SQLException
  - getAge
```
public int getAge()
           throws SQLException
```
    Gets the age of the graph.
    
    Specified by:
    
    getAge in class EntityGraph
    
    Returns:
    the age of the graph
    
    Throws:
    
    SQLException
  - setAge
```
public void setAge(int age)
            throws SQLException
```
    Sets the age of the graph.
    
    Specified by:
    
    setAge in class EntityGraph
    
    Parameters:
    age - the age of the graph
    
    Throws:
    
    SQLException
  - getSize
```
public long getSize()
             throws SQLException
```
    Gets the number of entities in the graph.
    
    Specified by:
    
    getSize in class EntityGraph
    
    Returns:
    the number of entities in the graph
    
    Throws:
    
    SQLException
  - delete
```
public void delete()
            throws SQLException
```
    Deletes the graph.
    
    Specified by:
    
    delete in class EntityGraph
    
    Throws:
    
    SQLException
  - addEntities
```
public long addEntities(Table table,
               String condition,
               int today)
                 throws SQLException
```
    Adds entities to the graph.
    
    Specified by:
    
    addEntities in class EntityGraph
    
    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 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.
    
    Specified by:
    
    resolveAssociation in class EntityGraph
    
    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 void addDependencies(Table from,
                   String fromAlias,
                   Table to,
                   String toAlias,
                   String condition,
                   int aggregationId,
                   int dependencyId,
                   boolean isAssociationReversed)
                     throws SQLException
```
    Adds dependencies.
    
    Specified by:
    
    addDependencies in class EntityGraph
    
    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 Set<Integer> getDistinctDependencyIDs()
                                      throws SQLException
```
    Gets distinct association-ids of all edged.
    
    Specified by:
    
    getDistinctDependencyIDs in class EntityGraph
    
    Throws:
    
    SQLException
  - markIndependentEntities
```
public 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.
    
    Specified by:
    
    markIndependentEntities in class EntityGraph
    
    Throws:
    
    SQLException
  - markRoots
```
public void markRoots(Table table)
               throws SQLException
```
    Marks all rows which are not target of a dependency.
    
    Specified by:
    
    markRoots in class EntityGraph
    
    Throws:
    
    SQLException
  - readMarkedEntities
```
public void readMarkedEntities(Table table,
                      boolean orderByPK)
                        throws SQLException
```
    Reads all entities of a given table which are marked as independent or as roots.
    
    Specified by:
    
    readMarkedEntities in class EntityGraph
    
    Parameters:
    table - the table
    orderByPK - if true, result will be ordered by primary keys
    
    Throws:
    
    SQLException
  - readMarkedEntities
```
public 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.
    
    Specified by:
    
    readMarkedEntities in class EntityGraph
    
    Parameters:
    reader - for reading the result-set
    table - the table
    orderByPK - if true, result will be ordered by primary keys
    
    Throws:
    
    SQLException
  - uniteWith
```
public void uniteWith(EntityGraph graph)
               throws SQLException
```
    Unites the graph with another one and deletes the other graph.
    
    Specified by:
    
    uniteWith in class EntityGraph
    
    Parameters:
    graph - the graph to be united with this graph
    
    Throws:
    
    SQLException
  - readEntities
```
public void readEntities(Table table,
                boolean orderByPK)
                  throws SQLException
```
    Reads all entities of a given table.
    
    Specified by:
    
    readEntities in class EntityGraph
    
    Parameters:
    table - the table
    orderByPK - if true, result will be ordered by primary keys
    
    Throws:
    
    SQLException
  - readUnfilteredEntityColumns
```
public 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.
    
    Specified by:
    
    readUnfilteredEntityColumns in class EntityGraph
    
    Parameters:
    table - the table
    columns - the columns
    reader - to read
    
    Throws:
    
    SQLException
  - updateEntities
```
public void updateEntities(Table table,
                  Set<Column> columns,
                  OutputStreamWriter scriptFileWriter,
                  DBMS targetConfiguration)
                    throws SQLException
```
    Updates columns of a table.
    
    Specified by:
    
    updateEntities in class EntityGraph
    
    Parameters:
    table - the table
    columns - the columns;
    
    Throws:
    
    SQLException
  - deleteIndependentEntities
```
public void deleteIndependentEntities(Table table)
                               throws SQLException
```
    Deletes all entities which are marked as independent.
    
    Specified by:
    
    deleteIndependentEntities in class EntityGraph
    
    Throws:
    
    SQLException
  - deleteEntities
```
public long deleteEntities(Table table)
                    throws SQLException
```
    Deletes all entities from a given table.
    
    Specified by:
    
    deleteEntities in class EntityGraph
    
    Throws:
    
    SQLException
  - countEntities
```
public long countEntities(Table table)
                   throws SQLException
```
    Counts the entities of a given table in this graph.
    
    Specified by:
    
    countEntities in class EntityGraph
    
    Parameters:
    table - the table
    
    Returns:
    the number of entities from table in this graph
    
    Throws:
    
    SQLException
  - removeAssociatedDestinations
```
public long removeAssociatedDestinations(Association association,
                                boolean deletedEntitiesAreMarked)
                                  throws SQLException
```
    Removes all entities from this graph which are associated with an entity outside the graph.
    
    Specified by:
    
    removeAssociatedDestinations in class EntityGraph
    
    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 void readDependentEntities(Table table,
                         Association association,
                         ResultSet resultSet,
                         ResultSetMetaData resultSetMetaData,
                         Session.ResultSetReader reader,
                         Map<String,Integer> theTypeCache,
                         String selectionSchema,
                         String originalPKAliasPrefix)
                           throws SQLException
```
    Reads all entities which depends on given entity.
    
    Specified by:
    
    readDependentEntities in class EntityGraph
    
    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 void markDependentEntitiesAsTraversed(Association association,
                                    ResultSet resultSet,
                                    ResultSetMetaData resultSetMetaData,
                                    Map<String,Integer> typeCache)
                                      throws SQLException
```
    Marks all entities which depends on given entity as traversed.
    
    Specified by:
    
    markDependentEntitiesAsTraversed in class EntityGraph
    
    Parameters:
    table - the table from which to read entities
    association - the dependency
    resultSet - current row is given entity
    
    Throws:
    
    SQLException
  - readNonTraversedDependencies
```
public void readNonTraversedDependencies(Table table,
                                Session.ResultSetReader reader)
                                  throws SQLException
```
    Reads all non-traversed dependencies.
    
    Specified by:
    
    readNonTraversedDependencies in class EntityGraph
    
    Parameters:
    table - the source of dependencies to look for
    reader - reads the entities
    
    Throws:
    
    SQLException
  - removeReflexiveDependencies
```
public void removeReflexiveDependencies(Table table)
                                 throws SQLException
```
    Removes all reflexive dependencies of given table.
    
    Specified by:
    
    removeReflexiveDependencies in class EntityGraph
    
    Parameters:
    table - the table
    
    Throws:
    
    SQLException
  - getTotalRowcount
```
public long getTotalRowcount()
```
    Gets total row-count.
    
    Specified by:
    
    getTotalRowcount in class EntityGraph
    
    Returns:
    total row-count
  - setExplain
```
public void setExplain(boolean explain)
```
    Whether or not to store additional information in order to create a 'explain.log'.
    
    Specified by:
    
    setExplain in class EntityGraph
    
    Parameters:
    explain - true iff predecessors of each entity must be stored
  - getUniversalPrimaryKey
```
public PrimaryKey getUniversalPrimaryKey()
```
    Gets the universal primary key.
    
    Specified by:
    
    getUniversalPrimaryKey in class EntityGraph
    
    Returns:
    the universal primary key
  - shutDown
```
public void shutDown()
              throws SQLException
```
    Shuts down statement-executor.
    
    Specified by:
    
    shutDown in class EntityGraph
    
    Throws:
    
    SQLException
  - getSession
```
public Session getSession()
```
    Description copied from class: EntityGraph
    
    Gets the session.
    
    Specified by:
    
    getSession in class EntityGraph
    
    Returns:
    the session
  - getDatamodel
```
public DataModel getDatamodel()
```
    Specified by:
    
    getDatamodel in class EntityGraph
  - getTargetSession
```
public Session getTargetSession()
```
    Specified by:
    
    getTargetSession in class EntityGraph

Class LocalEntityGraph

Field Summary

Fields inherited from class net.sf.jailer.entitygraph.EntityGraph

Method Summary

Methods inherited from class net.sf.jailer.entitygraph.EntityGraph

Methods inherited from class java.lang.Object

Method Detail

close

setBirthdayOfSubject

create

copy

find

getAge

setAge

getSize

delete

addEntities

resolveAssociation

addDependencies

getDistinctDependencyIDs

markIndependentEntities

markRoots

readMarkedEntities

readMarkedEntities

uniteWith

readEntities

readUnfilteredEntityColumns

updateEntities

deleteIndependentEntities

deleteEntities

countEntities

removeAssociatedDestinations

readDependentEntities

markDependentEntitiesAsTraversed

readNonTraversedDependencies

removeReflexiveDependencies

getTotalRowcount

setExplain

getUniversalPrimaryKey

shutDown

getSession

getDatamodel

getTargetSession