org.LexGrid.LexBIG.Extensions
Interface ExtensionRegistry

All Superinterfaces:
java.io.Serializable

public interface ExtensionRegistry
extends java.io.Serializable

Allows registration and lookup of implementors for extensible pieces of the LexBIG architecture.


Method Summary
 ExtensionDescription getExportExtension(java.lang.String name)
          Returns the description of a registered extension matching the given name.
 ExtensionDescriptionList getExportExtensions()
          Returns a description of all registered extensions used to export information loaded to a LexBIGService.
 ExtensionDescription getFilterExtension(java.lang.String name)
          Returns the description of a registered extension matching the given name.
 ExtensionDescriptionList getFilterExtensions()
          Returns a description of all registered extensions used to provide additional filtering of query results.
 ExtensionDescription getGenericExtension(java.lang.String name)
          Returns the description of a registered extension matching the given name.
 ExtensionDescriptionList getGenericExtensions()
          Returns a description of all registered extensions used to implement application-specific behavior that is centrally accessible from a LexBIGService.
 ExtensionDescription getIndexExtension(java.lang.String name)
          Returns the description of a registered extension matching the given name.
 ExtensionDescriptionList getIndexExtensions()
          Returns a description of all registered extensions used to index information that has been previously loaded to a LexBIGService.
 ExtensionDescription getLoadExtension(java.lang.String name)
          Returns the description of a registered extension matching the given name.
 ExtensionDescriptionList getLoadExtensions()
          Returns a description of all registered extensions used to load information for access by a LexBIGService.
 ExtensionDescription getSearchExtension(java.lang.String name)
          Returns the description of a registered extension matching the given name.
 ExtensionDescriptionList getSearchExtensions()
          Returns a description of all registered extensions used to provide additional sorting of query results.
 SortDescription getSortExtension(java.lang.String name)
          Returns the description of a registered extension matching the given name.
 SortDescriptionList getSortExtensions()
          Returns a description of all registered extensions used to provide additional sorting of query results.
 void registerExportExtension(ExtensionDescription description)
          Registers a class of extension used to export existing content from the LexGrid repository.
 void registerFilterExtension(ExtensionDescription description)
          Registers a class of extension used to filter query content.
 void registerGenericExtension(ExtensionDescription description)
          Registers a class of extension used to implement application-specific behavior that is centrally accessible from a LexBIGService.
 void registerIndexExtension(ExtensionDescription description)
          Registers a class of extension used to index information that has been previously loaded to a LexBIGService.
 void registerLoadExtension(ExtensionDescription description)
          Registers a class of extension used to load information for access by a LexBIGService.
 void registerSearchExtension(ExtensionDescription description)
           
 void registerSortExtension(SortDescription description)
          Registers a class of extension used to provide additional sorting of query results.
 void unregisterExportExtension(java.lang.String name)
          Removes registration for the given named extension.
 void unregisterFilterExtension(java.lang.String name)
          Removes registration for the given named extension.
 void unregisterGenericExtension(java.lang.String name)
          Removes registration for the given named extension.
 void unregisterIndexExtension(java.lang.String name)
          Removes registration for the given named extension.
 void unregisterLoadExtension(java.lang.String name)
          Removes registration for the given named extension.
 void unregisterSearchExtension(java.lang.String name)
           
 void unregisterSortExtension(java.lang.String name)
          Removes registration for the given named extension.
 

Method Detail

getExportExtension

ExtensionDescription getExportExtension(java.lang.String name)
Returns the description of a registered extension matching the given name.

Parameters:
name - The extension name; not null.
Returns:
A matching extension description; null if no match is found. If not null, the description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Export.Exporter and providing a public parameterless constructor.

getExportExtensions

ExtensionDescriptionList getExportExtensions()
Returns a description of all registered extensions used to export information loaded to a LexBIGService.

Returns:
The list containing the description of extensions registered for this category. Each description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Export.Exporter and providing a public parameterless constructor.

getFilterExtension

ExtensionDescription getFilterExtension(java.lang.String name)
Returns the description of a registered extension matching the given name.

Parameters:
name - The extension name; not null.
Returns:
A matching extension description; null if no match is found. If not null, the description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Query.Filter and providing a public parameterless constructor.

getFilterExtensions

ExtensionDescriptionList getFilterExtensions()
Returns a description of all registered extensions used to provide additional filtering of query results. Filters should _NOT_ be used for search criteria that can be done with built in restrictions. Filters are very inefficient.

Returns:
The list containing the description of extensions registered for this category. Each description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Query.Filter and providing a public parameterless constructor.

getGenericExtension

ExtensionDescription getGenericExtension(java.lang.String name)
Returns the description of a registered extension matching the given name.

Parameters:
name - The extension name; not null.
Returns:
A matching extension description; null if no match is found. If not null, the description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Generic.GenericExtension and providing a public parameterless constructor.

getGenericExtensions

ExtensionDescriptionList getGenericExtensions()
Returns a description of all registered extensions used to implement application-specific behavior that is centrally accessible from a LexBIGService.

Note that only generic extensions (base class GenericExtension) will be listed here. All other classes are retrievable at the appropriate interface point (filter, sort, etc).

Returns:
The list containing the description of extensions registered for this category. Each description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Generic.GenericExtension and providing a public parameterless constructor.

getIndexExtension

ExtensionDescription getIndexExtension(java.lang.String name)
Returns the description of a registered extension matching the given name.

Parameters:
name - The extension name; not null.
Returns:
A matching extension description; null if no match is found. If not null, the description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Index.Index and providing a public parameterless constructor.

getIndexExtensions

ExtensionDescriptionList getIndexExtensions()
Returns a description of all registered extensions used to index information that has been previously loaded to a LexBIGService.

Returns:
The list containing the description of extensions registered for this category. Each description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Index.Index and providing a public parameterless constructor.

getLoadExtension

ExtensionDescription getLoadExtension(java.lang.String name)
Returns the description of a registered extension matching the given name.

Parameters:
name - The extension name; not null.
Returns:
A matching extension description; null if no match is found. If not null, the description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Load.Loader and providing a public parameterless constructor.

getLoadExtensions

ExtensionDescriptionList getLoadExtensions()
Returns a description of all registered extensions used to load information for access by a LexBIGService.

Returns:
The list containing the description of extensions registered for this category. Each description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Load.Loader and providing a public parameterless constructor.

getSortExtension

SortDescription getSortExtension(java.lang.String name)
Returns the description of a registered extension matching the given name.

Parameters:
name - The extension name; not null.
Returns:
A matching extension description; null if no match is found. If not null, the description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Query.Sort and providing a public parameterless constructor.

getSortExtensions

SortDescriptionList getSortExtensions()
Returns a description of all registered extensions used to provide additional sorting of query results.

Returns:
The list containing the description of extensions registered for this category. Each description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Query.Sort and providing a public parameterless constructor.

getSearchExtension

ExtensionDescription getSearchExtension(java.lang.String name)
Returns the description of a registered extension matching the given name.

Parameters:
name - The extension name; not null.
Returns:
A matching extension description; null if no match is found. If not null, the description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Query.Search and providing a public parameterless constructor.

getSearchExtensions

ExtensionDescriptionList getSearchExtensions()
Returns a description of all registered extensions used to provide additional sorting of query results.

Returns:
The list containing the description of extensions registered for this category. Each description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Query.Search and providing a public parameterless constructor.

registerExportExtension

void registerExportExtension(ExtensionDescription description)
                             throws LBParameterException
Registers a class of extension used to export existing content from the LexGrid repository.

Parameters:
description - The description of the extension to register, which must provide a unique name for this type of extension and identify a class of item implementing org.LexGrid.LexBIG.Extensions.Export.Exporter with a public parameterless constructor.
Throws:
LBParameterException - If the given description does not meet the specified criteria.

registerFilterExtension

void registerFilterExtension(ExtensionDescription description)
                             throws LBParameterException
Registers a class of extension used to filter query content. Filters should _NOT_ be used for search criteria that can be done with built in restrictions. Filters are very inefficient.

Parameters:
description - The description of the extension to register, which must provide a unique name for this type of extension and identify a class of item implementing org.LexGrid.LexBIG.Extensions.Query.Filter with a public parameterless constructor.
Throws:
LBParameterException - If the given description does not meet the specified criteria.

registerGenericExtension

void registerGenericExtension(ExtensionDescription description)
                              throws LBParameterException
Registers a class of extension used to implement application-specific behavior that is centrally accessible from a LexBIGService.

Parameters:
description - The description of the extension to register, which must provide a unique name for this type of extension and identify a class of item implementing org.LexGrid.LexBIG.Extensions.Generic.GenericExtension with a public parameterless constructor.
Throws:
LBParameterException - If the given description does not meet the specified criteria.

registerIndexExtension

void registerIndexExtension(ExtensionDescription description)
                            throws LBParameterException
Registers a class of extension used to index information that has been previously loaded to a LexBIGService.

Parameters:
description - The description of the extension to register, which must provide a unique name for this type of extension and identify a class of item implementing org.LexGrid.LexBIG.Extensions.Index.Index with a public parameterless constructor.
Throws:
LBParameterException - If the given description does not meet the specified criteria.

registerLoadExtension

void registerLoadExtension(ExtensionDescription description)
                           throws LBParameterException
Registers a class of extension used to load information for access by a LexBIGService.

Parameters:
description - The description of the extension to register, which must provide a unique name for this type of extension and identify a class of item implementing org.LexGrid.LexBIG.Extensions.Load.Loader with a public parameterless constructor.
Throws:
LBParameterException - If the given description does not meet the specified criteria.

registerSortExtension

void registerSortExtension(SortDescription description)
                           throws LBParameterException
Registers a class of extension used to provide additional sorting of query results.

NOTE: Sort extensions can only be applied when resolving standard node set representations. Therefore the provided description MUST be restricted only to a sort context of SortContext.SET.

Parameters:
description - The description of the extension to register, which must provide a unique name for this type of extension and identify a class of item implementing org.LexGrid.LexBIG.Extensions.Query.Sort with a public parameterless constructor.
Throws:
LBParameterException - If the given description does not meet the specified criteria.

registerSearchExtension

void registerSearchExtension(ExtensionDescription description)
                             throws LBParameterException
Throws:
LBParameterException

unregisterExportExtension

void unregisterExportExtension(java.lang.String name)
                               throws LBParameterException
Removes registration for the given named extension. Upon completion, the extension will no longer be available for lookup from the LexBIG service.

Parameters:
name - The extension name; not null. The extension version; null to match all versions.
Throws:
LBParameterException - If the given name does not match a registered extension.

unregisterFilterExtension

void unregisterFilterExtension(java.lang.String name)
                               throws LBParameterException
Removes registration for the given named extension. Upon completion, the extension will no longer be available for lookup from the LexBIG service.

Parameters:
name - The extension name; not null.
Throws:
LBParameterException - If the given name does not match a registered extension.

unregisterGenericExtension

void unregisterGenericExtension(java.lang.String name)
                                throws LBParameterException
Removes registration for the given named extension. Upon completion, the extension will no longer be available for lookup from the LexBIG service.

Parameters:
name - The extension name; not null.
Throws:
LBParameterException - If the given name does not match a registered extension.

unregisterIndexExtension

void unregisterIndexExtension(java.lang.String name)
                              throws LBParameterException
Removes registration for the given named extension. Upon completion, the extension will no longer be available for lookup from the LexBIG service.

Parameters:
name - The extension name; not null.
Throws:
LBParameterException - If the given name does not match a registered extension.

unregisterLoadExtension

void unregisterLoadExtension(java.lang.String name)
                             throws LBParameterException
Removes registration for the given named extension. Upon completion, the extension will no longer be available for lookup from the LexBIG service.

Parameters:
name - The extension name; not null.
Throws:
LBParameterException - If the given name does not match a registered extension.

unregisterSortExtension

void unregisterSortExtension(java.lang.String name)
                             throws LBParameterException
Removes registration for the given named extension. Upon completion, the extension will no longer be available for lookup from the LexBIG service.

Parameters:
name - The extension name; not null.
Throws:
LBParameterException - If the given name does not match a registered extension.

unregisterSearchExtension

void unregisterSearchExtension(java.lang.String name)
                               throws LBParameterException
Throws:
LBParameterException

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.