org.apache.lucene.search
Class SearchEquivalenceTestBase

java.lang.Object
  extended by org.junit.Assert
      extended by org.apache.lucene.util.LuceneTestCase
          extended by org.apache.lucene.search.SearchEquivalenceTestBase

public abstract class SearchEquivalenceTestBase
extends LuceneTestCase

Simple base class for checking search equivalence. Extend it, and write tests that create randomTerm()s (all terms are single characters a-z), and use assertSameSet(Query, Query) and assertSubsetOf(Query, Query)


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.lucene.util.LuceneTestCase
LuceneTestCase.Nightly
 
Field Summary
protected static Analyzer analyzer
           
protected static Directory directory
           
protected static IndexReader reader
           
protected static IndexSearcher s1
           
protected static IndexSearcher s2
           
protected static String stopword
           
 
Fields inherited from class org.apache.lucene.util.LuceneTestCase
classRules, random, RANDOM_MULTIPLIER, ruleChain, stores, TEMP_DIR, TEST_CLEAN_THREADS, TEST_DIRECTORY, TEST_ITER, TEST_ITER_MIN, TEST_LINE_DOCS_FILE, TEST_LOCALE, TEST_NIGHTLY, TEST_SEED, TEST_TIMEZONE, TEST_VERSION_CURRENT, testsFailed, VERBOSE
 
Constructor Summary
SearchEquivalenceTestBase()
           
 
Method Summary
static void afterClass()
           
 void assertSameSet(Query q1, Query q2)
          Asserts that the documents returned by q1 are the same as of those returned by q2
 void assertSubsetOf(Query q1, Query q2)
          Asserts that the documents returned by q1 are a subset of those returned by q2
protected  void assertSubsetOf(Query q1, Query q2, Filter filter)
          Asserts that the documents returned by q1 are a subset of those returned by q2.
static void beforeClass()
           
protected  Filter randomFilter()
          Returns a random filter over the document set
protected  Term randomTerm()
          returns a term suitable for searching.
 
Methods inherited from class org.apache.lucene.util.LuceneTestCase
afterClassLuceneTestCaseJ4, alwaysIgnoredTestMethod, assertEquals, assertEquals, assertEquals, assertEquals, assertSaneFieldCaches, asSet, assumeFalse, assumeNoException, assumeTrue, atLeast, atLeast, beforeClassLuceneTestCaseJ4, dumpArray, dumpIterator, getDataFile, getName, getTestClass, getTestLabel, isTestThread, localeForName, newDirectory, newDirectory, newDirectory, newDirectory, newField, newField, newField, newField, newField, newField, newFSDirectory, newFSDirectory, newIndexWriterConfig, newIndexWriterConfig, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newSearcher, newSearcher, newTieredMergePolicy, newTieredMergePolicy, purgeFieldCache, randomDirectory, randomLocale, randomTimeZone, rarely, rarely, reportAdditionalFailureInfo, reportPartialFailureInfo, setMergeFactor, setUp, setUseCompoundFile, tearDown, usually, usually
 
Methods inherited from class org.junit.Assert
assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertThat, assertThat, assertTrue, assertTrue, fail, fail
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

s1

protected static IndexSearcher s1

s2

protected static IndexSearcher s2

directory

protected static Directory directory

reader

protected static IndexReader reader

analyzer

protected static Analyzer analyzer

stopword

protected static String stopword
Constructor Detail

SearchEquivalenceTestBase

public SearchEquivalenceTestBase()
Method Detail

beforeClass

public static void beforeClass()
                        throws Exception
Throws:
Exception

afterClass

public static void afterClass()
                       throws Exception
Throws:
Exception

randomTerm

protected Term randomTerm()
returns a term suitable for searching. terms are single characters in lowercase (a-z)


randomFilter

protected Filter randomFilter()
Returns a random filter over the document set


assertSameSet

public void assertSameSet(Query q1,
                          Query q2)
                   throws Exception
Asserts that the documents returned by q1 are the same as of those returned by q2

Throws:
Exception

assertSubsetOf

public void assertSubsetOf(Query q1,
                           Query q2)
                    throws Exception
Asserts that the documents returned by q1 are a subset of those returned by q2

Throws:
Exception

assertSubsetOf

protected void assertSubsetOf(Query q1,
                              Query q2,
                              Filter filter)
                       throws Exception
Asserts that the documents returned by q1 are a subset of those returned by q2. Both queries will be filtered by filter

Throws:
Exception