FrameworkRegistry (jOAI Java Documentation v3.3)

java.lang.Object
- org.dlese.dpc.schemedit.FrameworkRegistry

All Implemented Interfaces:

java.util.EventListener, MetadataVocabReloadListener
```
public class FrameworkRegistry
extends java.lang.Object
implements MetadataVocabReloadListener
```
A map holding MetaDataFramework instances, and keyed by the short name (e.g., "adn") of each particular framework.
The Registry is populated at system startup time. It reads framework config files and instantiates a MetaDataFramework instance for each one.

Author:

ostwald

Constructor Summary

Constructors
Constructor and Description
`FrameworkRegistry()` Constructor for the FrameworkRegistry object
`FrameworkRegistry(javax.servlet.ServletContext servletContext)` FrameworkRegistry constructure with ServletContext
`FrameworkRegistry(java.lang.String configDirPath, java.lang.String docRoot)` Constructor for the FrameworkRegistry object for specified configuration directory and docRoot (used for debugging - docRoot is normally calculated from servletContext).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearLoadErrors()` Clear the load errors
`void`	`clearLoadWarnings()` Clear the load warnings
`void`	`destroy()` Destroys the loaded frameworks
`void`	`extractMuiGroups()` Initialize each framework with information about which fields can be formatted using MUI Groups files.
`java.util.List`	`getAllFormats()` Return a list of formats for registered frameworks.
`java.io.File`	`getConfigDir()` Gets the directory in which framework config files are located.
`MetaDataFramework`	`getFramework(java.lang.String xmlFormat)` Gets the framework for the specified xmlFormat
`boolean`	`getIsLoaded(java.lang.String xmlFormat)` Returns true if the framework for provided xmlFormat is currently loaded in this FrameworkRegistry
`java.util.List`	`getItemFormats()` Gets the registered formats that are "item" frameworks (e.g., "adn", "dlese_anno", as opposed to frameworks used internally (e.g., "dcs_data") by the system.
`ErrorLog`	`getLoadErrors()` Gets the loadErrors attribute of the FrameworkRegistry object
`ErrorLog`	`getLoadWarnings()` Gets the loadWarnings attribute of the FrameworkRegistry object
`java.util.List`	`getNames()` Return the formats of the registered frameworks, excluding "dlese_collect"
`java.util.List`	`getOaiFormats()` Gets the formats that are available to oai services, which are the itemFrameworks plus "dlese_collect"
`java.util.List`	`getUnloadedFrameworks()` Returns a list of xmlFormats corresponding to framework config files that are present in the framework config directory, but are not currently loaded in the FrameworkRegistry object
`void`	`load()` Loads the FrameworkRegistry by traversing the framework config files in the config directory.
`void`	`loadFramework(java.lang.String xmlFormat)` Loads the framework for specified xmlformat after finding the framework config file
`static void`	`main(java.lang.String[] args)` NOT YET DOCUMENTED
`void`	`metadataVocabReloaded(MetadataVocabReloadEvent event)` Event handler for MetadataVocabReloadEvent registers MUI groups with appropriate frameworks and then re-renders the editors for frameworks that have registered MUI groups.
`void`	`register(MetaDataFramework mdf)` Register provided MetaDataFramework.
`int`	`size()` The number of registered frameworks
`java.lang.String`	`toString()` Return a string representation of the registry for debugging purposes.
`void`	`unregister(java.lang.String xmlFormat)` Remove the framework for provided xmlFormat from the registry

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

- Constructor Detail
  - FrameworkRegistry
```
public FrameworkRegistry()
```
    Constructor for the FrameworkRegistry object
  - FrameworkRegistry
```
public FrameworkRegistry(javax.servlet.ServletContext servletContext)
```
    FrameworkRegistry constructure with ServletContext
    
    Parameters:
    
    servletContext - the servletContext
  - FrameworkRegistry
```
public FrameworkRegistry(java.lang.String configDirPath,
                         java.lang.String docRoot)
```
    Constructor for the FrameworkRegistry object for specified configuration directory and docRoot (used for debugging - docRoot is normally calculated from servletContext).
    
    Parameters:
    
    configDirPath - path to directory containing framework config files
    
    docRoot - path to servlet baseDir
- Method Detail
  - getConfigDir
```
public java.io.File getConfigDir()
```
    Gets the directory in which framework config files are located.
    
    Returns:
    
    The configDir value
  - loadFramework
```
public void loadFramework(java.lang.String xmlFormat)
                   throws java.lang.Exception
```
    Loads the framework for specified xmlformat after finding the framework config file
    
    Parameters:
    
    xmlFormat - the xmlFormat for the framework (e.g., "adn")
    
    Throws:
    
    java.lang.Exception - if the framework could not be loaded
  - load
```
public void load()
```
    Loads the FrameworkRegistry by traversing the framework config files in the config directory.
  - getLoadErrors
```
public ErrorLog getLoadErrors()
```
    Gets the loadErrors attribute of the FrameworkRegistry object
    
    Returns:
    
    The loadErrors value
  - clearLoadErrors
```
public void clearLoadErrors()
```
    Clear the load errors
  - getLoadWarnings
```
public ErrorLog getLoadWarnings()
```
    Gets the loadWarnings attribute of the FrameworkRegistry object
    
    Returns:
    
    The loadWarnings value
  - clearLoadWarnings
```
public void clearLoadWarnings()
```
    Clear the load warnings
  - metadataVocabReloaded
```
public void metadataVocabReloaded(MetadataVocabReloadEvent event)
```
    Event handler for MetadataVocabReloadEvent registers MUI groups with appropriate frameworks and then re-renders the editors for frameworks that have registered MUI groups.
    
    Specified by:
    
    metadataVocabReloaded in interface MetadataVocabReloadListener
    
    Parameters:
    
    event - NOT YET DOCUMENTED
  - extractMuiGroups
```
public void extractMuiGroups()
```
    Initialize each framework with information about which fields can be formatted using MUI Groups files.
  - register
```
public void register(MetaDataFramework mdf)
```
    Register provided MetaDataFramework.
    
    Parameters:
    
    mdf - the framework to be loaded
  - unregister
```
public void unregister(java.lang.String xmlFormat)
```
    Remove the framework for provided xmlFormat from the registry
    
    Parameters:
    
    xmlFormat - format (e.g., "adn") corresponding to a loaded framework
  - getFramework
```
public MetaDataFramework getFramework(java.lang.String xmlFormat)
```
    Gets the framework for the specified xmlFormat
    
    Parameters:
    
    xmlFormat - format (e.g., "adn") corresponding to a loaded framework
    
    Returns:
    
    The framework
  - size
```
public int size()
```
    The number of registered frameworks
    
    Returns:
    
    the number of registered frameworks
  - getIsLoaded
```
public boolean getIsLoaded(java.lang.String xmlFormat)
```
    Returns true if the framework for provided xmlFormat is currently loaded in this FrameworkRegistry
    
    Parameters:
    
    xmlFormat - e.g., ("adn")
    
    Returns:
    
    true if framework is loaded.
  - getUnloadedFrameworks
```
public java.util.List getUnloadedFrameworks()
```
    Returns a list of xmlFormats corresponding to framework config files that are present in the framework config directory, but are not currently loaded in the FrameworkRegistry object
    
    Returns:
    
    The unloadedFrameworks
  - toString
```
public java.lang.String toString()
```
    Return a string representation of the registry for debugging purposes.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Description of the Return Value
  - getAllFormats
```
public java.util.List getAllFormats()
```
    Return a list of formats for registered frameworks.
    
    Returns:
    
    The allFormats value
  - getItemFormats
```
public java.util.List getItemFormats()
```
    Gets the registered formats that are "item" frameworks (e.g., "adn", "dlese_anno", as opposed to frameworks used internally (e.g., "dcs_data") by the system.
    
    Returns:
    
    The itemFormats value
  - getOaiFormats
```
public java.util.List getOaiFormats()
```
    Gets the formats that are available to oai services, which are the itemFrameworks plus "dlese_collect"
    
    Returns:
    
    The oaiFormats value
  - getNames
```
public java.util.List getNames()
```
    Return the formats of the registered frameworks, excluding "dlese_collect"
    
    Returns:
    
    The names value
  - destroy
```
public void destroy()
```
    Destroys the loaded frameworks
  - main
```
public static void main(java.lang.String[] args)
```
    NOT YET DOCUMENTED
    
    Parameters:
    
    args - NOT YET DOCUMENTED

Class FrameworkRegistry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FrameworkRegistry

FrameworkRegistry

FrameworkRegistry

Method Detail

getConfigDir

loadFramework

load

getLoadErrors

clearLoadErrors

getLoadWarnings

clearLoadWarnings

metadataVocabReloaded

extractMuiGroups

register

unregister

getFramework

size

getIsLoaded

getUnloadedFrameworks

toString

getAllFormats

getItemFormats

getOaiFormats

getNames

destroy

main