com.atlassian.confluence.plugin.descriptor.search
Class AbstractLuceneMapperModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Object>
      com.atlassian.confluence.plugin.descriptor.search.AbstractLuceneMapperModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<java.lang.Object>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware

Direct Known Subclasses:

LuceneQueryMapperModuleDescriptor, LuceneResultFilterMapperModuleDescriptor, LuceneSearchFilterMapperModuleDescriptor, LuceneSortMapperModuleDescriptor

public abstract class AbstractLuceneMapperModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Object>

Field Summary

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton

Constructor Summary

protected

AbstractLuceneMapperModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

void	disabled()
void	enabled()
java.util.Collection<java.lang.String>	getHandledKeys()
java.lang.Object	getModule()
protected PluginModuleFactory<java.lang.Object>	getModuleFactory()
boolean	handles(java.lang.String key)
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractLuceneMapperModuleDescriptor

protected AbstractLuceneMapperModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<java.lang.Object>

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Object>

Throws:

com.atlassian.plugin.PluginParseException

handles

public boolean handles(java.lang.String key)

getHandledKeys

public java.util.Collection<java.lang.String> getHandledKeys()

Returns:

the keys that are handled by the module.

getModule

public java.lang.Object getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<java.lang.Object>

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Object>

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Object>

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Object>

getModuleFactory

protected PluginModuleFactory<java.lang.Object> getModuleFactory()