com.goldencode.p2j.schema

Class TableResourceMap

java.lang.Object

com.goldencode.p2j.schema.TableResourceMap

public final class TableResourceMap
extends java.lang.Object

A class to track table-level database resources (e.g., fields or indices), in order to support reporting of unused resources during conversion. An instance is created and all such known resources are added to it initially. As resources are identified as being referenced/used during conversion, they are removed from the map. Those remaining in the map at the end of conversion represent resources that are not referenced in static database code. The writeContent(Writer, String) method is used to write any remaining, unreferenced resources into a lightly-formatted text stream.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.SortedMap<java.lang.String,java.util.SortedSet<java.lang.String>>	byTable Map of qualified table names to sets of resource names within that table

Constructor Summary

Constructors

Constructor and Description
TableResourceMap() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String table, java.lang.String resource) Add a single resource to the map.
boolean	isEmpty() Indicate whether the resource map is empty.
boolean	remove(java.lang.String table, java.lang.String resource) Remove a single resource from the map.
void	writeContent(java.io.Writer writer, java.lang.String heading) Write content for the remaining information, if any, in this resource map, once all individual referenced resources have been removed.

Methods inherited from class java.lang.Object

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

Field Detail

byTable

private final java.util.SortedMap<java.lang.String,java.util.SortedSet<java.lang.String>> byTable

Map of qualified table names to sets of resource names within that table

Constructor Detail

TableResourceMap

public TableResourceMap()

Default constructor.

Method Detail

add

public void add(java.lang.String table,
                java.lang.String resource)

Add a single resource to the map. Add a table entry to the map if this is the first resource to be added which is associated with the given table.

Parameters:

table - Qualified, normalized table name.

resource - Resource name.

remove

public boolean remove(java.lang.String table,
                      java.lang.String resource)

Remove a single resource from the map. Remove the table entry from the map if there are no resources left in the set after the removal.

Parameters:

table - Qualified, normalized table name.

resource - Resource name

Returns:

If the table was removed.

isEmpty

public boolean isEmpty()

Indicate whether the resource map is empty.

Returns:

true if empty, else false.

writeContent

public void writeContent(java.io.Writer writer,
                         java.lang.String heading)
                  throws java.io.IOException

Write content for the remaining information, if any, in this resource map, once all individual referenced resources have been removed.

Parameters:

writer - Writer output stream.

heading - Heading for this resource map's section of the report.

Throws:

java.io.IOException - if there is an error writing to the stream.