Interface SetupContext
-
- All Superinterfaces:
PluginBaseConfigContext
,PluginBaseConfigFileContext
,PluginBaseContext
public interface SetupContext extends PluginBaseContext, PluginBaseConfigContext
Represents the 'setup' of a filter, which includes information about the Funnelback installation and collection for which documents will be filtered.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description File
getCollectionConfigFile(String filename)
Provides access to configuration files inside the collection configuration folder.void
setConfigSetting(String key, String value)
Set the config settings for the current collection.-
Methods inherited from interface com.funnelback.plugin.PluginBaseConfigContext
getConfigKeysMatchingPattern, getConfigKeysWithPrefix, getConfigSetting
-
Methods inherited from interface com.funnelback.plugin.PluginBaseConfigFileContext
pluginConfigurationFile, pluginConfigurationFileAsBytes
-
Methods inherited from interface com.funnelback.plugin.PluginBaseContext
getCollectionName, getSearchHome
-
-
-
-
Method Detail
-
setConfigSetting
void setConfigSetting(String key, String value)
Set the config settings for the current collection.- Parameters:
key
- The name of the collection.cfg or global.cfg parametervalue
- The value to be set for the collection.cfg or global.cfg parameter
-
getCollectionConfigFile
File getCollectionConfigFile(String filename)
Provides access to configuration files inside the collection configuration folder.
This is useful to access custom collection-level configuration files
- Parameters:
filename
- Name of the file to access- Returns:
- A
File
path pointing to the desired file inside the collection configuration folder
-
-