SMCollectionMapping (ProCAKE Framework 3.0.1-SNAPSHOT API)

All Superinterfaces:

SimilarityMeasure, SMCollection

All Known Implementing Classes:

SMCollectionMappingImpl
```
public interface SMCollectionMapping
extends SMCollection
```
The CollectionMapping performs a best possible mapping of the query items to the case items of the collection. Note that not all case items have to be utilized in the mapping, but all query items are tried to map. Each query element can only be mapped on a case element, which hasn't already a mapping partner. If more query items than case items exist, some query items will get similarity 0 (which will add up to the complete similarity). If more case items than query items exist, then this will not interfere with the similarity-value (rather gives more possible match-scenarios).

Author:

Alexander Stromer

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`DEFAULT_MAX_QUEUE_SIZE`	Default maximum size of the solution queue is 1000
`static String`	`NAME`	Name of similarity measure is "CollectionMapping".

Fields inherited from interface de.uni_trier.wi2.procake.similarity.SimilarityMeasure
COMPONENT, COMPONENT_KEY, LOG_ORDER_NAME_NOT_FOUND

Fields inherited from interface de.uni_trier.wi2.procake.similarity.base.collection.SMCollection
LOG_ATTRIBUTE_NAME_NOT_FOUND

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`getMaxQueueSize()`	Gets the queue size of the A* measure
`void`	`setMaxQueueSize(int qSize)`	Sets the maximum size of the queue that stores the (partial) solutions of the A* algorithm.

Methods inherited from interface de.uni_trier.wi2.procake.similarity.SimilarityMeasure
compute, getDataClass, getName, getSystemName, isForceOverride, isReusable, setForceOverride

Methods inherited from interface de.uni_trier.wi2.procake.similarity.base.collection.SMCollection
getSimilarityToUse, setSimilarityToUse

- Field Detail
  - NAME
```
static final String NAME
```
    Name of similarity measure is "CollectionMapping".
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_QUEUE_SIZE
```
static final int DEFAULT_MAX_QUEUE_SIZE
```
    Default maximum size of the solution queue is 1000
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getMaxQueueSize
```
int getMaxQueueSize()
```
    Gets the queue size of the A* measure
    
    Returns:
    
    The maximum queue size
  - setMaxQueueSize
```
void setMaxQueueSize(int qSize)
```
    Sets the maximum size of the queue that stores the (partial) solutions of the A* algorithm. If the current queue grows larger than the set maximum, the lowest ranked solutions will be removed. Setting a negative value disables pruning of the queue.
    
    Parameters:
    
    qSize - The maximum queue size