net.amygdalum.stringsearchalgorithms.search.chars

Class QGramShiftOr

java.lang.Object

net.amygdalum.stringsearchalgorithms.search.chars.QGramShiftOr

All Implemented Interfaces:

StringSearchAlgorithm

public class QGramShiftOr
extends Object
implements StringSearchAlgorithm

An implementation of the String Search Algorithm Shift-Or (or Baeza-Yates–Gonnet). This algorithm takes a single pattern as input and generates a finder which can find this pattern in documents

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QGramShiftOr.BitMapStates
static class	QGramShiftOr.Factory

Constructor Summary

Constructors

Constructor and Description
QGramShiftOr(Collection<String> patterns)
QGramShiftOr(Collection<String> patterns, net.amygdalum.util.text.CharMapping mapping)
QGramShiftOr(Collection<String> patterns, net.amygdalum.util.text.QGramMapping qmapping, net.amygdalum.util.text.CharMapping mapping)

Method Summary

Modifier and Type	Method and Description
static net.amygdalum.util.text.QGramMapping	bestMapping(Collection<String> patterns)
StringFinder	createFinder(CharProvider chars, StringFinderOption... options) creates a StringFinder instance from the pattern (given by the current instance) and the given document.
int	getPatternLength()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

QGramShiftOr

public QGramShiftOr(Collection<String> patterns)

QGramShiftOr

public QGramShiftOr(Collection<String> patterns,
                    net.amygdalum.util.text.CharMapping mapping)

QGramShiftOr

public QGramShiftOr(Collection<String> patterns,
                    net.amygdalum.util.text.QGramMapping qmapping,
                    net.amygdalum.util.text.CharMapping mapping)

Method Detail

bestMapping

public static net.amygdalum.util.text.QGramMapping bestMapping(Collection<String> patterns)

getPatternLength

public int getPatternLength()

Specified by:

getPatternLength in interface StringSearchAlgorithm

Returns:

the length of the given pattern (min length in case of a multi string algorithm)

createFinder

public StringFinder createFinder(CharProvider chars,
                                 StringFinderOption... options)

Description copied from interface: StringSearchAlgorithm

creates a StringFinder instance from the pattern (given by the current instance) and the given document.

Specified by:

createFinder in interface StringSearchAlgorithm

Parameters:

chars - the given document wrapped into a CharProvider

options - the configuration options for the string finder

Returns:

a StringFinder that can iterate over the matches

toString

public String toString()

Overrides:

toString in class Object