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

java.lang.Object
  extended by com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>
      extended by com.atlassian.confluence.plugin.descriptor.search.AbstractLuceneMapperModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor<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<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(com.atlassian.plugin.Plugin plugin, org.dom4j.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(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException
Specified by:
init in interface com.atlassian.plugin.ModuleDescriptor<Object>
Overrides:
init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>
Throws:
com.atlassian.plugin.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 com.atlassian.plugin.ModuleDescriptor<Object>
Specified by:
getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>

enabled

public void enabled()
Specified by:
enabled in interface com.atlassian.plugin.StateAware
Overrides:
enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>

disabled

public void disabled()
Specified by:
disabled in interface com.atlassian.plugin.StateAware
Overrides:
disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>

getModuleFactory

protected PluginModuleFactory<Object> getModuleFactory()


Copyright © 2003-2011 Atlassian. All Rights Reserved.