org.topbraid.core.config
Interface IConfigPlugin

All Known Implementing Classes:
AbstractConfigPlugin, DiagramsConfigPlugin, FormsConfigPlugin, GraphConfigPlugin, InferenceConfigPlugin

public interface IConfigPlugin

An interface for objects that manage contents of the TopBraid configuration files. In particular, these plugins are notified when certain changes have happened, e.g. to rename references to a resource that was renamed.

Author:
Holger Knublauch

Method Summary
 void changeOperationPerformed(ChangeOperation operation, boolean undone, com.hp.hpl.jena.rdf.model.Model configModel, java.net.URI baseURI)
           
 boolean configLoaded(java.net.URI baseURI, com.hp.hpl.jena.rdf.model.Model configModel)
          Called immediately after a config file has been loaded (or an empty config has been created).
 void configSaved(java.net.URI baseURI, com.hp.hpl.jena.rdf.model.Model configModel)
           
 com.hp.hpl.jena.rdf.model.Model[] getSystemModels()
          Gets (optional) global models with system classes etc.
 void setPrefixes(com.hp.hpl.jena.rdf.model.Model configModel)
           
 

Method Detail

changeOperationPerformed

void changeOperationPerformed(ChangeOperation operation,
                              boolean undone,
                              com.hp.hpl.jena.rdf.model.Model configModel,
                              java.net.URI baseURI)

configLoaded

boolean configLoaded(java.net.URI baseURI,
                     com.hp.hpl.jena.rdf.model.Model configModel)
Called immediately after a config file has been loaded (or an empty config has been created). This can be used to load additional files that are referenced from the configuration file, e.g. external form files.

Parameters:
baseURI - the base URI
configModel - the new configuration model
Returns:
true if the method has had side effects (such as deleting legacy files) so that the tbc file should be saved immediately

configSaved

void configSaved(java.net.URI baseURI,
                 com.hp.hpl.jena.rdf.model.Model configModel)

getSystemModels

com.hp.hpl.jena.rdf.model.Model[] getSystemModels()
Gets (optional) global models with system classes etc. Example include the forms meta-ontology that shall be included in each config model at run-time. Note that each config plugin should reuse the same Model instance as a static entity to minimize load time. Also note that plugins must bundle any files that are loaded because TopBraid cannot assume anything about the network connection and workspace files.

Returns:
optional system models or null

setPrefixes

void setPrefixes(com.hp.hpl.jena.rdf.model.Model configModel)