org.processmining.stream.config.interfaces

Class MinerConfiguration

java.lang.Object

org.processmining.stream.config.interfaces.MinerConfiguration

Direct Known Subclasses:

BudgetLossyCountingMinerConfiguration, LossyCountingMinerConfiguration, SlidingWindowHMConfiguration, SpaceSavingMinerConfiguration

public abstract class MinerConfiguration
extends java.lang.Object

This interface represents the main interface to the configuration of mining plugins.

Author:

Andrea Burattin

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<Configuration>	configurations
protected java.util.List<java.lang.Class<? extends Configuration>>	requiredConfigurations

Constructor Summary

Constructors

Constructor and Description
MinerConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addConfiguration(Configuration configuration) This method adds a new configuration to the current miner configuration
boolean	containsConfiguration(java.lang.Class<? extends Configuration> requiredConfiguration) This method checks whether the provided configuration is available or not
Configuration	getConfiguration(java.lang.Class<? extends Configuration> requiredConfiguration) This method returns the configuration required
java.util.List<java.lang.Class<? extends Configuration>>	getRequiredConfigurations() This method returns the list of configurations required by the algorithm
boolean	validateConfiguration() This method validates the current configuration with respect to the required configurations

Methods inherited from class java.lang.Object

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

Field Detail

requiredConfigurations

protected java.util.List<java.lang.Class<? extends Configuration>> requiredConfigurations

configurations

protected java.util.ArrayList<Configuration> configurations

Constructor Detail

MinerConfiguration

public MinerConfiguration()

Method Detail

addConfiguration

public void addConfiguration(Configuration configuration)

This method adds a new configuration to the current miner configuration

Parameters:

configuration - the new configuration perspective to add

getConfiguration

public Configuration getConfiguration(java.lang.Class<? extends Configuration> requiredConfiguration)

This method returns the configuration required

Parameters:

requiredConfiguration - the configuration to return

Returns:

the required configuration, or null if it is not available

containsConfiguration

public boolean containsConfiguration(java.lang.Class<? extends Configuration> requiredConfiguration)

This method checks whether the provided configuration is available or not

Parameters:

requiredConfiguration - the configuration to check

Returns:

true if the required configuration is available, false otherwise

validateConfiguration

public boolean validateConfiguration()
                              throws MissingConfigurationException

This method validates the current configuration with respect to the required configurations

Returns:

true if the current configuration fulfills all required parameters, false otherwise

Throws:

MissingConfigurationException

getRequiredConfigurations

public java.util.List<java.lang.Class<? extends Configuration>> getRequiredConfigurations()

This method returns the list of configurations required by the algorithm

Returns:

the list of configuration classes required