Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Namespaces | Classes | Enumerations
Package Lucene.Net.Util

Namespaces

package  Cache
 

Classes

class  ArrayUtil
 Methods for manipulating arrays. More...
 
class  Attribute
 Base class for Attributes that can be added to a Lucene.Net.Util.AttributeSource. Attributes are used to add data in a dynamic, yet type-safe way to a source of usually streamed objects, e. g. a Lucene.Net.Analysis.TokenStream. More...
 
class  AttributeSource
 An AttributeSource contains a list of different Attributes, and methods to add and get them. There can only be a single instance of an attribute in the same AttributeSource instance. This is ensured by passing in the actual type of the Attribute (Class<Attribute>) to the AddAttribute{T}(), which then checks if an instance of that type is already present. If yes, it returns the instance, otherwise it creates a new instance and returns it. More...
 
class  AverageGuessMemoryModel
 An average, best guess, MemoryModel that should work okay on most systems. More...
 
class  BitUtil
 A variety of high efficiencly bit twiddling routines. More...
 
class  BitVector
 Optimized implementation of a vector of bits. This is more-or-less like java.util.BitSet, but also includes the following:

  • a count() method, which efficiently computes the number of one bits;
  • optimized read from and write to disk;
  • inlinable get() method;
  • store and load, as bit set or d-gaps, depending on sparseness;
More...
 
class  CloseableThreadLocal
 Java's builtin ThreadLocal has a serious flaw: it can take an arbitrarily long amount of time to dereference the things you had stored in it, even once the ThreadLocal instance itself is no longer referenced. This is because there is single, master map stored for each thread, which all ThreadLocals share, and that master map only periodically purges "stale" entries. More...
 
class  CloseableThreadLocal< T >
 Java's builtin ThreadLocal has a serious flaw: it can take an arbitrarily long amount of time to dereference the things you had stored in it, even once the ThreadLocal instance itself is no longer referenced. This is because there is single, master map stored for each thread, which all ThreadLocals share, and that master map only periodically purges "stale" entries. More...
 
class  CloseableThreadLocalExtensions
 
class  Constants
 Some useful constants. More...
 
class  DocIdBitSet
 Simple DocIdSet and DocIdSetIterator backed by a BitSet More...
 
class  FieldCacheSanityChecker
 Provides methods for sanity checking that entries in the FieldCache are not wasteful or inconsistent. Lucene 2.9 Introduced numerous enhancements into how the FieldCache is used by the low levels of Lucene searching (for Sorting and ValueSourceQueries) to improve both the speed for Sorting, as well as reopening of IndexReaders. But these changes have shifted the usage of FieldCache from "top level" IndexReaders (frequently a MultiReader or DirectoryReader) down to the leaf level SegmentReaders. As a result, existing applications that directly access the FieldCache may find RAM usage increase significantly when upgrading to 2.9 or Later. This class provides an API for these applications (or their Unit tests) to check at run time if the FieldCache contains "insane" usages of the FieldCache. EXPERIMENTAL API: This API is considered extremely advanced and experimental. It may be removed or altered w/o warning in future releases of Lucene. More...
 
interface  IAttribute
 Base interface for attributes. More...
 
class  IdentityDictionary< TKey, TValue >
 A class that mimics Java's IdentityHashMap in that it determines object equality solely on ReferenceEquals rather than (possibly overloaded) object.Equals(). More...
 
class  IndexableBinaryStringTools
 Provides support for converting byte sequences to Strings and back again. The resulting Strings preserve the original byte sequences' sort order. More...
 
class  MapOfSets< TKey, TValue >
 Helper class for keeping Listss of Objects associated with keys. WARNING: THIS CLASS IS NOT THREAD SAFE More...
 
class  MemoryModel
 Returns primitive memory sizes for estimating RAM usage. More...
 
class  NumericUtils
 This is a helper class to generate prefix-encoded representations for numerical values and supplies converters to represent float/double values as sortable integers/longs. More...
 
class  OpenBitSet
 An "open" BitSet implementation that allows direct access to the array of words storing the bits. Unlike java.util.bitset, the fact that bits are packed into an array of longs is part of the interface. This allows efficient implementation of other algorithms by someone other than the author. It also allows one to efficiently implement alternate serialization or interchange formats. OpenBitSet is faster than java.util.BitSet in most operations and much faster at calculating cardinality of sets and results of set operations. It can also handle sets of larger cardinality (up to 64 * 2**32-1) The goals of OpenBitSet are the fastest implementation possible, and maximum code reuse. Extra safety and encapsulation may always be built on top, but if that's built in, the cost can never be removed (and hence people re-implement their own version in order to get better performance). If you want a "safe", totally encapsulated (and slower and limited) BitSet class, use java.util.BitSet. More...
 
class  OpenBitSetDISI
 
class  OpenBitSetIterator
 An iterator to iterate over set bits in an OpenBitSet. This is faster than nextSetBit() for iterating over the complete set of bits, especially when the density of the bits set is high. More...
 
class  PriorityQueue< T >
 A PriorityQueue maintains a partial ordering of its elements such that the least element can always be found in constant time. Put()'s and pop()'s require log(size) time. More...
 
class  RamUsageEstimator
 Estimates the size of a given Object using a given MemoryModel for primitive size information. More...
 
class  ReaderUtil
 Common util methods for dealing with IndexReaders. More...
 
class  ScorerDocQueue
 A ScorerDocQueue maintains a partial ordering of its Scorers such that the least Scorer can always be found in constant time. Put()'s and pop()'s require log(size) time. The ordering is by Scorer.doc(). More...
 
class  SimpleStringInterner
 Simple lockless and memory barrier free String intern cache that is guaranteed to return the same String instance as String.intern() does. More...
 
class  SmallFloat
 Floating point numbers smaller than 32 bits. More...
 
class  SortedVIntList
 Stores and iterate on sorted integers in compressed form in RAM.
The code for compressing the differences between ascending integers was borrowed from Lucene.Net.Store.IndexInput and Lucene.Net.Store.IndexOutput.NOTE: this class assumes the stored integers are doc Ids (hence why it extends DocIdSet). Therefore its Iterator() assumes DocIdSetIterator.NO_MORE_DOCS can be used as sentinel. If you intent to use this value, then make sure it's not used during search flow. More...
 
class  SorterTemplate
 Borrowed from Cglib. Allows custom swap so that two arrays can be sorted at the same time. More...
 
class  StringHelper
 Methods for manipulating strings. More...
 
class  StringInterner
 Subclasses of StringInterner are required to return the same single String object for all equal strings. Depending on the implementation, this may not be the same object returned as String.intern(). More...
 
class  ToStringUtils
 Helper methods to ease implementing Object.ToString(). More...
 
class  UnicodeUtil
 Class to encode java's UTF16 char[] into UTF8 byte[] without always allocating a new byte[] as String.getBytes("UTF-8") does.
 
class  VersionEnumExtensions
 

Enumerations

enum  Version {
  LUCENE_20, LUCENE_21, LUCENE_22, LUCENE_23,
  LUCENE_24, LUCENE_29, LUCENE_30, LUCENE_CURRENT
}
 Use by certain classes to match version compatibility across releases of Lucene. WARNING: When changing the version parameter that you supply to components in Lucene, do not simply change the version at search-time, but instead also adjust your indexing code to match, and re-index. More...
 

Enumeration Type Documentation

Use by certain classes to match version compatibility across releases of Lucene. WARNING: When changing the version parameter that you supply to components in Lucene, do not simply change the version at search-time, but instead also adjust your indexing code to match, and re-index.

Enumerator
LUCENE_20 

Match settings and bugs in Lucene's 2.0 release.

LUCENE_21 

Match settings and bugs in Lucene's 2.1 release.

LUCENE_22 

Match settings and bugs in Lucene's 2.2 release.

LUCENE_23 

Match settings and bugs in Lucene's 2.3 release.

LUCENE_24 

Match settings and bugs in Lucene's 2.4 release.

LUCENE_29 

Match settings and bugs in Lucene's 2.9 release.

LUCENE_30 

Match settings and bugs in Lucene's 3.0 release.

Use this to get the latest and greatest settings, bug fixes, etc, for Lucene.

LUCENE_CURRENT 

WARNING: if you use this setting, and then upgrade to a newer release of Lucene, sizable changes may happen. If precise back compatibility is important then you should instead explicitly specify an actual version. If you use this constant then you may need to re-index all of your documents when upgrading Lucene, as the way text is indexed may have changed. Additionally, you may need to re-test your entire application to ensure it behaves as expected, as some defaults may have changed and may break functionality in your application.

Definition at line 30 of file Version.cs.