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

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

All Implemented Interfaces:

ModuleDescriptor<Object>, Resourced, StateAware

Direct Known Subclasses:

LuceneQueryMapperModuleDescriptor, LuceneResultFilterMapperModuleDescriptor, LuceneSearchFilterMapperModuleDescriptor, LuceneSortMapperModuleDescriptor

public abstract class AbstractLuceneMapperModuleDescriptor
extends AbstractModuleDescriptor<Object>

Field Summary

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

moduleClass, moduleClassName, moduleFactory, plugin, resources, singleton

Constructor Summary

AbstractLuceneMapperModuleDescriptor()

Method Summary

void	disabled()
void	enabled()
Collection<String>	getHandledKeys()
Object	getModule()
protected PluginModuleFactory<Object>	getModuleFactory()
boolean	handles(String key)
void	init(Plugin plugin, Element element)

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

assertModuleClassImplements, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, 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

public AbstractLuceneMapperModuleDescriptor()

Method Detail

init

public void init(Plugin plugin,
                 Element element)
          throws PluginParseException

Specified by:

init in interface ModuleDescriptor<Object>

Overrides:

init in class AbstractModuleDescriptor<Object>

Throws:

PluginParseException

handles

public boolean handles(String key)

getHandledKeys

public Collection<String> getHandledKeys()

Returns:

the keys that are handled by the module.

getModule

public Object getModule()

Specified by:

getModule in interface ModuleDescriptor<Object>

Specified by:

getModule in class AbstractModuleDescriptor<Object>

enabled

public void enabled()

Specified by:

enabled in interface StateAware

Overrides:

enabled in class AbstractModuleDescriptor<Object>

disabled

public void disabled()

Specified by:

disabled in interface StateAware

Overrides:

disabled in class AbstractModuleDescriptor<Object>

getModuleFactory

protected PluginModuleFactory<Object> getModuleFactory()