org.processmining.hadoop.AlphaMiner.algorithms.utils

Class Searcher<N>

java.lang.Object

org.processmining.hadoop.AlphaMiner.algorithms.utils.Searcher<N>

public class Searcher<N>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	BREADTHFIRST Constant representing a BREADTH-FIRST search.
static int	DEPTHFIRST Constant representing a DEPTH-FIRST search.

Constructor Summary

Constructors

Constructor and Description
Searcher(int numberOfThreads, org.processmining.framework.util.search.NodeExpander<N> expander, org.processmining.framework.util.search.ExpandCollection<N> expandCollection) Instantiates a searcher.
Searcher(int numberOfThreads, org.processmining.framework.util.search.NodeExpander<N> expander, int searchType) Instantiates a searcher.
Searcher(org.processmining.framework.util.search.NodeExpander<N> expander, org.processmining.framework.util.search.ExpandCollection<N> expandCollection) Instantiates a searcher.
Searcher(org.processmining.framework.util.search.NodeExpander<N> expander, int searchType) Instantiates a searcher.

Method Summary

Methods

Modifier and Type	Method and Description
void	addInitialNodes(java.util.Collection<N> initialNodes) Sets the initial nodes of the search tree.
void	addInitialNodes(N... initialNodes) Sets the initial nodes of the search tree.
void	startSearch(java.util.concurrent.ExecutorService executor, java.util.Collection<N> resultCollection) A call to this method initiates the search.

Methods inherited from class java.lang.Object

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

Field Detail

DEPTHFIRST

public static final int DEPTHFIRST

Constant representing a DEPTH-FIRST search.

See Also:

Constant Field Values

BREADTHFIRST

public static final int BREADTHFIRST

Constant representing a BREADTH-FIRST search.

See Also:

Constant Field Values

Constructor Detail

Searcher

public Searcher(int numberOfThreads,
        org.processmining.framework.util.search.NodeExpander<N> expander,
        int searchType)

Instantiates a searcher. The searcher will use as many threads as specified. Furthermore, the given expander is used for the expansion of search nodes and the processing of leaf nodes. The searchtype can be either DEPTHFIRST, or BREADTHFIRST. In the first case, new nodes produced by the expand method of the expander are added to the bottom of the stack, whereas in the latter case, the new nodes are pushed to the top of the stack.

Parameters:

numberOfThreads - specifies the number of threads to use. If unsure how to set this value, use the other constructor without this parameter

expander - The expander that will be used to expand each search node and process the leafs of the search tree

searchType - the type of search, either DEPTHFIRST or BREADTHFIRST

Searcher

public Searcher(org.processmining.framework.util.search.NodeExpander<N> expander,
        int searchType)

Instantiates a searcher. The searcher will use as many threads as the virtual machine reports to have CPUs. Furthermore, the given expander is used for the expansion of search nodes and the processing of leaf nodes. The searchtype can be either DEPTHFIRST, or BREADTHFIRST. In the first case, new nodes produced by the expand method of the expander are added to the bottom of the stack, whereas in the latter case, the new nodes are pushed to the top of the stack. By default, as many threads are used as there are CPUs reported by Runtime.getRuntime().availableProcessors()

Parameters:

expander - The expander that will be used to expand each search node and process the leafs of the search tree

searchType - the type of search, either DEPTHFIRST or BREADTHFIRST

Searcher

public Searcher(int numberOfThreads,
        org.processmining.framework.util.search.NodeExpander<N> expander,
        org.processmining.framework.util.search.ExpandCollection<N> expandCollection)

Instantiates a searcher. The searcher will use as many threads as specified. Furthermore, the given expander is used for the expansion of search nodes and the processing of leaf nodes and the given expandCollection to store nodes that need to be expanded further.

Parameters:

numberOfThreads - specifies the number of threads to use. If unsure how to set this value, use the other constructor without this parameter

expander - The expander that will be used to expand each search node and process the leafs of the search tree

expandCollection - the collection to store nodes that need to be expanded

Searcher

public Searcher(org.processmining.framework.util.search.NodeExpander<N> expander,
        org.processmining.framework.util.search.ExpandCollection<N> expandCollection)

Instantiates a searcher. The searcher will use as many threads as specified. Furthermore, the given expander is used for the expansion of search nodes and the processing of leaf nodes and the given expandCollection to store nodes that need to be expanded further. By default, as many threads are used as there are CPUs reported by Runtime.getRuntime().availableProcessors()

Parameters:

expander - The expander that will be used to expand each search node and process the leafs of the search tree

expandCollection - the collection to store nodes that need to be expanded

Method Detail

addInitialNodes

public void addInitialNodes(java.util.Collection<N> initialNodes)

Sets the initial nodes of the search tree. Note that you can provide an empty collection, in which case the search returns immediately, without calling any methods in the expander.

Parameters:

initialNodes - the collection of initial nodes.

addInitialNodes

public void addInitialNodes(N... initialNodes)

Sets the initial nodes of the search tree. Note that you don't have to provide any nodes, in which case the search returns immediately, without calling any methods in the expander.

Parameters:

initialNodes - zero or more initial nodes.

startSearch

public void startSearch(java.util.concurrent.ExecutorService executor,
               java.util.Collection<N> resultCollection)
                 throws java.lang.InterruptedException,
                        java.util.concurrent.ExecutionException

A call to this method initiates the search. The calling thread is suspended until the search is completed, or the progress was canceled. The resultCollection given to this method is passes through to the processLeaf method of the NodeExpander, i.e. no changes to this collection are made by the searcher.

Parameters:

executor - The executor in which the searcher can schedule it's threads. If called from a plugin, use context.getExector() to pass to this method.

resultCollection - The collection in which the final result is stored by the processLeaf method of the node expander. Note that the searcher does not change this collection in any way, nor does it handle any necessary synchronization.

Throws:

java.lang.InterruptedException - If one of the threads was interupted;

java.util.concurrent.ExecutionException - If one of the threads threw an exception;