| java.lang.Object
 net.refractions.udig.core.internal.AbstractRegistryReader
| AbstractRegistryReader | | abstract public class AbstractRegistryReader (Code) | | Abstract implementation of a registry reader that creates objects representing registry contents.
Typically, an extension contains one element, but this reader handles multiple elements per
extension.
To start reading the extensions from the registry for an extension point, call the method
readRegistry.
To read children of an IConfigurationElement, call the method readElementChildren
from your implementation of the method readElement, as it will not be done by
default.
This class is similar to the internal class RegistryReader provided by the framework.
|
| Method Summary | |
| protected String | getDescription(IConfigurationElement config)
This method extracts description as a subelement of the given element. | | protected void | logError(IConfigurationElement element, String text)
Logs the error in the plugin log using the provided text and the information in the
configuration element. | | protected void | logMissingAttribute(IConfigurationElement element, String attributeName)
Logs a very common registry error when a required attribute is missing. | | protected void | logMissingElement(IConfigurationElement element, String elementName)
Logs a very common registry error when a required child is missing. | | protected void | logUnknownElement(IConfigurationElement element)
Logs a registry error when the configuration element is unknown. | | protected IStatus | newStatus(int severity, String message, Throwable exception)
IStatus creations (with respect to plugin id). | | protected IExtension[] | orderExtensions(IExtension[] extensions)
Apply a reproducable order to the list of extensions provided, such that the order will not
change as extensions are added or removed. | | abstract protected boolean | readElement(IConfigurationElement element)
Implement this method to read element's attributes. | | protected void | readElementChildren(IConfigurationElement element)
Read the element's children. | | protected void | readElements(IConfigurationElement[] elements)
Read each element one at a time by calling the subclass implementation of
readElement. | | protected void | readExtension(IExtension extension)
Read one extension by looping through its configuration elements. | | public void | readRegistry(IExtensionRegistry registry, String targetPluginId, String extensionPoint)
Start the registry reading process using the supplied plugin ID and extension point. |
| TAG_DESCRIPTION | | final protected static String TAG_DESCRIPTION(Code) | | |
| AbstractRegistryReader | | protected AbstractRegistryReader(ILog log, String id)(Code) | | The constructor (requires a workbench for logging).
Parameters:
log - ILog for status messages
Parameters:
id - Plugin ID for status messages |
| getDescription | | protected String getDescription(IConfigurationElement config)(Code) | | This method extracts description as a subelement of the given element.
Parameters:
config - Configuration defining extention point description string if defined, or empty string if not. |
| logError | | protected void logError(IConfigurationElement element, String text)(Code) | | Logs the error in the plugin log using the provided text and the information in the
configuration element.
Parameters:
element -
Parameters:
text - |
| logMissingAttribute | | protected void logMissingAttribute(IConfigurationElement element, String attributeName)(Code) | | Logs a very common registry error when a required attribute is missing.
Parameters:
element -
Parameters:
attributeName - |
| logMissingElement | | protected void logMissingElement(IConfigurationElement element, String elementName)(Code) | | Logs a very common registry error when a required child is missing.
Parameters:
element -
Parameters:
elementName - |
| logUnknownElement | | protected void logUnknownElement(IConfigurationElement element)(Code) | | Logs a registry error when the configuration element is unknown.
Parameters:
element - |
| newStatus | | protected IStatus newStatus(int severity, String message, Throwable exception)(Code) | | IStatus creations (with respect to plugin id).
Parameters:
severity - IStatus constant such as IStatus.OK, or IStatus.ERROR
Parameters:
message - Status message
Parameters:
exception - Cause of message, may be null IStatus suitable for use with plugin.getLog.log( IStatus ) |
| orderExtensions | | protected IExtension[] orderExtensions(IExtension[] extensions)(Code) | | Apply a reproducable order to the list of extensions provided, such that the order will not
change as extensions are added or removed.
Parameters:
extensions - Ordered Extentions IExtentions |
| readElement | | abstract protected boolean readElement(IConfigurationElement element)(Code) | | Implement this method to read element's attributes. If children should also be read, then
implementor is responsible for calling readElementChildren. Implementor is
also responsible for logging missing attributes.
Parameters:
element - true if element was recognized, false if not. |
| readElementChildren | | protected void readElementChildren(IConfigurationElement element)(Code) | | Read the element's children. This is called by the subclass' readElement method when it wants
to read the children of the element.
Parameters:
element - |
| readElements | | protected void readElements(IConfigurationElement[] elements)(Code) | | Read each element one at a time by calling the subclass implementation of
readElement. Logs an error if the element was not recognized.
Parameters:
elements - |
| readExtension | | protected void readExtension(IExtension extension)(Code) | | Read one extension by looping through its configuration elements.
Parameters:
extension - |
| readRegistry | | public void readRegistry(IExtensionRegistry registry, String targetPluginId, String extensionPoint)(Code) | | Start the registry reading process using the supplied plugin ID and extension point.
Parameters:
registry -
Parameters:
targetPluginId -
Parameters:
extensionPoint - |
|
|