Package com.funnelback.filter.api.mock

Class MockFilterContext

java.lang.Object

com.funnelback.filter.api.mock.MockFilterContext

All Implemented Interfaces:

com.funnelback.filter.api.FilterContext, com.funnelback.filter.api.InternalFilterContext, PluginConfigurationFileSettingMock

public class MockFilterContext
extends Object
implements com.funnelback.filter.api.FilterContext, PluginConfigurationFileSettingMock

A Filter context suitable for testing.

Field Summary

Fields

Modifier and Type	Field	Description
private String	collectionName
private com.funnelback.filter.api.DocumentTypeFactory	documentTypeFactory
private com.funnelback.filter.api.FilterDocumentFactory	filterDocumentFactory
private MapBackedConfig	mapBackedConfig
private MapBackedFilterConfigurationFiles	mapBackedFilterConfigurationFiles
private MapBackedPluginConfigurationFiles	mapBackedPluginConfigurationFiles

Constructor Summary

Constructors

Modifier	Constructor	Description
	MockFilterContext()
private	MockFilterContext(String collectionName, com.funnelback.filter.api.FilterDocumentFactory filterDocumentFactory, com.funnelback.filter.api.DocumentTypeFactory documentTypeFactory)

Method Summary

Modifier and Type	Method	Description
Optional<String>	filterConfigurationFile(String filename)
Optional<byte[]>	filterConfigurationFileAsBytes(String filename)
File	getCollectionConfigFile(String filename)
String	getCollectionName()
Set<String>	getConfigKeys()
Map<String,List<String>>	getConfigKeysMatchingPattern(String pattern)
Set<String>	getConfigKeysWithPrefix(String prefix)
String	getConfigSetting(String key)
Optional<String>	getConfigValue(String key)
com.funnelback.filter.api.DocumentTypeFactory	getDocumentTypeFactory()
static MockFilterContext	getEmptyContext()
com.funnelback.filter.api.FilterDocumentFactory	getFilterDocumentFactory()
Optional<String>	pluginConfigurationFile(String filename)
Optional<byte[]>	pluginConfigurationFileAsBytes(String filename)
void	setCollectionName(String collectionName)
void	setConfigSetting(String key, String value)
void	setConfigValue(String key, String value)
void	setDocumentTypeFactory(com.funnelback.filter.api.DocumentTypeFactory documentTypeFactory)
void	setFilterConfigurationFileContent(String filename, String content)
void	setFilterConfigurationFileContentAsBytes(String filename, byte[] content)
void	setFilterDocumentFactory(com.funnelback.filter.api.FilterDocumentFactory filterDocumentFactory)
void	setPlugingConfigurationFileContent(String filename, String content)	Sets the content of a plugin configuration file on the mock.
void	setPlugingConfigurationFileContentAsBytes(String filename, byte[] content)	Sets the content of a plugin configuration file on the mock.
MockFilterContext	withDocumentTypeFactory(com.funnelback.filter.api.DocumentTypeFactory documentTypeFactory)
MockFilterContext	withFilterDocumentFactory(com.funnelback.filter.api.FilterDocumentFactory filterDocumentFactory)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mapBackedConfig

private final MapBackedConfig mapBackedConfig

mapBackedFilterConfigurationFiles

private final MapBackedFilterConfigurationFiles mapBackedFilterConfigurationFiles

mapBackedPluginConfigurationFiles

private final MapBackedPluginConfigurationFiles mapBackedPluginConfigurationFiles

collectionName

private String collectionName

filterDocumentFactory

private com.funnelback.filter.api.FilterDocumentFactory filterDocumentFactory

documentTypeFactory

private com.funnelback.filter.api.DocumentTypeFactory documentTypeFactory

Constructor Detail

MockFilterContext

public MockFilterContext()

MockFilterContext

private MockFilterContext(String collectionName,
                          com.funnelback.filter.api.FilterDocumentFactory filterDocumentFactory,
                          com.funnelback.filter.api.DocumentTypeFactory documentTypeFactory)

Method Detail

getConfigValue

public Optional<String> getConfigValue(String key)

Specified by:

getConfigValue in interface com.funnelback.filter.api.FilterContext

setConfigValue

public void setConfigValue(String key,
                           String value)

getEmptyContext

public static MockFilterContext getEmptyContext()

getCollectionName

public String getCollectionName()

Specified by:

getCollectionName in interface com.funnelback.filter.api.FilterContext

setCollectionName

public void setCollectionName(String collectionName)

getFilterDocumentFactory

public com.funnelback.filter.api.FilterDocumentFactory getFilterDocumentFactory()

Specified by:

getFilterDocumentFactory in interface com.funnelback.filter.api.FilterContext

setFilterDocumentFactory

public void setFilterDocumentFactory(com.funnelback.filter.api.FilterDocumentFactory filterDocumentFactory)

withFilterDocumentFactory

public MockFilterContext withFilterDocumentFactory(com.funnelback.filter.api.FilterDocumentFactory filterDocumentFactory)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

getDocumentTypeFactory

public com.funnelback.filter.api.DocumentTypeFactory getDocumentTypeFactory()

Specified by:

getDocumentTypeFactory in interface com.funnelback.filter.api.FilterContext

setDocumentTypeFactory

public void setDocumentTypeFactory(com.funnelback.filter.api.DocumentTypeFactory documentTypeFactory)

withDocumentTypeFactory

public MockFilterContext withDocumentTypeFactory(com.funnelback.filter.api.DocumentTypeFactory documentTypeFactory)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

setConfigSetting

public void setConfigSetting(String key,
                             String value)

getConfigSetting

public String getConfigSetting(String key)

getConfigKeys

public Set<String> getConfigKeys()

Specified by:

getConfigKeys in interface com.funnelback.filter.api.FilterContext

getConfigKeysWithPrefix

public Set<String> getConfigKeysWithPrefix(String prefix)

Specified by:

getConfigKeysWithPrefix in interface com.funnelback.filter.api.FilterContext

getConfigKeysMatchingPattern

public Map<String,List<String>> getConfigKeysMatchingPattern(String pattern)

Specified by:

getConfigKeysMatchingPattern in interface com.funnelback.filter.api.FilterContext

setFilterConfigurationFileContent

public void setFilterConfigurationFileContent(String filename,
                                              String content)

setFilterConfigurationFileContentAsBytes

public void setFilterConfigurationFileContentAsBytes(String filename,
                                                     byte[] content)

filterConfigurationFileAsBytes

public Optional<byte[]> filterConfigurationFileAsBytes(String filename)

Specified by:

filterConfigurationFileAsBytes in interface com.funnelback.filter.api.InternalFilterContext

filterConfigurationFile

public Optional<String> filterConfigurationFile(String filename)

Specified by:

filterConfigurationFile in interface com.funnelback.filter.api.InternalFilterContext

getCollectionConfigFile

public File getCollectionConfigFile(String filename)

Specified by:

getCollectionConfigFile in interface com.funnelback.filter.api.InternalFilterContext

setPlugingConfigurationFileContent

public void setPlugingConfigurationFileContent(String filename,
                                               String content)

Description copied from interface: PluginConfigurationFileSettingMock

Sets the content of a plugin configuration file on the mock.

Specified by:

setPlugingConfigurationFileContent in interface PluginConfigurationFileSettingMock

Parameters:

filename - the name of the plugins configuration file e.g. maps.cfg

setPlugingConfigurationFileContentAsBytes

public void setPlugingConfigurationFileContentAsBytes(String filename,
                                                      byte[] content)

Description copied from interface: PluginConfigurationFileSettingMock

Sets the content of a plugin configuration file on the mock.

Specified by:

setPlugingConfigurationFileContentAsBytes in interface PluginConfigurationFileSettingMock

Parameters:

filename - the name of the plugins configuration file e.g. maps.cfg

pluginConfigurationFileAsBytes

public Optional<byte[]> pluginConfigurationFileAsBytes(String filename)

Specified by:

pluginConfigurationFileAsBytes in interface com.funnelback.filter.api.FilterContext

pluginConfigurationFile

public Optional<String> pluginConfigurationFile(String filename)

Specified by:

pluginConfigurationFile in interface com.funnelback.filter.api.FilterContext