com.force.i18n.commons.text

Class GenericTrieMatcher<T>

java.lang.Object

com.force.i18n.commons.text.GenericTrieMatcher<T>

@Beta
public class GenericTrieMatcher<T>
extends Object

A trie matcher that uses tokens instead of strings. It's not nearly as efficient, since it uses a regular hashmap instead of a nice IntHashMap to store the trie matches, but it's similar. If you want to use this for an AST or an enum, you probably want to genericize this to take in The parameter is the token, it can be an enum or an Id. Beta class. Classes under com.force.i18n.commons package will be moved into a dedicated project.

Author:

stamm

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenericTrieMatcher.GenericTrieMatch<K> Struct returned by TrieMatcher#match(String) to represent a match.
static interface	GenericTrieMatcher.MatchValidator<K> An interface that represents whether a match for a given string is "valid"

Method Summary

Modifier and Type	Method and Description
boolean	begins(List<T> s)
static <TOKEN> GenericTrieMatcher<TOKEN>	compile(List<? extends List<TOKEN>> searches, List<? extends List<TOKEN>> replacements) This is not the cheapest of operations.
static <TOKEN> GenericTrieMatcher<TOKEN>	compile(List<? extends List<TOKEN>> searches, List<? extends List<TOKEN>> replacements, Class<TOKEN> tokenClass) This is not the cheapest of operations.
boolean	containedIn(List<T> s)
List<T>	findIn(List<T> s, int start) Find the next match in s.
GenericTrieMatcher.GenericTrieMatch<T>	match(List<T> s, int offset) See if the given string matches any of the given words in the Trie
static <T> List<T>	replaceMultiple(List<T> s, GenericTrieMatcher<T> trieMatcher) Search and replace multiple strings in s given the the words and replacements given in TrieMatcher.
static <T> List<T>	replaceMultiple(List<T> s, GenericTrieMatcher<T> trieMatcher, GenericTrieMatcher.MatchValidator<T> validator) Search and replace multiple strings in s given the the words and replacements given in TrieMatcher and a validation strategy

Methods inherited from class java.lang.Object

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

Method Detail

compile

public static <TOKEN> GenericTrieMatcher<TOKEN> compile(List<? extends List<TOKEN>> searches,
                                                        List<? extends List<TOKEN>> replacements)

This is not the cheapest of operations.

Parameters:

searches - this is the list of words that make up the Trie. It is assumed that the lists are not modified once passed into the Trie

replacements - the list of words that can be used to replace those words. It is assumed that the lists are not modified once passed into the Trie

compile

public static <TOKEN> GenericTrieMatcher<TOKEN> compile(List<? extends List<TOKEN>> searches,
                                                        List<? extends List<TOKEN>> replacements,
                                                        Class<TOKEN> tokenClass)

This is not the cheapest of operations.

Parameters:

searches - this is the list of words that make up the Trie. It is assumed that the lists are not modified once passed into the Trie

replacements - the list of words that can be used to replace those words. It is assumed that the lists are not modified once passed into the Trie

tokenClass - based on the class, a more efficient trie map can be generated

replaceMultiple

public static final <T> List<T> replaceMultiple(List<T> s,
                                                GenericTrieMatcher<T> trieMatcher)

Search and replace multiple strings in s given the the words and replacements given in TrieMatcher.

Note, using a Trie for matching multiple strings can be much faster than the using #replace(String, String[], String[]), however, due to the cost of creating the Trie, this is best used when 1) you will reuse the Trie many times 2) you have a large set of strings your are searching on

Note, regexes aren't supported by this, see #replace(String, String[], String[]).

Parameters:

s - the text you are searching in

trieMatcher - the trie representing the words to search and replace for

Returns:

the text with the search words swapped by the replacements

replaceMultiple

public static final <T> List<T> replaceMultiple(List<T> s,
                                                GenericTrieMatcher<T> trieMatcher,
                                                GenericTrieMatcher.MatchValidator<T> validator)

Search and replace multiple strings in s given the the words and replacements given in TrieMatcher and a validation strategy

Parameters:

s - the text you are searching in

trieMatcher - the trie representing the words to search and replace for

validator - the optional code that validates whether a match should be accepted or not.

Returns:

the text with the search words swapped by the replacements

containedIn

public boolean containedIn(List<T> s)

Parameters:

s - the term to search for the terms of the trie in

Returns:

true if the any of the terms are contained in s

begins

public boolean begins(List<T> s)

Parameters:

s - the term to see if it starts with any terms of the trie

findIn

public List<T> findIn(List<T> s,
                      int start)

Find the next match in s.

Parameters:

s - the term to search for the terms of the trie in

start - the 0-based position to start the search from.

Returns:

null if no match found

match

public GenericTrieMatcher.GenericTrieMatch<T> match(List<T> s,
                                                    int offset)

See if the given string matches any of the given words in the Trie

Parameters:

offset - where to start looking inside of the given String.

Returns:

null if none are found.