fiftyone.mobile.detection.search

Class SearchBase<T,K,L>

java.lang.Object

fiftyone.mobile.detection.search.SearchBase<T,K,L>

Type Parameters:

T - type of items held in the list

K - type of the keys used to search the list

L - type of the list containing the items

Direct Known Subclasses:

SearchArrays

public abstract class SearchBase<T,K,L>
extends Object

Used to search ordered lists where the overhead of creating an item to use with the Java binarySearch method is unnecessary. The base class is generic to support both arrays and lists.

Constructor Summary

Constructors

Constructor and Description
SearchBase()

Method Summary

Modifier and Type	Method and Description
SearchResult	binarySearch(L list, K key) Core implementation of the binary search.
protected abstract int	compareTo(T item, K key) Compares the key to the item.
protected abstract int	getCount(L list) Gets the count of items in the list.
protected abstract T	getValue(L list, int index) Used to access list values by index in the list.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchBase

public SearchBase()

Method Detail

getCount

protected abstract int getCount(L list)

Gets the count of items in the list.

Parameters:

list - whose is to be returned

Returns:

the number of elements in the list

getValue

protected abstract T getValue(L list,
                              int index)
                       throws IOException

Used to access list values by index in the list.

Parameters:

list - whose value is to be returned

index - of the value to return

Returns:

the value from the list at the index provided.

Throws:

IOException - if there was a problem accessing data file.

compareTo

protected abstract int compareTo(T item,
                                 K key)
                          throws IOException

Compares the key to the item.

Parameters:

item - to be compared against the key.

key - to compare to the item.

Returns:

integer difference.

Throws:

IOException - if there was a problem accessing data file.

binarySearch

public SearchResult binarySearch(L list,
                                 K key)
                          throws IOException

Core implementation of the binary search.

Parameters:

list - list ordered in ascending key value

key - to be found in the list

Returns:

the index of the key, or ones complement if not found

Throws:

IOException - if there was a problem accessing data file.