org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema Class Reference

Collaboration diagram for org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema:

[legend]List of all members.

Public Member Functions
	SchedulerDatabaseSchema (DatabaseSchema schema)
void	addTable (SchedulerDatabaseTable table)
void	removeTable (SchedulerDatabaseTable table)
void	mergeSchema (SchedulerDatabaseSchema databaseSchema)
ArrayList	getTables ()
SchedulerDatabaseTable	getTable (String tableName)
boolean	hasTable (String tableName)
TransactionExclusiveLock	getLock ()
boolean	equals (Object other)
String	getInformation (boolean longFormat)

---

Detailed Description

A SchedulerDatabaseSchema describes all the tables and columns of a database and its associated cache entries.

Author:

Emmanuel Cecchet

Version:

1.0

Definition at line 40 of file SchedulerDatabaseSchema.java.

---

Constructor & Destructor Documentation

org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.SchedulerDatabaseSchema (  DatabaseSchema  schema  )

Creates a new SchedulerDatabaseSchema instance by cloning an existing DatabaseSchema. Parameters: schema  the database schema to clone Definition at line 53 of file SchedulerDatabaseSchema.java. References org.objectweb.cjdbc.common.sql.schema.DatabaseSchema.getTables(). { if (schema == null) { tables = new ArrayList(); return; } // Clone the tables ArrayList origTables = schema.getTables(); int size = origTables.size(); tables = new ArrayList(size); for (int i = 0; i < size; i++) tables.add(new SchedulerDatabaseTable((DatabaseTable) origTables.get(i))); }

---

Member Function Documentation

void org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.addTable (  SchedulerDatabaseTable  table  )

Adds a SchedulerDatabaseTable describing a table of the database. Parameters: table  the table to add Definition at line 75 of file SchedulerDatabaseSchema.java. Referenced by org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.mergeSchema(). { tables.add(table); }

boolean org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.equals (  Object  other  )

Two SchedulerDatabaseSchema are equals if they have the same tables. Parameters: other  the object to compare with Returns: true if the objects are the same Definition at line 185 of file SchedulerDatabaseSchema.java. References org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.getTables(). { if (!(other instanceof SchedulerDatabaseSchema)) return false; if (tables == null) return ((SchedulerDatabaseSchema) other).getTables() == null; else return tables.equals(((SchedulerDatabaseSchema) other).getTables()); }

String org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.getInformation (  boolean  longFormat  )

Returns information about the database schema. Parameters: longFormat  true for a long format, false for a short summary Returns: a String value Definition at line 203 of file SchedulerDatabaseSchema.java. References org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseTable.getInformation(). { StringBuffer result = new StringBuffer(); SchedulerDatabaseTable t; int size = tables.size(); for (int i = 0; i < size; i++) { t = (SchedulerDatabaseTable) tables.get(i); result.append(t.getInformation(longFormat)); result.append(System.getProperty("line.separator")); } return result.toString(); }

TransactionExclusiveLock org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.getLock (   )

Returns the lock for this table. Returns: a TransactionExclusiveLock instance See also: TransactionExclusiveLock Definition at line 173 of file SchedulerDatabaseSchema.java. { return lock; }

SchedulerDatabaseTable org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.getTable (  String  tableName  )

Returns the SchedulerDatabaseTable object matching the given table name or null if not found. Matching is case insensitive. Parameters: tableName  the table name to look for Returns: a SchedulerDatabaseTable value or null Definition at line 135 of file SchedulerDatabaseSchema.java. References org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseTable.getName(). Referenced by org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.mergeSchema(). { SchedulerDatabaseTable t; int size = tables.size(); for (int i = 0; i < size; i++) { t = (SchedulerDatabaseTable) tables.get(i); if (tableName.equalsIgnoreCase(t.getName())) return t; } return null; }

ArrayList org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.getTables (   )

Returns an ArrayList of SchedulerDatabaseTable objects describing the database. Returns: an ArrayList of SchedulerDatabaseTable Definition at line 123 of file SchedulerDatabaseSchema.java. Referenced by org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.equals(), and org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.mergeSchema(). { return tables; }

boolean org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.hasTable (  String  tableName  )

Returns true if the given TableName is found in this schema. Parameters: tableName  the name of the table you are looking for Returns: true if the table has been found Definition at line 155 of file SchedulerDatabaseSchema.java. References org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseTable.getName(). { int size = tables.size(); for (int i = 0; i < size; i++) { SchedulerDatabaseTable t = (SchedulerDatabaseTable) tables.get(i); if (tableName.equals(t.getName())) return true; } return false; }

void org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.mergeSchema (  SchedulerDatabaseSchema  databaseSchema  )

Merge the given schema with the current one. All missing tables are added if no conflict is detected. An exception is thrown if the given schema definition conflicts with the current one. Parameters: databaseSchema  the schema to merge Definition at line 98 of file SchedulerDatabaseSchema.java. References org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.addTable(), org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseTable.getName(), org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.getTable(), and org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.getTables(). { if (databaseSchema == null) return; ArrayList otherTables = databaseSchema.getTables(); if (otherTables == null) return; int size = otherTables.size(); for (int i = 0; i < size; i++) { SchedulerDatabaseTable t = (SchedulerDatabaseTable) otherTables.get(i); SchedulerDatabaseTable original = getTable(t.getName()); if (original == null) addTable(t); } }

void org.objectweb.cjdbc.controller.scheduler.schema.SchedulerDatabaseSchema.removeTable (  SchedulerDatabaseTable  table  )

Removes a SchedulerDatabaseTable describing a table of the database. Parameters: table  the table to remove Definition at line 86 of file SchedulerDatabaseSchema.java. { tables.remove(table); }

---

The documentation for this class was generated from the following file:

• SchedulerDatabaseSchema.java

---