|
OpenNMS API 1.2.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opennms.netmgt.config.DatabaseSchemaConfigFactory
This is the singleton class used to load the configuration for the OpenNMS database schemafor the filters from the database-schema xml file. Note: Users of this class should make sure the init() is called before calling any other method to ensure the config is loaded before accessing other convenience methods.
Field Summary | |
private DatabaseSchema |
m_config
The config class loaded from the config file |
private java.util.Set |
m_joinable
The set of tables that can be joined directly or indirectly to the primary table |
private static boolean |
m_loaded
This member is set to true if the configuration file has been loaded. |
private java.util.Map |
m_primaryJoins
A map from a table to the join to use to get 'closer' to the primary table |
private static DatabaseSchemaConfigFactory |
m_singleton
The singleton instance of this factory |
Constructor Summary | |
private |
DatabaseSchemaConfigFactory(java.lang.String configFile)
Private constructor |
Method Summary | |
java.lang.String |
constructJoinExprForTable(Table t)
Construct a joining expression necessary to join the given table to the primary table. |
Table |
findTableByVisableColumn(java.lang.String colName)
Find the table which has a visible column named 'colName' |
DatabaseSchema |
getDatabaseSchema()
Return the database schema. |
static DatabaseSchemaConfigFactory |
getInstance()
Return the singleton instance of this factory. |
java.lang.String[] |
getJoinTablesForTable(Table t)
Returns an array of the names of tables involved in a join of the given table and the primary. |
Join[] |
getPrimaryJoinsForTable(Table t)
Get the sequence of joins that are necessary to joint table t to the primary table. |
Table |
getPrimaryTable()
This method is used to find the table that should drive the construction of the join clauses between all table in the from clause. |
Table |
getTableByName(java.lang.String name)
Find a table using its name as the search key. |
int |
getTableCount()
Return a count of the number of tables defined. |
static void |
init()
Load the config from the default config file and create the singleton instance of this factory. |
static void |
reload()
Reload the config from the default config file |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private static DatabaseSchemaConfigFactory m_singleton
private DatabaseSchema m_config
private java.util.Set m_joinable
private java.util.Map m_primaryJoins
private static boolean m_loaded
Constructor Detail |
private DatabaseSchemaConfigFactory(java.lang.String configFile) throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
java.io.IOException
- Thrown if the specified config file cannot be read
org.exolab.castor.xml.MarshalException
- Thrown if the file does not conform to the schema.
org.exolab.castor.xml.ValidationException
- Thrown if the contents do not match the required schema.Method Detail |
public static void init() throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
java.io.IOException
- Thrown if the specified config file cannot be read
org.exolab.castor.xml.MarshalException
- Thrown if the file does not conform to the schema.
org.exolab.castor.xml.ValidationException
- Thrown if the contents do not match the required schema.public static void reload() throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
java.io.IOException
- Thrown if the specified config file cannot be read/loaded
org.exolab.castor.xml.MarshalException
- Thrown if the file does not conform to the schema.
org.exolab.castor.xml.ValidationException
- Thrown if the contents do not match the required schema.public static DatabaseSchemaConfigFactory getInstance()
java.lang.IllegalStateException
- Thrown if the factory has not yet been initialized.public DatabaseSchema getDatabaseSchema()
public Table getPrimaryTable()
public Table getTableByName(java.lang.String name)
name
- the name of the table to find
public Table findTableByVisableColumn(java.lang.String colName)
public int getTableCount()
public java.lang.String constructJoinExprForTable(Table t)
t
- the table to create the expression for
public java.lang.String[] getJoinTablesForTable(Table t)
t
- the Table to join
public Join[] getPrimaryJoinsForTable(Table t)
t
- the table to join
|
OpenNMS API 1.2.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |