--- /dev/null
+package org.apache.lucene.analysis.shingle;
+
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import java.io.Reader;
+import java.io.StringReader;
+
+import org.apache.lucene.analysis.Analyzer;
+import org.apache.lucene.analysis.BaseTokenStreamTestCase;
+import org.apache.lucene.analysis.MockAnalyzer;
+import org.apache.lucene.analysis.MockTokenizer;
+import org.apache.lucene.analysis.TokenStream;
+import org.apache.lucene.analysis.tokenattributes.CharTermAttribute;
+import org.apache.lucene.analysis.tokenattributes.PositionIncrementAttribute;
+import org.apache.lucene.document.Document;
+import org.apache.lucene.document.Field;
+import org.apache.lucene.index.IndexWriter;
+import org.apache.lucene.index.IndexWriterConfig;
+import org.apache.lucene.index.Term;
+import org.apache.lucene.queryParser.QueryParser;
+import org.apache.lucene.search.BooleanClause;
+import org.apache.lucene.search.BooleanQuery;
+import org.apache.lucene.search.IndexSearcher;
+import org.apache.lucene.search.PhraseQuery;
+import org.apache.lucene.search.Query;
+import org.apache.lucene.search.ScoreDoc;
+import org.apache.lucene.search.TermQuery;
+import org.apache.lucene.store.Directory;
+import org.apache.lucene.store.RAMDirectory;
+
+/**
+ * A test class for ShingleAnalyzerWrapper as regards queries and scoring.
+ */
+public class ShingleAnalyzerWrapperTest extends BaseTokenStreamTestCase {
+
+ public IndexSearcher searcher;
+
+ /**
+ * Set up a new index in RAM with three test phrases and the supplied Analyzer.
+ *
+ * @param analyzer the analyzer to use
+ * @return an indexSearcher on the test index.
+ * @throws Exception if an error occurs with index writer or searcher
+ */
+ public IndexSearcher setUpSearcher(Analyzer analyzer) throws Exception {
+ Directory dir = new RAMDirectory();
+ IndexWriter writer = new IndexWriter(dir, new IndexWriterConfig(TEST_VERSION_CURRENT, analyzer));
+
+ Document doc;
+ doc = new Document();
+ doc.add(new Field("content", "please divide this sentence into shingles",
+ Field.Store.YES,Field.Index.ANALYZED));
+ writer.addDocument(doc);
+
+ doc = new Document();
+ doc.add(new Field("content", "just another test sentence",
+ Field.Store.YES,Field.Index.ANALYZED));
+ writer.addDocument(doc);
+
+ doc = new Document();
+ doc.add(new Field("content", "a sentence which contains no test",
+ Field.Store.YES,Field.Index.ANALYZED));
+ writer.addDocument(doc);
+
+ writer.close();
+
+ return new IndexSearcher(dir, true);
+ }
+
+ protected ScoreDoc[] queryParsingTest(Analyzer analyzer, String qs) throws Exception {
+ searcher = setUpSearcher(analyzer);
+
+ QueryParser qp = new QueryParser(TEST_VERSION_CURRENT, "content", analyzer);
+
+ Query q = qp.parse(qs);
+
+ return searcher.search(q, null, 1000).scoreDocs;
+ }
+
+ protected void compareRanks(ScoreDoc[] hits, int[] ranks) throws Exception {
+ assertEquals(ranks.length, hits.length);
+ for (int i = 0; i < ranks.length; i++) {
+ assertEquals(ranks[i], hits[i].doc);
+ }
+ }
+
+ /*
+ * Will not work on an index without unigrams, since QueryParser automatically
+ * tokenizes on whitespace.
+ */
+ public void testShingleAnalyzerWrapperQueryParsing() throws Exception {
+ ScoreDoc[] hits = queryParsingTest(new ShingleAnalyzerWrapper
+ (new MockAnalyzer(random, MockTokenizer.WHITESPACE, false), 2),
+ "test sentence");
+ int[] ranks = new int[] { 1, 2, 0 };
+ compareRanks(hits, ranks);
+ }
+
+ /*
+ * This one fails with an exception.
+ */
+ public void testShingleAnalyzerWrapperPhraseQueryParsingFails() throws Exception {
+ ScoreDoc[] hits = queryParsingTest(new ShingleAnalyzerWrapper
+ (new MockAnalyzer(random, MockTokenizer.WHITESPACE, false), 2),
+ "\"this sentence\"");
+ int[] ranks = new int[] { 0 };
+ compareRanks(hits, ranks);
+ }
+
+ /*
+ * This one works, actually.
+ */
+ public void testShingleAnalyzerWrapperPhraseQueryParsing() throws Exception {
+ ScoreDoc[] hits = queryParsingTest(new ShingleAnalyzerWrapper
+ (new MockAnalyzer(random, MockTokenizer.WHITESPACE, false), 2),
+ "\"test sentence\"");
+ int[] ranks = new int[] { 1 };
+ compareRanks(hits, ranks);
+ }
+
+ /*
+ * Same as above, is tokenized without using the analyzer.
+ */
+ public void testShingleAnalyzerWrapperRequiredQueryParsing() throws Exception {
+ ScoreDoc[] hits = queryParsingTest(new ShingleAnalyzerWrapper
+ (new MockAnalyzer(random, MockTokenizer.WHITESPACE, false), 2),
+ "+test +sentence");
+ int[] ranks = new int[] { 1, 2 };
+ compareRanks(hits, ranks);
+ }
+
+ /*
+ * This shows how to construct a phrase query containing shingles.
+ */
+ public void testShingleAnalyzerWrapperPhraseQuery() throws Exception {
+ Analyzer analyzer = new ShingleAnalyzerWrapper(new MockAnalyzer(random, MockTokenizer.WHITESPACE, false), 2);
+ searcher = setUpSearcher(analyzer);
+
+ PhraseQuery q = new PhraseQuery();
+
+ TokenStream ts = analyzer.tokenStream("content",
+ new StringReader("this sentence"));
+ int j = -1;
+
+ PositionIncrementAttribute posIncrAtt = ts.addAttribute(PositionIncrementAttribute.class);
+ CharTermAttribute termAtt = ts.addAttribute(CharTermAttribute.class);
+
+ ts.reset();
+ while (ts.incrementToken()) {
+ j += posIncrAtt.getPositionIncrement();
+ String termText = termAtt.toString();
+ q.add(new Term("content", termText), j);
+ }
+
+ ScoreDoc[] hits = searcher.search(q, null, 1000).scoreDocs;
+ int[] ranks = new int[] { 0 };
+ compareRanks(hits, ranks);
+ }
+
+ /*
+ * How to construct a boolean query with shingles. A query like this will
+ * implicitly score those documents higher that contain the words in the query
+ * in the right order and adjacent to each other.
+ */
+ public void testShingleAnalyzerWrapperBooleanQuery() throws Exception {
+ Analyzer analyzer = new ShingleAnalyzerWrapper(new MockAnalyzer(random, MockTokenizer.WHITESPACE, false), 2);
+ searcher = setUpSearcher(analyzer);
+
+ BooleanQuery q = new BooleanQuery();
+
+ TokenStream ts = analyzer.tokenStream("content",
+ new StringReader("test sentence"));
+
+ CharTermAttribute termAtt = ts.addAttribute(CharTermAttribute.class);
+
+ ts.reset();
+
+ while (ts.incrementToken()) {
+ String termText = termAtt.toString();
+ q.add(new TermQuery(new Term("content", termText)),
+ BooleanClause.Occur.SHOULD);
+ }
+
+ ScoreDoc[] hits = searcher.search(q, null, 1000).scoreDocs;
+ int[] ranks = new int[] { 1, 2, 0 };
+ compareRanks(hits, ranks);
+ }
+
+ public void testReusableTokenStream() throws Exception {
+ Analyzer a = new ShingleAnalyzerWrapper(new MockAnalyzer(random, MockTokenizer.WHITESPACE, false), 2);
+ assertAnalyzesToReuse(a, "please divide into shingles",
+ new String[] { "please", "please divide", "divide", "divide into", "into", "into shingles", "shingles" },
+ new int[] { 0, 0, 7, 7, 14, 14, 19 },
+ new int[] { 6, 13, 13, 18, 18, 27, 27 },
+ new int[] { 1, 0, 1, 0, 1, 0, 1 });
+ assertAnalyzesToReuse(a, "divide me up again",
+ new String[] { "divide", "divide me", "me", "me up", "up", "up again", "again" },
+ new int[] { 0, 0, 7, 7, 10, 10, 13 },
+ new int[] { 6, 9, 9, 12, 12, 18, 18 },
+ new int[] { 1, 0, 1, 0, 1, 0, 1 });
+ }
+
+ /*
+ * analyzer that does not support reuse
+ * it is LetterTokenizer on odd invocations, WhitespaceTokenizer on even.
+ */
+ private class NonreusableAnalyzer extends Analyzer {
+ int invocationCount = 0;
+ @Override
+ public TokenStream tokenStream(String fieldName, Reader reader) {
+ if (++invocationCount % 2 == 0)
+ return new MockTokenizer(reader, MockTokenizer.WHITESPACE, false);
+ else
+ return new MockTokenizer(reader, MockTokenizer.SIMPLE, false);
+ }
+ }
+
+ public void testWrappedAnalyzerDoesNotReuse() throws Exception {
+ Analyzer a = new ShingleAnalyzerWrapper(new NonreusableAnalyzer());
+ assertAnalyzesToReuse(a, "please divide into shingles.",
+ new String[] { "please", "please divide", "divide", "divide into", "into", "into shingles", "shingles" },
+ new int[] { 0, 0, 7, 7, 14, 14, 19 },
+ new int[] { 6, 13, 13, 18, 18, 27, 27 },
+ new int[] { 1, 0, 1, 0, 1, 0, 1 });
+ assertAnalyzesToReuse(a, "please divide into shingles.",
+ new String[] { "please", "please divide", "divide", "divide into", "into", "into shingles.", "shingles." },
+ new int[] { 0, 0, 7, 7, 14, 14, 19 },
+ new int[] { 6, 13, 13, 18, 18, 28, 28 },
+ new int[] { 1, 0, 1, 0, 1, 0, 1 });
+ assertAnalyzesToReuse(a, "please divide into shingles.",
+ new String[] { "please", "please divide", "divide", "divide into", "into", "into shingles", "shingles" },
+ new int[] { 0, 0, 7, 7, 14, 14, 19 },
+ new int[] { 6, 13, 13, 18, 18, 27, 27 },
+ new int[] { 1, 0, 1, 0, 1, 0, 1 });
+ }
+
+ public void testNonDefaultMinShingleSize() throws Exception {
+ ShingleAnalyzerWrapper analyzer
+ = new ShingleAnalyzerWrapper(new MockAnalyzer(random, MockTokenizer.WHITESPACE, false), 3, 4);
+ assertAnalyzesToReuse(analyzer, "please divide this sentence into shingles",
+ new String[] { "please", "please divide this", "please divide this sentence",
+ "divide", "divide this sentence", "divide this sentence into",
+ "this", "this sentence into", "this sentence into shingles",
+ "sentence", "sentence into shingles",
+ "into",
+ "shingles" },
+ new int[] { 0, 0, 0, 7, 7, 7, 14, 14, 14, 19, 19, 28, 33 },
+ new int[] { 6, 18, 27, 13, 27, 32, 18, 32, 41, 27, 41, 32, 41 },
+ new int[] { 1, 0, 0, 1, 0, 0, 1, 0, 0, 1, 0, 1, 1 });
+
+ analyzer = new ShingleAnalyzerWrapper(
+ new MockAnalyzer(random, MockTokenizer.WHITESPACE, false), 3, 4, ShingleFilter.TOKEN_SEPARATOR, false, false);
+ assertAnalyzesToReuse(analyzer, "please divide this sentence into shingles",
+ new String[] { "please divide this", "please divide this sentence",
+ "divide this sentence", "divide this sentence into",
+ "this sentence into", "this sentence into shingles",
+ "sentence into shingles" },
+ new int[] { 0, 0, 7, 7, 14, 14, 19 },
+ new int[] { 18, 27, 27, 32, 32, 41, 41 },
+ new int[] { 1, 0, 1, 0, 1, 0, 1 });
+ }
+
+ public void testNonDefaultMinAndSameMaxShingleSize() throws Exception {
+ ShingleAnalyzerWrapper analyzer
+ = new ShingleAnalyzerWrapper(new MockAnalyzer(random, MockTokenizer.WHITESPACE, false), 3, 3);
+ assertAnalyzesToReuse(analyzer, "please divide this sentence into shingles",
+ new String[] { "please", "please divide this",
+ "divide", "divide this sentence",
+ "this", "this sentence into",
+ "sentence", "sentence into shingles",
+ "into",
+ "shingles" },
+ new int[] { 0, 0, 7, 7, 14, 14, 19, 19, 28, 33 },
+ new int[] { 6, 18, 13, 27, 18, 32, 27, 41, 32, 41 },
+ new int[] { 1, 0, 1, 0, 1, 0, 1, 0, 1, 1 });
+
+ analyzer = new ShingleAnalyzerWrapper(
+ new MockAnalyzer(random, MockTokenizer.WHITESPACE, false), 3, 3, ShingleFilter.TOKEN_SEPARATOR, false, false);
+ assertAnalyzesToReuse(analyzer, "please divide this sentence into shingles",
+ new String[] { "please divide this",
+ "divide this sentence",
+ "this sentence into",
+ "sentence into shingles" },
+ new int[] { 0, 7, 14, 19 },
+ new int[] { 18, 27, 32, 41 },
+ new int[] { 1, 1, 1, 1 });
+ }
+
+ public void testNoTokenSeparator() throws Exception {
+ ShingleAnalyzerWrapper analyzer = new ShingleAnalyzerWrapper(
+ new MockAnalyzer(random, MockTokenizer.WHITESPACE, false),
+ ShingleFilter.DEFAULT_MIN_SHINGLE_SIZE,
+ ShingleFilter.DEFAULT_MAX_SHINGLE_SIZE,
+ "", true, false);
+ assertAnalyzesToReuse(analyzer, "please divide into shingles",
+ new String[] { "please", "pleasedivide",
+ "divide", "divideinto",
+ "into", "intoshingles",
+ "shingles" },
+ new int[] { 0, 0, 7, 7, 14, 14, 19 },
+ new int[] { 6, 13, 13, 18, 18, 27, 27 },
+ new int[] { 1, 0, 1, 0, 1, 0, 1 });
+
+ analyzer = new ShingleAnalyzerWrapper(
+ new MockAnalyzer(random, MockTokenizer.WHITESPACE, false),
+ ShingleFilter.DEFAULT_MIN_SHINGLE_SIZE,
+ ShingleFilter.DEFAULT_MAX_SHINGLE_SIZE,
+ "", false, false);
+ assertAnalyzesToReuse(analyzer, "please divide into shingles",
+ new String[] { "pleasedivide",
+ "divideinto",
+ "intoshingles" },
+ new int[] { 0, 7, 14 },
+ new int[] { 13, 18, 27 },
+ new int[] { 1, 1, 1 });
+ }
+
+ public void testNullTokenSeparator() throws Exception {
+ ShingleAnalyzerWrapper analyzer = new ShingleAnalyzerWrapper(
+ new MockAnalyzer(random, MockTokenizer.WHITESPACE, false),
+ ShingleFilter.DEFAULT_MIN_SHINGLE_SIZE,
+ ShingleFilter.DEFAULT_MAX_SHINGLE_SIZE,
+ null, true, false);
+ assertAnalyzesToReuse(analyzer, "please divide into shingles",
+ new String[] { "please", "pleasedivide",
+ "divide", "divideinto",
+ "into", "intoshingles",
+ "shingles" },
+ new int[] { 0, 0, 7, 7, 14, 14, 19 },
+ new int[] { 6, 13, 13, 18, 18, 27, 27 },
+ new int[] { 1, 0, 1, 0, 1, 0, 1 });
+
+ analyzer = new ShingleAnalyzerWrapper(
+ new MockAnalyzer(random, MockTokenizer.WHITESPACE, false),
+ ShingleFilter.DEFAULT_MIN_SHINGLE_SIZE,
+ ShingleFilter.DEFAULT_MAX_SHINGLE_SIZE,
+ "", false, false);
+ assertAnalyzesToReuse(analyzer, "please divide into shingles",
+ new String[] { "pleasedivide",
+ "divideinto",
+ "intoshingles" },
+ new int[] { 0, 7, 14 },
+ new int[] { 13, 18, 27 },
+ new int[] { 1, 1, 1 });
+ }
+ public void testAltTokenSeparator() throws Exception {
+ ShingleAnalyzerWrapper analyzer = new ShingleAnalyzerWrapper(
+ new MockAnalyzer(random, MockTokenizer.WHITESPACE, false),
+ ShingleFilter.DEFAULT_MIN_SHINGLE_SIZE,
+ ShingleFilter.DEFAULT_MAX_SHINGLE_SIZE,
+ "<SEP>", true, false);
+ assertAnalyzesToReuse(analyzer, "please divide into shingles",
+ new String[] { "please", "please<SEP>divide",
+ "divide", "divide<SEP>into",
+ "into", "into<SEP>shingles",
+ "shingles" },
+ new int[] { 0, 0, 7, 7, 14, 14, 19 },
+ new int[] { 6, 13, 13, 18, 18, 27, 27 },
+ new int[] { 1, 0, 1, 0, 1, 0, 1 });
+
+ analyzer = new ShingleAnalyzerWrapper(
+ new MockAnalyzer(random, MockTokenizer.WHITESPACE, false),
+ ShingleFilter.DEFAULT_MIN_SHINGLE_SIZE,
+ ShingleFilter.DEFAULT_MAX_SHINGLE_SIZE,
+ "<SEP>", false, false);
+ assertAnalyzesToReuse(analyzer, "please divide into shingles",
+ new String[] { "please<SEP>divide",
+ "divide<SEP>into",
+ "into<SEP>shingles" },
+ new int[] { 0, 7, 14 },
+ new int[] { 13, 18, 27 },
+ new int[] { 1, 1, 1 });
+ }
+
+ public void testOutputUnigramsIfNoShinglesSingleToken() throws Exception {
+ ShingleAnalyzerWrapper analyzer = new ShingleAnalyzerWrapper(
+ new MockAnalyzer(random, MockTokenizer.WHITESPACE, false),
+ ShingleFilter.DEFAULT_MIN_SHINGLE_SIZE,
+ ShingleFilter.DEFAULT_MAX_SHINGLE_SIZE,
+ "", false, true);
+ assertAnalyzesToReuse(analyzer, "please",
+ new String[] { "please" },
+ new int[] { 0 },
+ new int[] { 6 },
+ new int[] { 1 });
+ }
+}
fnp / pylucene.git / blobdiff