org.apache.lucene.index

Class BaseTermVectorsFormatTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.util.LuceneTestCase

org.apache.lucene.index.BaseTermVectorsFormatTestCase

public abstract class BaseTermVectorsFormatTestCase
extends LuceneTestCase

Base class aiming at testing term vectors formats. To test a new format, all you need is to register a new Codec which uses it and extend this class and override getCodec().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BaseTermVectorsFormatTestCase.Options A combination of term vectors options.
protected class	BaseTermVectorsFormatTestCase.RandomDocument
protected class	BaseTermVectorsFormatTestCase.RandomDocumentFactory
static class	BaseTermVectorsFormatTestCase.RandomTokenStream Produces a random TokenStream based off of provided terms.

Nested classes/interfaces inherited from class org.apache.lucene.util.LuceneTestCase

LuceneTestCase.AwaitsFix, LuceneTestCase.BadApple, LuceneTestCase.Monster, LuceneTestCase.Nightly, LuceneTestCase.Slow, LuceneTestCase.SuppressCodecs, LuceneTestCase.SuppressFileSystems, LuceneTestCase.SuppressFsync, LuceneTestCase.SuppressReproduceLine, LuceneTestCase.SuppressSysoutChecks, LuceneTestCase.SuppressTempFileChecks, LuceneTestCase.ThrowingRunnable, LuceneTestCase.Weekly

Field Summary

Fields inherited from class org.apache.lucene.util.LuceneTestCase

assertsAreEnabled, classRules, DEFAULT_LINE_DOCS_FILE, INFOSTREAM, JENKINS_LARGE_LINE_DOCS_FILE, LEAVE_TEMPORARY, MAYBE_CACHE_POLICY, RANDOM_MULTIPLIER, ruleChain, suiteFailureMarker, SYSPROP_AWAITSFIX, SYSPROP_BADAPPLES, SYSPROP_FAILFAST, SYSPROP_MAXFAILURES, SYSPROP_MONSTER, SYSPROP_NIGHTLY, SYSPROP_SLOW, SYSPROP_WEEKLY, TEST_ASSERTS_ENABLED, TEST_AWAITSFIX, TEST_BADAPPLES, TEST_CODEC, TEST_DIRECTORY, TEST_DOCVALUESFORMAT, TEST_LINE_DOCS_FILE, TEST_MONSTER, TEST_NIGHTLY, TEST_POSTINGSFORMAT, TEST_SLOW, TEST_THROTTLING, TEST_WEEKLY, VERBOSE

Constructor Summary

Constructors

Constructor and Description
BaseTermVectorsFormatTestCase()

Method Summary

Modifier and Type	Method and Description
protected Document	addId(Document doc, java.lang.String id)
protected void	addRandomFields(Document doc) Add random fields to the provided document.
protected <D extends Directory> D	applyCreatedVersionMajor(D d) Set the created version of the given Directory and return it.
protected void	assertEquals(BaseTermVectorsFormatTestCase.RandomDocument doc, Fields fields)
protected void	assertEquals(BaseTermVectorsFormatTestCase.RandomTokenStream tk, FieldType ft, Terms terms)
protected int	docID(IndexReader reader, java.lang.String id)
protected static boolean	equals(java.lang.Object o1, java.lang.Object o2)
protected java.util.Collection<java.lang.String>	excludedExtensionsFromByteCounts() Return the list of extensions that should be excluded from byte counts when comparing indices that store the same content.
protected FieldType	fieldType(BaseTermVectorsFormatTestCase.Options options)
protected abstract Codec	getCodec() Returns the codec to run tests against
protected int	getCreatedVersionMajor() Returns the major version that this codec is compatible with.
protected boolean	mergeIsStable()
protected BaseTermVectorsFormatTestCase.Options	randomOptions()
void	setUp() For subclasses to override.
void	tearDown() For subclasses to override.
void	testClone()
void	testHighFreqs()
void	testLotsOfFields()
void	testMerge()
void	testMergeStability() The purpose of this test is to make sure that bulk merge doesn't accumulate useless data over runs.
void	testMixedOptions()
void	testMultiClose() Calls close multiple times on closeable codec apis
void	testPostingsEnumAll()
void	testPostingsEnumFreqs()
void	testPostingsEnumOffsets()
void	testPostingsEnumOffsetsWithoutPositions()
void	testPostingsEnumPayloads()
void	testPostingsEnumPositions()
void	testRamBytesUsed() Test the accuracy of the ramBytesUsed estimations.
void	testRandom()
void	testRandomExceptions() Tests exception handling on write and openInput/createOutput
void	testRareVectors()
protected java.util.Set<BaseTermVectorsFormatTestCase.Options>	validOptions()

Methods inherited from class org.apache.lucene.util.LuceneTestCase

addVirusChecker, assertDeletedDocsEquals, assertDocsAndPositionsEnumEquals, assertDocsEnumEquals, assertDocsSkippingEquals, assertDocValuesEquals, assertDocValuesEquals, assertFieldInfosEquals, assertFieldsEquals, assertFieldStatisticsEquals, assertNormsEquals, assertPointsEquals, assertPositionsSkippingEquals, assertReaderEquals, assertReaderStatisticsEquals, assertStoredFieldEquals, assertStoredFieldsEquals, assertTermsEnumEquals, assertTermsEquals, assertTermsStatisticsEquals, assertTermStatsEquals, assertTermVectorsEquals, asSet, assumeFalse, assumeNoException, assumeTrue, assumeWorkingMMapOnWindows, atLeast, atLeast, closeAfterSuite, closeAfterTest, collate, createTempDir, createTempDir, createTempFile, createTempFile, dumpArray, dumpIterator, expectThrows, expectThrows, expectThrows, expectThrowsAnyOf, expectThrowsAnyOf, getBaseTempDirForTestClass, getDataInputStream, getDataPath, getOnlyLeafReader, getTestClass, getTestName, hasWorkingMMapOnWindows, isTestThread, localeForLanguageTag, maybeChangeLiveIndexWriterConfig, maybeWrapReader, newAlcoholicMergePolicy, newAlcoholicMergePolicy, newDirectory, newDirectory, newDirectory, newDirectory, newDirectory, newField, newField, newFSDirectory, newFSDirectory, newIndexWriterConfig, newIndexWriterConfig, newIndexWriterConfig, newIOContext, newIOContext, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newMaybeVirusCheckingDirectory, newMaybeVirusCheckingFSDirectory, newMergePolicy, newMergePolicy, newMergePolicy, newMockDirectory, newMockDirectory, newMockDirectory, newMockFSDirectory, newMockFSDirectory, newSearcher, newSearcher, newSearcher, newStringField, newStringField, newStringField, newStringField, newTextField, newTextField, newTieredMergePolicy, newTieredMergePolicy, overrideDefaultQueryCache, overrideTestDefaultQueryCache, random, randomLocale, randomTimeZone, rarely, rarely, replaceMaxFailureRule, resetDefaultQueryCache, restoreCPUCoreCount, restoreIndexWriterMaxDocs, restoreSpins, runWithRestrictedPermissions, setIndexWriterMaxDocs, setupCPUCoreCount, setupSpins, slowFileExists, usually, usually, wrapReader

Methods inherited from class org.junit.Assert

assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertThat, assertThat, assertThrows, assertThrows, assertTrue, assertTrue, fail, fail

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseTermVectorsFormatTestCase

public BaseTermVectorsFormatTestCase()

Method Detail

validOptions

protected java.util.Set<BaseTermVectorsFormatTestCase.Options> validOptions()

randomOptions

protected BaseTermVectorsFormatTestCase.Options randomOptions()

fieldType

protected FieldType fieldType(BaseTermVectorsFormatTestCase.Options options)

addRandomFields

protected void addRandomFields(Document doc)

Add random fields to the provided document.

assertEquals

protected void assertEquals(BaseTermVectorsFormatTestCase.RandomDocument doc,
                            Fields fields)
                     throws java.io.IOException

Throws:

java.io.IOException

equals

protected static boolean equals(java.lang.Object o1,
                                java.lang.Object o2)

assertEquals

protected void assertEquals(BaseTermVectorsFormatTestCase.RandomTokenStream tk,
                            FieldType ft,
                            Terms terms)
                     throws java.io.IOException

Throws:

java.io.IOException

addId

protected Document addId(Document doc,
                         java.lang.String id)

docID

protected int docID(IndexReader reader,
                    java.lang.String id)
             throws java.io.IOException

Throws:

java.io.IOException

testRareVectors

public void testRareVectors()
                     throws java.io.IOException

Throws:

java.io.IOException

testHighFreqs

public void testHighFreqs()
                   throws java.io.IOException

Throws:

java.io.IOException

testLotsOfFields

public void testLotsOfFields()
                      throws java.io.IOException

Throws:

java.io.IOException

testMixedOptions

public void testMixedOptions()
                      throws java.io.IOException

Throws:

java.io.IOException

testRandom

public void testRandom()
                throws java.io.IOException

Throws:

java.io.IOException

testMerge

public void testMerge()
               throws java.io.IOException

Throws:

java.io.IOException

testClone

public void testClone()
               throws java.io.IOException,
                      java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

testPostingsEnumFreqs

public void testPostingsEnumFreqs()
                           throws java.lang.Exception

Throws:

java.lang.Exception

testPostingsEnumPositions

public void testPostingsEnumPositions()
                               throws java.lang.Exception

Throws:

java.lang.Exception

testPostingsEnumOffsets

public void testPostingsEnumOffsets()
                             throws java.lang.Exception

Throws:

java.lang.Exception

testPostingsEnumOffsetsWithoutPositions

public void testPostingsEnumOffsetsWithoutPositions()
                                             throws java.lang.Exception

Throws:

java.lang.Exception

testPostingsEnumPayloads

public void testPostingsEnumPayloads()
                              throws java.lang.Exception

Throws:

java.lang.Exception

testPostingsEnumAll

public void testPostingsEnumAll()
                         throws java.lang.Exception

Throws:

java.lang.Exception

getCodec

protected abstract Codec getCodec()

Returns the codec to run tests against

getCreatedVersionMajor

protected int getCreatedVersionMajor()

Returns the major version that this codec is compatible with.

applyCreatedVersionMajor

protected final <D extends Directory> D applyCreatedVersionMajor(D d)
                                                          throws java.io.IOException

Set the created version of the given Directory and return it.

Throws:

java.io.IOException

setUp

public void setUp()
           throws java.lang.Exception

Description copied from class: LuceneTestCase

For subclasses to override. Overrides must call super.setUp().

Overrides:

setUp in class LuceneTestCase

Throws:

java.lang.Exception

tearDown

public void tearDown()
              throws java.lang.Exception

Description copied from class: LuceneTestCase

For subclasses to override. Overrides must call super.tearDown().

Overrides:

tearDown in class LuceneTestCase

Throws:

java.lang.Exception

excludedExtensionsFromByteCounts

protected java.util.Collection<java.lang.String> excludedExtensionsFromByteCounts()

Return the list of extensions that should be excluded from byte counts when comparing indices that store the same content.

testMergeStability

public void testMergeStability()
                        throws java.lang.Exception

The purpose of this test is to make sure that bulk merge doesn't accumulate useless data over runs.

Throws:

java.lang.Exception

mergeIsStable

protected boolean mergeIsStable()

testRamBytesUsed

@LuceneTestCase.Slow
public void testRamBytesUsed()
                                           throws java.io.IOException

Test the accuracy of the ramBytesUsed estimations.

Throws:

java.io.IOException

testMultiClose

public void testMultiClose()
                    throws java.io.IOException

Calls close multiple times on closeable codec apis

Throws:

java.io.IOException

testRandomExceptions

public void testRandomExceptions()
                          throws java.lang.Exception

Tests exception handling on write and openInput/createOutput

Throws:

java.lang.Exception