Package net.sf.okapi.common.filters

Class ThreadSafeFilterConfigurationMapper

java.lang.Object

net.sf.okapi.common.filters.ThreadSafeFilterConfigurationMapper

All Implemented Interfaces:

Iterable<FilterConfiguration>, IFilterConfigurationMapper

public class ThreadSafeFilterConfigurationMapper
extends Object
implements IFilterConfigurationMapper

Will replace FilterConfigurationMapper in the future as the default implementation Implementation of IFilterConfigurationMapper, without some of the eccentricities of FilterConfigurationMapper. In particular,this one is thread safe by allowing thread local custom configs to be registered. Should be used in most server-based implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ThreadSafeFilterConfigurationMapper.ConfigBuilder	Load one or more filter classes and prepare their FilterConfiguration objects.

Field Summary

Fields inherited from interface net.sf.okapi.common.filters.IFilterConfigurationMapper

CONFIGFILE_EXT, CONFIGFILE_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
ThreadSafeFilterConfigurationMapper()	Create an empty IFilterConfigurationMapper
ThreadSafeFilterConfigurationMapper(Supplier<Map<String,FilterConfiguration>> fcSupplier)	Create IFilterConfigurationMapper using the Supplier Example:

Method Summary

Modifier and Type	Method	Description
void	addConfiguration(FilterConfiguration config)	Adds a new configuration to this mapper.
void	addConfigurations(String filterClass)	Adds all the predefined configurations of a given filter to this mapper.
void	addCustomConfiguration(String configId, String parameters)	Add a custom FilterConfiguration with IParameters
void	addCustomConfiguration(String configId, IParameters parameters)	Add a custom FilterConfiguration with IParameters
void	clearConfigurations(boolean customOnly)	Removes configuration mappings from this mapper.
IParametersEditor	createConfigurationEditor(String configId)	Creates an instance of the filter's parameters editor for a given configuration identifier.
IParametersEditor	createConfigurationEditor(String configId, IFilter existingFilter)	Creates an instance of the filter's parameters editor for a given configuration identifier.
FilterConfiguration	createCustomConfiguration(FilterConfiguration baseConfig)	Creates a custom configuration object based on a give one.
IFilter	createFilter(String configId)	Creates an instance of the filter for a given configuration identifier and loads its corresponding parameters.
IFilter	createFilter(String configId, IFilter existingFilter)	Deprecated. use createFilter(String) instead
void	deleteCustomParameters(FilterConfiguration config)	Deletes the parameters of a custom configuration.
void	forEach(Consumer<? super FilterConfiguration> action)
Iterator<FilterConfiguration>	getAllConfigurations()	Gets an iterator on all configurations objects for this mapper.
FilterConfiguration	getConfiguration(String configId)	Gets the FilterConfiguration object for a given configuration identifier.
IParameters	getCustomParameters(FilterConfiguration config)	Gets the parameters for a given custom filter configuration.
IParameters	getCustomParameters(FilterConfiguration config, IFilter existingFilter)	Gets the parameters for a given custom filter configuration.
FilterConfiguration	getDefaultConfiguration(String mimeType)	Gets the first filter configuration for a given MIME type.
FilterConfiguration	getDefaultConfigurationFromExtension(String ext)	Gets the first filter configuration for a given extension.
List<FilterConfiguration>	getFilterConfigurations(String filterClass)	Gets a list of all FilterConfiguration objects for a given filter class.
List<FilterInfo>	getFiltersInfo()	Gets a list of information on all filters in this mapper.
List<FilterConfiguration>	getMimeConfigurations(String mimeType)	Gets a list of all FilterConfiguration objects for a given MIME type.
IParameters	getParameters(FilterConfiguration config)	Gets the parameters for a given configuration (predefined or custom).
IParameters	getParameters(FilterConfiguration config, IFilter existingFilter)	Gets the parameters for a given configuration (predefined or custom).
Iterator<FilterConfiguration>	iterator()
void	removeConfiguration(String configId)	Removes a given configuration from this mapper.
void	removeConfigurations(String filterClass)	Removes all the configurations (predefined and custom) of a given filter from this mapper.
void	saveCustomParameters(FilterConfiguration config, IParameters params)	Saves the parameters of a custom configuration.
Spliterator<FilterConfiguration>	spliterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.okapi.common.filters.IFilterConfigurationMapper

addCustomConfiguration

Constructor Detail

ThreadSafeFilterConfigurationMapper

public ThreadSafeFilterConfigurationMapper()

Create an empty IFilterConfigurationMapper

ThreadSafeFilterConfigurationMapper

public ThreadSafeFilterConfigurationMapper(Supplier<Map<String,FilterConfiguration>> fcSupplier)

Create IFilterConfigurationMapper using the Supplier Example:

 private Map myConfigLoad() {
 // this is my implementation loading the filters it needs
 }

 // client code
 IFilterConfigurationMapper fcMapper =
 new ThreadSafeFilterConfigurationMapper(() -> MyClass::myConfigLoad);
 

Parameters:

fcSupplier - user implemented FilterConfiguration map.

Method Detail

addCustomConfiguration

public void addCustomConfiguration(String configId,
                                   IParameters parameters)

Description copied from interface: IFilterConfigurationMapper

Add a custom FilterConfiguration with IParameters

Specified by:

addCustomConfiguration in interface IFilterConfigurationMapper

Parameters:

configId - the custom filter config id.

parameters - IParameters for the filter.

addCustomConfiguration

public void addCustomConfiguration(String configId,
                                   String parameters)

Description copied from interface: IFilterConfigurationMapper

Add a custom FilterConfiguration with IParameters

Specified by:

addCustomConfiguration in interface IFilterConfigurationMapper

Parameters:

configId - the custom filter config id.

parameters - parameters as a string for the filter.

addConfigurations

public void addConfigurations(String filterClass)

Description copied from interface: IFilterConfigurationMapper

Adds all the predefined configurations of a given filter to this mapper.

Specified by:

addConfigurations in interface IFilterConfigurationMapper

Parameters:

filterClass - the class name of the filter to lookup.

addConfiguration

public void addConfiguration(FilterConfiguration config)

Description copied from interface: IFilterConfigurationMapper

Adds a new configuration to this mapper.

Specified by:

addConfiguration in interface IFilterConfigurationMapper

Parameters:

config - the configuration to add.

createFilter

@Deprecated
public IFilter createFilter(String configId,
                            IFilter existingFilter)

Deprecated.

use createFilter(String) instead

Returns the IFilter for the given configId.

Specified by:

createFilter in interface IFilterConfigurationMapper

Parameters:

configId - the filter configuration identifier to use for look-up.

existingFilter - currently ignored and is always null

Returns:

the filter instance

clearConfigurations

public void clearConfigurations(boolean customOnly)

Description copied from interface: IFilterConfigurationMapper

Removes configuration mappings from this mapper.

Specified by:

clearConfigurations in interface IFilterConfigurationMapper

Parameters:

customOnly - true to clear only the custom configurations, false to clear all the configurations from this mapper.

createFilter

public IFilter createFilter(String configId)

Description copied from interface: IFilterConfigurationMapper

Creates an instance of the filter for a given configuration identifier and loads its corresponding parameters.

Specified by:

createFilter in interface IFilterConfigurationMapper

Parameters:

configId - the configuration identifier to use for look-up.

Returns:

a new IFilter object (with its parameters loaded) for the given configuration identifier, or null if the object could not be created.

getConfiguration

public FilterConfiguration getConfiguration(String configId)

Description copied from interface: IFilterConfigurationMapper

Gets the FilterConfiguration object for a given configuration identifier.

Specified by:

getConfiguration in interface IFilterConfigurationMapper

Parameters:

configId - the configuration identifier to search for.

Returns:

the FilterConfiguration object for the given configuration identifier, or null if a match could not be found.

getDefaultConfiguration

public FilterConfiguration getDefaultConfiguration(String mimeType)

Description copied from interface: IFilterConfigurationMapper

Gets the first filter configuration for a given MIME type.

Specified by:

getDefaultConfiguration in interface IFilterConfigurationMapper

Parameters:

mimeType - MIME type to search for.

Returns:

the filter configuration for the given MIME type, or null if none is found.

getDefaultConfigurationFromExtension

public FilterConfiguration getDefaultConfigurationFromExtension(String ext)

Description copied from interface: IFilterConfigurationMapper

Gets the first filter configuration for a given extension.

Specified by:

getDefaultConfigurationFromExtension in interface IFilterConfigurationMapper

Parameters:

ext - the extension to search for (must be in the form ".ext" but can be in any case).

Returns:

the filter configuration for the given extension, or null if none is found.

getParameters

public IParameters getParameters(FilterConfiguration config)

Description copied from interface: IFilterConfigurationMapper

Gets the parameters for a given configuration (predefined or custom).

Specified by:

getParameters in interface IFilterConfigurationMapper

Parameters:

config - the configuration for which the parameters are requested.

Returns:

the parameters object for the given configuration.

See Also:

IFilterConfigurationMapper.getCustomParameters(FilterConfiguration)

getParameters

public IParameters getParameters(FilterConfiguration config,
                                 IFilter existingFilter)

Description copied from interface: IFilterConfigurationMapper

Gets the parameters for a given configuration (predefined or custom).

Specified by:

getParameters in interface IFilterConfigurationMapper

Parameters:

config - the configuration for which the parameters are requested.

existingFilter - optional existing instance of the filter for the given configuration. This argument can be null. If it not null, the provided filter may be used to load the parameters (if it matches the appropriate class). Providing this argument may allow the method to be more efficient by not creating a temporary filter to get an instance of the parameters to load.

Returns:

the parameters object for the given configuration.

createCustomConfiguration

public FilterConfiguration createCustomConfiguration(FilterConfiguration baseConfig)

Description copied from interface: IFilterConfigurationMapper

Creates a custom configuration object based on a give one. The new configuration is not added to the current list.

Specified by:

createCustomConfiguration in interface IFilterConfigurationMapper

Parameters:

baseConfig - the base configuration from which to base the new one.

Returns:

a new FilterConfiguration object set with some default values, or null if the configuration could not be created.

getCustomParameters

public IParameters getCustomParameters(FilterConfiguration config,
                                       IFilter existingFilter)

Description copied from interface: IFilterConfigurationMapper

Gets the parameters for a given custom filter configuration. This method provides a way for this mapper to implements how it retrieves custom filter parameters.

Specified by:

getCustomParameters in interface IFilterConfigurationMapper

Parameters:

config - the custom configuration for which the method should return the filter parameters.

existingFilter - optional existing instance of the filter for the given configuration. This argument can be null. If it not null, the provided filter may be used to load the parameters (if it matches the appropriate class). Providing this argument may allow the method to be more efficient by not creating a temporary filter to get an instance of the parameters to load.

Returns:

the parameters for the given custom filter configuration, or null if the parameters could not be provided, or if the corresponding filter does not have parameters.

getCustomParameters

public IParameters getCustomParameters(FilterConfiguration config)

Description copied from interface: IFilterConfigurationMapper

Gets the parameters for a given custom filter configuration. This method provides a way for this mapper to implements how it retrieves custom filter parameters.

Specified by:

getCustomParameters in interface IFilterConfigurationMapper

Parameters:

config - the custom configuration for which the method should return the filter parameters.

Returns:

the parameters for the given custom filter configuration, or null if the parameters could not be provided, or if the corresponding filter does not have parameters.

See Also:

IFilterConfigurationMapper.getParameters(FilterConfiguration)

getAllConfigurations

public Iterator<FilterConfiguration> getAllConfigurations()

Description copied from interface: IFilterConfigurationMapper

Gets an iterator on all configurations objects for this mapper.

Specified by:

getAllConfigurations in interface IFilterConfigurationMapper

Returns:

an iterator on all configurations for this mapper.

getFilterConfigurations

public List<FilterConfiguration> getFilterConfigurations(String filterClass)

Description copied from interface: IFilterConfigurationMapper

Gets a list of all FilterConfiguration objects for a given filter class.

Specified by:

getFilterConfigurations in interface IFilterConfigurationMapper

Parameters:

filterClass - the class name of the filter to search for.

Returns:

a list of all FilterConfiguration objects found for the given filter class name (the list may be empty).

createConfigurationEditor

public IParametersEditor createConfigurationEditor(String configId,
                                                   IFilter existingFilter)

Description copied from interface: IFilterConfigurationMapper

Creates an instance of the filter's parameters editor for a given configuration identifier.

Specified by:

createConfigurationEditor in interface IFilterConfigurationMapper

Parameters:

configId - the configuration identifier to use for look-up.

existingFilter - an optional existing instance of a filter. This argument can be null. If this argument is not null and matches the filter of the given configuration it is used instead of a temporay instance, to get an instance of the parameters object for which the editor is requested.

Returns:

a new IParametersEditor object for the given configuration identifier, or null if no editor is available or if the object could not be created.

createConfigurationEditor

public IParametersEditor createConfigurationEditor(String configId)

Description copied from interface: IFilterConfigurationMapper

Creates an instance of the filter's parameters editor for a given configuration identifier.

Specified by:

createConfigurationEditor in interface IFilterConfigurationMapper

Parameters:

configId - the configuration identifier to use for look-up.

Returns:

a new IParametersEditor object for the given configuration identifier, or null if no editor is available or if the object could not be created.

getFiltersInfo

public List<FilterInfo> getFiltersInfo()

Description copied from interface: IFilterConfigurationMapper

Gets a list of information on all filters in this mapper.

Specified by:

getFiltersInfo in interface IFilterConfigurationMapper

Returns:

a list of information on all filters in this mapper.

getMimeConfigurations

public List<FilterConfiguration> getMimeConfigurations(String mimeType)

Description copied from interface: IFilterConfigurationMapper

Gets a list of all FilterConfiguration objects for a given MIME type.

Specified by:

getMimeConfigurations in interface IFilterConfigurationMapper

Parameters:

mimeType - mimeType MIME type to search for.

Returns:

a list of all FilterConfiguration objects found for the given MIME type (the list may be empty).

removeConfiguration

public void removeConfiguration(String configId)

Description copied from interface: IFilterConfigurationMapper

Removes a given configuration from this mapper.

Specified by:

removeConfiguration in interface IFilterConfigurationMapper

Parameters:

configId - the identifier of the configuration to remove.

iterator

public Iterator<FilterConfiguration> iterator()

Specified by:

iterator in interface Iterable<FilterConfiguration>

forEach

public void forEach(Consumer<? super FilterConfiguration> action)

Specified by:

forEach in interface Iterable<FilterConfiguration>

spliterator

public Spliterator<FilterConfiguration> spliterator()

Specified by:

spliterator in interface Iterable<FilterConfiguration>

removeConfigurations

public void removeConfigurations(String filterClass)

Description copied from interface: IFilterConfigurationMapper

Removes all the configurations (predefined and custom) of a given filter from this mapper.

Specified by:

removeConfigurations in interface IFilterConfigurationMapper

Parameters:

filterClass - the class name of the filter to lookup.

saveCustomParameters

public void saveCustomParameters(FilterConfiguration config,
                                 IParameters params)

Description copied from interface: IFilterConfigurationMapper

Saves the parameters of a custom configuration. This method provides a way for this mapper to implements how it stores custom filter parameters.

Specified by:

saveCustomParameters in interface IFilterConfigurationMapper

Parameters:

config - the custom configuration for which to save the parameters.

params - the parameters to save.

deleteCustomParameters

public void deleteCustomParameters(FilterConfiguration config)

Description copied from interface: IFilterConfigurationMapper

Deletes the parameters of a custom configuration. This method provides a way for this mapper to implements how it permanently delete custom filter parameters. The actual configuration is not removed from this mapper, you must do it by calling IFilterConfigurationMapper.removeConfiguration(String).

Specified by:

deleteCustomParameters in interface IFilterConfigurationMapper

Parameters:

config - the custom configuration for which to delete the parameters.