Marmelator/aho-corasick
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

pull #17 changes adopted to implement a whole word check on the entire keyword, including whitespaces.

Browse Source
This commit is contained in:
robert-bor 2015-09-22 22:22:20 +02:00
parent 76ae8222ea
commit dc27d6e3e9
3 changed files with 141 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/main/java/org/ahocorasick/trie/Trie.java
View File

@ -80,6 +80,10 @@ public class Trie {
removePartialMatches(text, collectedEmits); removePartialMatches(text, collectedEmits);
} }
if (trieConfig.isOnlyWholeWordsWhiteSpaceSeparated()) {
removePartialMatchesWhiteSpaceSeparated(text, collectedEmits);
}
if (!trieConfig.isAllowOverlaps()) { if (!trieConfig.isAllowOverlaps()) {
IntervalTree intervalTree = new IntervalTree((List<Intervalable>)(List<?>)collectedEmits); IntervalTree intervalTree = new IntervalTree((List<Intervalable>)(List<?>)collectedEmits);
intervalTree.removeOverlaps((List<Intervalable>) (List<?>) collectedEmits); intervalTree.removeOverlaps((List<Intervalable>) (List<?>) collectedEmits);
@ -161,6 +165,21 @@ public class Trie {
} }
} }
private void removePartialMatchesWhiteSpaceSeparated(CharSequence searchText, List<Emit> collectedEmits) {
long size = searchText.length();
List<Emit> removeEmits = new ArrayList<>();
for (Emit emit : collectedEmits) {
if ((emit.getStart() == 0 || Character.isWhitespace(searchText.charAt(emit.getStart() - 1))) &&
(emit.getEnd() + 1 == size || Character.isWhitespace(searchText.charAt(emit.getEnd() + 1)))) {
continue;
}
removeEmits.add(emit);
}
for (Emit removeEmit : removeEmits) {
collectedEmits.remove(removeEmit);
}
}
private State getState(State currentState, Character character) { private State getState(State currentState, Character character) {
State newCurrentState = currentState.nextState(character); State newCurrentState = currentState.nextState(character);
while (newCurrentState == null) { while (newCurrentState == null) {
@ -237,6 +256,11 @@ public class Trie {
return this; return this;
} }
public TrieBuilder onlyWholeWordsWhiteSpaceSeparated() {
this.trieConfig.setOnlyWholeWordsWhiteSpaceSeparated(true);
return this;
}
public TrieBuilder addKeyword(String keyword) { public TrieBuilder addKeyword(String keyword) {
trie.addKeyword(keyword); trie.addKeyword(keyword);
return this; return this;

8
src/main/java/org/ahocorasick/trie/TrieConfig.java
View File

@ -6,6 +6,8 @@ public class TrieConfig {
private boolean onlyWholeWords = false; private boolean onlyWholeWords = false;
private boolean onlyWholeWordsWhiteSpaceSeparated = false;
private boolean caseInsensitive = false; private boolean caseInsensitive = false;
private boolean stopOnHit = false; private boolean stopOnHit = false;
@ -30,6 +32,12 @@ public class TrieConfig {
this.onlyWholeWords = onlyWholeWords; this.onlyWholeWords = onlyWholeWords;
} }
public boolean isOnlyWholeWordsWhiteSpaceSeparated() { return onlyWholeWordsWhiteSpaceSeparated; }
public void setOnlyWholeWordsWhiteSpaceSeparated(boolean onlyWholeWordsWhiteSpaceSeparated) {
this.onlyWholeWordsWhiteSpaceSeparated = onlyWholeWordsWhiteSpaceSeparated;
}
public boolean isCaseInsensitive() { public boolean isCaseInsensitive() {
return caseInsensitive; return caseInsensitive;
} }

205
src/test/java/org/ahocorasick/trie/TrieTest.java
View File

@ -16,61 +16,61 @@ public class TrieTest {
@Test @Test
public void keywordAndTextAreTheSame() { public void keywordAndTextAreTheSame() {
Trie trie = Trie.builder() Trie trie = Trie.builder()
.addKeyword("abc") .addKeyword("abc")
.build(); .build();
Collection<Emit> emits = trie.parseText("abc"); Collection<Emit> emits = trie.parseText("abc");
Iterator<Emit> iterator = emits.iterator(); Iterator<Emit> iterator = emits.iterator();
checkEmit(iterator.next(), 0, 2, "abc"); checkEmit(iterator.next(), 0, 2, "abc");
} }
@Test @Test
public void keywordAndTextAreTheSameFirstMatch() { public void keywordAndTextAreTheSameFirstMatch() {
Trie trie = Trie.builder() Trie trie = Trie.builder()
.addKeyword("abc") .addKeyword("abc")
.build(); .build();
Emit firstMatch = trie.firstMatch("abc"); Emit firstMatch = trie.firstMatch("abc");
checkEmit(firstMatch, 0, 2, "abc"); checkEmit(firstMatch, 0, 2, "abc");
} }
@Test @Test
public void textIsLongerThanKeyword() { public void textIsLongerThanKeyword() {
Trie trie = Trie.builder() Trie trie = Trie.builder()
.addKeyword("abc") .addKeyword("abc")
.build(); .build();
Collection<Emit> emits = trie.parseText(" abc"); Collection<Emit> emits = trie.parseText(" abc");
Iterator<Emit> iterator = emits.iterator(); Iterator<Emit> iterator = emits.iterator();
checkEmit(iterator.next(), 1, 3, "abc"); checkEmit(iterator.next(), 1, 3, "abc");
} }
@Test @Test
public void textIsLongerThanKeywordFirstMatch() { public void textIsLongerThanKeywordFirstMatch() {
Trie trie = Trie.builder() Trie trie = Trie.builder()
.addKeyword("abc") .addKeyword("abc")
.build(); .build();
Emit firstMatch = trie.firstMatch(" abc"); Emit firstMatch = trie.firstMatch(" abc");
checkEmit(firstMatch, 1, 3, "abc"); checkEmit(firstMatch, 1, 3, "abc");
} }
@Test @Test
public void variousKeywordsOneMatch() { public void variousKeywordsOneMatch() {
Trie trie = Trie.builder() Trie trie = Trie.builder()
.addKeyword("abc") .addKeyword("abc")
.addKeyword("bcd") .addKeyword("bcd")
.addKeyword("cde") .addKeyword("cde")
.build(); .build();
Collection<Emit> emits = trie.parseText("bcd"); Collection<Emit> emits = trie.parseText("bcd");
Iterator<Emit> iterator = emits.iterator(); Iterator<Emit> iterator = emits.iterator();
checkEmit(iterator.next(), 0, 2, "bcd"); checkEmit(iterator.next(), 0, 2, "bcd");
} }
@Test @Test
public void variousKeywordsFirstMatch() { public void variousKeywordsFirstMatch() {
Trie trie = Trie.builder() Trie trie = Trie.builder()
.addKeyword("abc") .addKeyword("abc")
.addKeyword("bcd") .addKeyword("bcd")
.addKeyword("cde") .addKeyword("cde")
.build(); .build();
Emit firstMatch = trie.firstMatch("bcd"); Emit firstMatch = trie.firstMatch("bcd");
checkEmit(firstMatch, 0, 2, "bcd"); checkEmit(firstMatch, 0, 2, "bcd");
} }
@ -125,15 +125,15 @@ public class TrieTest {
@Test @Test
public void ushersTestFirstMatch() { public void ushersTestFirstMatch() {
Trie trie = Trie.builder() Trie trie = Trie.builder()
.addKeyword("hers") .addKeyword("hers")
.addKeyword("his") .addKeyword("his")
.addKeyword("she") .addKeyword("she")
.addKeyword("he") .addKeyword("he")
.build(); .build();
Emit firstMatch = trie.firstMatch("ushers"); Emit firstMatch = trie.firstMatch("ushers");
checkEmit(firstMatch, 2, 3, "he"); checkEmit(firstMatch, 2, 3, "he");
} }
@Test @Test
public void ushersTestByCallback() { public void ushersTestByCallback() {
@ -163,30 +163,30 @@ public class TrieTest {
@Test @Test
public void misleadingTest() { public void misleadingTest() {
Trie trie = Trie.builder() Trie trie = Trie.builder()
.addKeyword("hers") .addKeyword("hers")
.build(); .build();
Collection<Emit> emits = trie.parseText("h he her hers"); Collection<Emit> emits = trie.parseText("h he her hers");
Iterator<Emit> iterator = emits.iterator(); Iterator<Emit> iterator = emits.iterator();
checkEmit(iterator.next(), 9, 12, "hers"); checkEmit(iterator.next(), 9, 12, "hers");
} }
@Test @Test
public void misleadingTestFirstMatch() { public void misleadingTestFirstMatch() {
Trie trie = Trie.builder() Trie trie = Trie.builder()
.addKeyword("hers") .addKeyword("hers")
.build(); .build();
Emit firstMatch = trie.firstMatch("h he her hers"); Emit firstMatch = trie.firstMatch("h he her hers");
checkEmit(firstMatch, 9, 12, "hers"); checkEmit(firstMatch, 9, 12, "hers");
} }
@Test @Test
public void recipes() { public void recipes() {
Trie trie = Trie.builder() Trie trie = Trie.builder()
.addKeyword("veal") .addKeyword("veal")
.addKeyword("cauliflower") .addKeyword("cauliflower")
.addKeyword("broccoli") .addKeyword("broccoli")
.addKeyword("tomatoes") .addKeyword("tomatoes")
.build(); .build();
Collection<Emit> emits = trie.parseText("2 cauliflowers, 3 tomatoes, 4 slices of veal, 100g broccoli"); Collection<Emit> emits = trie.parseText("2 cauliflowers, 3 tomatoes, 4 slices of veal, 100g broccoli");
Iterator<Emit> iterator = emits.iterator(); Iterator<Emit> iterator = emits.iterator();
checkEmit(iterator.next(), 2, 12, "cauliflower"); checkEmit(iterator.next(), 2, 12, "cauliflower");
@ -195,15 +195,15 @@ public class TrieTest {
checkEmit(iterator.next(), 51, 58, "broccoli"); checkEmit(iterator.next(), 51, 58, "broccoli");
} }
@Test @Test
public void recipesFirstMatch() { public void recipesFirstMatch() {
Trie trie = Trie.builder() Trie trie = Trie.builder()
.addKeyword("veal") .addKeyword("veal")
.addKeyword("cauliflower") .addKeyword("cauliflower")
.addKeyword("broccoli") .addKeyword("broccoli")
.addKeyword("tomatoes") .addKeyword("tomatoes")
.build(); .build();
Emit firstMatch = trie.firstMatch("2 cauliflowers, 3 tomatoes, 4 slices of veal, 100g broccoli"); Emit firstMatch = trie.firstMatch("2 cauliflowers, 3 tomatoes, 4 slices of veal, 100g broccoli");
checkEmit(firstMatch, 2, 12, "cauliflower"); checkEmit(firstMatch, 2, 12, "cauliflower");
} }
@ -228,10 +228,10 @@ public class TrieTest {
@Test @Test
public void nonOverlapping() { public void nonOverlapping() {
Trie trie = Trie.builder().removeOverlaps() Trie trie = Trie.builder().removeOverlaps()
.addKeyword("ab") .addKeyword("ab")
.addKeyword("cba") .addKeyword("cba")
.addKeyword("ababc") .addKeyword("ababc")
.build(); .build();
Collection<Emit> emits = trie.parseText("ababcbab"); Collection<Emit> emits = trie.parseText("ababcbab");
assertEquals(2, emits.size()); assertEquals(2, emits.size());
Iterator<Emit> iterator = emits.iterator(); Iterator<Emit> iterator = emits.iterator();
@ -242,40 +242,40 @@ public class TrieTest {
@Test @Test
public void nonOverlappingFirstMatch() { public void nonOverlappingFirstMatch() {
Trie trie = Trie.builder().removeOverlaps() Trie trie = Trie.builder().removeOverlaps()
.addKeyword("ab") .addKeyword("ab")
.addKeyword("cba") .addKeyword("cba")
.addKeyword("ababc") .addKeyword("ababc")
.build(); .build();
Emit firstMatch = trie.firstMatch("ababcbab"); Emit firstMatch = trie.firstMatch("ababcbab");
checkEmit(firstMatch, 0, 4, "ababc"); checkEmit(firstMatch, 0, 4, "ababc");
} }
@Test @Test
public void containsMatch() { public void containsMatch() {
Trie trie = Trie.builder().removeOverlaps() Trie trie = Trie.builder().removeOverlaps()
.addKeyword("ab") .addKeyword("ab")
.addKeyword("cba") .addKeyword("cba")
.addKeyword("ababc") .addKeyword("ababc")
.build(); .build();
assertTrue(trie.containsMatch("ababcbab")); assertTrue(trie.containsMatch("ababcbab"));
} }
@Test @Test
public void startOfChurchillSpeech() { public void startOfChurchillSpeech() {
Trie trie = Trie.builder().removeOverlaps() Trie trie = Trie.builder().removeOverlaps()
.addKeyword("T") .addKeyword("T")
.addKeyword("u") .addKeyword("u")
.addKeyword("ur") .addKeyword("ur")
.addKeyword("r") .addKeyword("r")
.addKeyword("urn") .addKeyword("urn")
.addKeyword("ni") .addKeyword("ni")
.addKeyword("i") .addKeyword("i")
.addKeyword("in") .addKeyword("in")
.addKeyword("n") .addKeyword("n")
.addKeyword("urning") .addKeyword("urning")
.build(); .build();
Collection<Emit> emits = trie.parseText("Turning"); Collection<Emit> emits = trie.parseText("Turning");
assertEquals(2, emits.size()); assertEquals(2, emits.size());
} }
@ -283,21 +283,21 @@ public class TrieTest {
@Test @Test
public void partialMatch() { public void partialMatch() {
Trie trie = Trie.builder() Trie trie = Trie.builder()
.onlyWholeWords() .onlyWholeWords()
.addKeyword("sugar") .addKeyword("sugar")
.build(); .build();
Collection<Emit> emits = trie.parseText("sugarcane sugarcane sugar canesugar"); // left, middle, right test Collection<Emit> emits = trie.parseText("sugarcane sugarcane sugar canesugar"); // left, middle, right test
assertEquals(1, emits.size()); // Match must not be made assertEquals(1, emits.size()); // Match must not be made
checkEmit(emits.iterator().next(), 20, 24, "sugar"); checkEmit(emits.iterator().next(), 20, 24, "sugar");
} }
@Test @Test
public void partialMatchFirstMatch() { public void partialMatchFirstMatch() {
Trie trie = Trie.builder() Trie trie = Trie.builder()
.onlyWholeWords() .onlyWholeWords()
.addKeyword("sugar") .addKeyword("sugar")
.build(); .build();
Emit firstMatch = trie.firstMatch("sugarcane sugarcane sugar canesugar"); // left, middle, right test Emit firstMatch = trie.firstMatch("sugarcane sugarcane sugar canesugar"); // left, middle, right test
checkEmit(firstMatch, 20, 24, "sugar"); checkEmit(firstMatch, 20, 24, "sugar");
} }
@ -305,10 +305,10 @@ public class TrieTest {
@Test @Test
public void tokenizeFullSentence() { public void tokenizeFullSentence() {
Trie trie = Trie.builder() Trie trie = Trie.builder()
.addKeyword("Alpha") .addKeyword("Alpha")
.addKeyword("Beta") .addKeyword("Beta")
.addKeyword("Gamma") .addKeyword("Gamma")
.build(); .build();
Collection<Token> tokens = trie.tokenize("Hear: Alpha team first, Beta from the rear, Gamma in reserve"); Collection<Token> tokens = trie.tokenize("Hear: Alpha team first, Beta from the rear, Gamma in reserve");
assertEquals(7, tokens.size()); assertEquals(7, tokens.size());
Iterator<Token> tokensIt = tokens.iterator(); Iterator<Token> tokensIt = tokens.iterator();
@ -324,11 +324,11 @@ public class TrieTest {
@Test @Test
public void bug5InGithubReportedByXCurry() { public void bug5InGithubReportedByXCurry() {
Trie trie = Trie.builder().caseInsensitive().onlyWholeWords() Trie trie = Trie.builder().caseInsensitive().onlyWholeWords()
.addKeyword("turning") .addKeyword("turning")
.addKeyword("once") .addKeyword("once")
.addKeyword("again") .addKeyword("again")
.addKeyword("börkü") .addKeyword("börkü")
.build(); .build();
Collection<Emit> emits = trie.parseText("TurninG OnCe AgAiN BÖRKÜ"); Collection<Emit> emits = trie.parseText("TurninG OnCe AgAiN BÖRKÜ");
assertEquals(4, emits.size()); // Match must not be made assertEquals(4, emits.size()); // Match must not be made
Iterator<Emit> it = emits.iterator(); Iterator<Emit> it = emits.iterator();
@ -341,11 +341,11 @@ public class TrieTest {
@Test @Test
public void caseInsensitive() { public void caseInsensitive() {
Trie trie = Trie.builder().caseInsensitive() Trie trie = Trie.builder().caseInsensitive()
.addKeyword("turning") .addKeyword("turning")
.addKeyword("once") .addKeyword("once")
.addKeyword("again") .addKeyword("again")
.addKeyword("börkü") .addKeyword("börkü")
.build(); .build();
Collection<Emit> emits = trie.parseText("TurninG OnCe AgAiN BÖRKÜ"); Collection<Emit> emits = trie.parseText("TurninG OnCe AgAiN BÖRKÜ");
assertEquals(4, emits.size()); // Match must not be made assertEquals(4, emits.size()); // Match must not be made
Iterator<Emit> it = emits.iterator(); Iterator<Emit> it = emits.iterator();
@ -355,7 +355,7 @@ public class TrieTest {
checkEmit(it.next(), 19, 23, "börkü"); checkEmit(it.next(), 19, 23, "börkü");
} }
@Test @Test
public void caseInsensitiveFirstMatch() { public void caseInsensitiveFirstMatch() {
Trie trie = Trie.builder().caseInsensitive() Trie trie = Trie.builder().caseInsensitive()
.addKeyword("turning") .addKeyword("turning")
@ -363,7 +363,7 @@ public class TrieTest {
.addKeyword("again") .addKeyword("again")
.addKeyword("börkü") .addKeyword("börkü")
.build(); .build();
Emit firstMatch = trie.firstMatch("TurninG OnCe AgAiN BÖRKÜ"); Emit firstMatch = trie.firstMatch("TurninG OnCe AgAiN BÖRKÜ");
checkEmit(firstMatch, 0, 6, "turning"); checkEmit(firstMatch, 0, 6, "turning");
} }
@ -371,10 +371,10 @@ public class TrieTest {
@Test @Test
public void tokenizeTokensInSequence() { public void tokenizeTokensInSequence() {
Trie trie = Trie.builder() Trie trie = Trie.builder()
.addKeyword("Alpha") .addKeyword("Alpha")
.addKeyword("Beta") .addKeyword("Beta")
.addKeyword("Gamma") .addKeyword("Gamma")
.build(); .build();
Collection<Token> tokens = trie.tokenize("Alpha Beta Gamma"); Collection<Token> tokens = trie.tokenize("Alpha Beta Gamma");
assertEquals(5, tokens.size()); assertEquals(5, tokens.size());
} }
@ -383,8 +383,8 @@ public class TrieTest {
@Test @Test
public void zeroLengthTestBug7InGithubReportedByXCurry() { public void zeroLengthTestBug7InGithubReportedByXCurry() {
Trie trie = Trie.builder().removeOverlaps().onlyWholeWords().caseInsensitive() Trie trie = Trie.builder().removeOverlaps().onlyWholeWords().caseInsensitive()
.addKeyword("") .addKeyword("")
.build(); .build();
trie.tokenize("Try a natural lip and subtle bronzer to keep all the focus on those big bright eyes with NARS Eyeshadow Duo in Rated R And the winner is... Boots No7 Advanced Renewal Anti-ageing Glycolic Peel Kit ($25 amazon.com) won most-appealing peel."); trie.tokenize("Try a natural lip and subtle bronzer to keep all the focus on those big bright eyes with NARS Eyeshadow Duo in Rated R And the winner is... Boots No7 Advanced Renewal Anti-ageing Glycolic Peel Kit ($25 amazon.com) won most-appealing peel.");
} }
@ -394,15 +394,15 @@ public class TrieTest {
String target = "LİKE THIS"; // The second character ('İ') is Unicode, which was read by AC as a 2-byte char String target = "LİKE THIS"; // The second character ('İ') is Unicode, which was read by AC as a 2-byte char
assertEquals("THIS", target.substring(5, 9)); // Java does it the right way assertEquals("THIS", target.substring(5, 9)); // Java does it the right way
Trie trie = Trie.builder().caseInsensitive().onlyWholeWords() Trie trie = Trie.builder().caseInsensitive().onlyWholeWords()
.addKeyword("this") .addKeyword("this")
.build(); .build();
Collection<Emit> emits = trie.parseText(target); Collection<Emit> emits = trie.parseText(target);
assertEquals(1, emits.size()); assertEquals(1, emits.size());
Iterator<Emit> it = emits.iterator(); Iterator<Emit> it = emits.iterator();
checkEmit(it.next(), 5, 8, "this"); checkEmit(it.next(), 5, 8, "this");
} }
@Test @Test
public void unicodeIssueBug8ReportedByDwyerkFirstMatch() { public void unicodeIssueBug8ReportedByDwyerkFirstMatch() {
String target = "LİKE THIS"; // The second character ('İ') is Unicode, which was read by AC as a 2-byte char String target = "LİKE THIS"; // The second character ('İ') is Unicode, which was read by AC as a 2-byte char
Trie trie = Trie.builder() Trie trie = Trie.builder()
@ -411,13 +411,24 @@ public class TrieTest {
.addKeyword("this") .addKeyword("this")
.build(); .build();
assertEquals("THIS", target.substring(5, 9)); // Java does it the right way assertEquals("THIS", target.substring(5, 9)); // Java does it the right way
Emit firstMatch = trie.firstMatch(target); Emit firstMatch = trie.firstMatch(target);
checkEmit(firstMatch, 5, 8, "this"); checkEmit(firstMatch, 5, 8, "this");
} }
@Test
public void partialMatchWhiteSpaces() {
Trie trie = Trie.builder()
.onlyWholeWordsWhiteSpaceSeparated()
.addKeyword("#sugar-123")
.build();
Collection < Emit > emits = trie.parseText("#sugar-123 #sugar-1234"); // left, middle, right test
assertEquals(1, emits.size()); // Match must not be made
checkEmit(emits.iterator().next(), 0, 9, "#sugar-123");
}
private void checkEmit(Emit next, int expectedStart, int expectedEnd, String expectedKeyword) { private void checkEmit(Emit next, int expectedStart, int expectedEnd, String expectedKeyword) {
assertEquals("Start of emit should have been "+expectedStart, expectedStart, next.getStart()); assertEquals("Start of emit should have been " + expectedStart, expectedStart, next.getStart());
assertEquals("End of emit should have been "+expectedEnd, expectedEnd, next.getEnd()); assertEquals("End of emit should have been " + expectedEnd, expectedEnd, next.getEnd());
assertEquals(expectedKeyword, next.getKeyword()); assertEquals(expectedKeyword, next.getKeyword());
} }