net.amygdalum.stringsearchalgorithms.patternsearch.chars

Interface FactorExtender

All Known Implementing Classes:

GlushkovFactorExtender, GlushkovPrefixExtender

public interface FactorExtender

FactorExtenders can extend factors of a pattern found in a character source to the complete pattern (if such exists).

Method Summary

Modifier and Type	Method and Description
SortedSet<StringMatch>	extendFactor(CharProvider chars, boolean longest) extends a given factor found in a character source to a pattern match in this character source (if such exists)
FactorExtender	forFactor(String factor) initializes this FactorExtender with the matched factor.
List<String>	getBestFactors(int max) computes the factors considered best for the given pattern and a given maximum length.
String	getPattern()
int	getPatternLength()
boolean	hasFactor(String factor)

Method Detail

getPattern

String getPattern()

Returns:

the pattern that will be extended with this extender

getPatternLength

int getPatternLength()

Returns:

the minimum match length the pattern would match

getBestFactors

List<String> getBestFactors(int max)

computes the factors considered best for the given pattern and a given maximum length. Each such factor must not be longer than max.

Parameters:

max - the maximum length that the result factors should comply to

Returns:

the factors

extendFactor

SortedSet<StringMatch> extendFactor(CharProvider chars,
                                    boolean longest)

extends a given factor found in a character source to a pattern match in this character source (if such exists)

Parameters:

chars - a CharProvider with position just behind the current factor

longest - true if this method should return the longest patterns including this factor, otherwise are returned

Returns:

the matches that include the param factor

forFactor

FactorExtender forFactor(String factor)

initializes this FactorExtender with the matched factor. Each factor returned by getBestFactors should be a valid input param. Also "" (empty string) should init the extender in such a way that any best factor could be matched

Parameters:

factor - the factor this matcher will be able to extend

Returns:

the initialized factor extender

hasFactor

boolean hasFactor(String factor)

Parameters:

factor - the factor to compare to the pattern

Returns:

true if the pattern can contain the given factor, false otherwise