net.amygdalum.stringsearchalgorithms.search.bytes

Class BOM

java.lang.Object

net.amygdalum.stringsearchalgorithms.search.bytes.BOM

All Implemented Interfaces:

StringSearchAlgorithm

public class BOM
extends Object
implements StringSearchAlgorithm

An implementation of the String Search Algorithm BOM (Backward Oracle Matching). 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 class	BOM.Factory

Constructor Summary

Constructors

Constructor and Description
BOM(String pattern, Charset charset)

Method Summary

Modifier and Type	Method and Description
StringFinder	createFinder(ByteProvider bytes, 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

BOM

public BOM(String pattern,
           Charset charset)

Method Detail

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(ByteProvider bytes,
                                 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:

bytes - the given document wrapped into a ByteProvider

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