edu.wisc.ssec.mcidasv.util.trie

Class StringListKeyAnalyzer

java.lang.Object

edu.wisc.ssec.mcidasv.util.trie.StringListKeyAnalyzer

All Implemented Interfaces:

PatriciaTrie.KeyAnalyzer<java.util.List<java.lang.String>>, java.io.Serializable, java.util.Comparator<java.util.List<java.lang.String>>

public class StringListKeyAnalyzer
extends java.lang.Object
implements PatriciaTrie.KeyAnalyzer<java.util.List<java.lang.String>>

See Also:

Serialized Form

Field Summary

Fields inherited from interface edu.wisc.ssec.mcidasv.util.trie.PatriciaTrie.KeyAnalyzer

EQUAL_BIT_KEY, NULL_BIT_KEY

Constructor Summary

Constructors

Constructor and Description
StringListKeyAnalyzer()

Method Summary

Modifier and Type	Method and Description
int	bitIndex(java.util.List<java.lang.String> key, int keyStart, int keyLength, java.util.List<java.lang.String> found, int foundStart, int foundLength) Returns the n-th different bit between key and found.
int	bitsPerElement() Returns the number of bits per element in the key.
int	compare(java.util.List<java.lang.String> o1, java.util.List<java.lang.String> o2)
boolean	isBitSet(java.util.List<java.lang.String> key, int keyLength, int bitIndex) Returns whether or not a bit is set
boolean	isPrefix(java.util.List<java.lang.String> prefix, int offset, int length, java.util.List<java.lang.String> key) Determines whether or not the given prefix (from offset to length) is a prefix of the given key.
int	length(java.util.List<java.lang.String> key) Returns the length of the Key in bits.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

StringListKeyAnalyzer

public StringListKeyAnalyzer()

Method Detail

bitIndex

public int bitIndex(java.util.List<java.lang.String> key,
                    int keyStart,
                    int keyLength,
                    java.util.List<java.lang.String> found,
                    int foundStart,
                    int foundLength)

Description copied from interface: PatriciaTrie.KeyAnalyzer

Returns the n-th different bit between key and found. This starts the comparison in key at 'keyStart' and goes for 'keyLength' bits, and compares to the found key starting at 'foundStart' and going for 'foundLength' bits.

Specified by:

bitIndex in interface PatriciaTrie.KeyAnalyzer<java.util.List<java.lang.String>>

Returns:

bitsPerElement

public int bitsPerElement()

Description copied from interface: PatriciaTrie.KeyAnalyzer

Returns the number of bits per element in the key. This is only useful for variable-length keys, such as Strings.

Specified by:

bitsPerElement in interface PatriciaTrie.KeyAnalyzer<java.util.List<java.lang.String>>

Returns:

Bits per key element.

isBitSet

public boolean isBitSet(java.util.List<java.lang.String> key,
                        int keyLength,
                        int bitIndex)

Description copied from interface: PatriciaTrie.KeyAnalyzer

Returns whether or not a bit is set

Specified by:

isBitSet in interface PatriciaTrie.KeyAnalyzer<java.util.List<java.lang.String>>

isPrefix

public boolean isPrefix(java.util.List<java.lang.String> prefix,
                        int offset,
                        int length,
                        java.util.List<java.lang.String> key)

Description copied from interface: PatriciaTrie.KeyAnalyzer

Determines whether or not the given prefix (from offset to length) is a prefix of the given key.

Specified by:

isPrefix in interface PatriciaTrie.KeyAnalyzer<java.util.List<java.lang.String>>

Returns:

true if prefix matches the given offset start and length for key.

length

public int length(java.util.List<java.lang.String> key)

Description copied from interface: PatriciaTrie.KeyAnalyzer

Returns the length of the Key in bits.

Specified by:

length in interface PatriciaTrie.KeyAnalyzer<java.util.List<java.lang.String>>

Parameters:

key - Key whose length should be computed.

Returns:

Length of key.

compare

public int compare(java.util.List<java.lang.String> o1,
                   java.util.List<java.lang.String> o2)

Specified by:

compare in interface java.util.Comparator<java.util.List<java.lang.String>>