Home >> All >> org >> apache >> lucene >> [ index Javadoc ]

•	org.apache.lucene.index.store.* (1)

• org.apache.lucene.index: Javadoc index of package org.apache.lucene.index.


Package Samples:

• org.apache.lucene.index.store

Classes:

• IndexReader: IndexReader is an abstract class, providing an interface for accessing an index. Search of an index is done entirely through this abstract interface, so that any subclass which implements it is searchable. Concrete subclasses of IndexReader are usually constructed with a call to the static method open(java.lang.String) 55 . For efficiency, in this API documents are often referred to via document numbers , non-negative integers which each name a unique document in the index. These document numbers are ephemeral--they may change as documents are added to and deleted from an index. Clients should ...
• CompoundFileWriter: Combines multiple files into a single compound file. The file format: VInt fileCount {Directory} fileCount entries with the following structure: long dataOffset UTFString extension {File Data} fileCount entries with the raw data of the corresponding file The fileCount integer indicates how many files are contained in this compound file. The {directory} that follows has that many entries. Each directory entry contains an encoding identifier, an long pointer to the start of this file's data section, and a UTF String with that file's extension.
• IndexWriter: An IndexWriter creates and maintains an index. The third argument to the constructor determines whether a new index is created, or whether an existing index is opened for the addition of new documents. In either case, documents are added with the addDocument method. When finished adding documents, close should be called. If an index will not have more documents added for a while and optimal search performance is desired, then the optimize method should be called before the index is closed.
• FieldInfo: Copyright 2004 The Apache Software Foundation Licensed 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.
• FilterIndexReader: A FilterIndexReader contains another IndexReader, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality. The class FilterIndexReader itself simply implements all abstract methods of IndexReader with versions that pass all requests to the contained index reader. Subclasses of FilterIndexReader may further override some of these methods and may also provide additional methods and fields.
• SegmentMerger: The SegmentMerger class combines two or more Segments, represented by an IndexReader ( add(org.apache.lucene.index.IndexReader) 55 , into a single Segment. After adding the appropriate readers, call the merge method to combine the segments. If the compoundFile flag is set, then the segments will be merged into a compound file.
• TermVectorsWriter: Writer works by opening a document and then opening the fields within the document and then writing out the vectors for each field. Rough usage: for each document { writer.openDocument(); for each field on the document { writer.openField(field); for all of the terms { writer.addTerm(...) } writer.closeField } writer.closeDocument() }
• Term: A Term represents a word from text. This is the unit of search. It is composed of two elements, the text of the word, as a string, and the name of the field that the text occured in, an interned string. Note that terms may represent more than words from text fields, but also things like dates, email addresses, urls, etc.
• TermDocs: TermDocs provides an interface for enumerating <document, frequency> pairs for a term. The document portion names each document containing the term. Documents are indicated by number. The frequency portion gives the number of times the term occurred in each document. The pairs are ordered by document number.
• FieldInfos: Access to the Field Info file that describes document fields and whether or not they are indexed. Each segment has a separate Field Info file. Objects of this class are thread-safe for multiple readers, but only one thread can be adding documents at a time, with no other reader or writer threads accessing this object.
• TermPositions: TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples for a term. The document and frequency are the same as for a TermDocs. The positions portion lists the ordinal positions of each occurrence of a term in a document.
• CompoundFileReader: Class for accessing a compound stream. This class implements a directory, but is limited to only read operations. Directory methods that would normally modify data throw an exception.
• TermEnum: Abstract class for enumerating terms. Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it.
• TermInfosReader: This stores a monotonically increasing set of pairs in a Directory. Pairs are accessed either by Term or by ordinal position the set.
• TermInfosWriter: This stores a monotonically increasing set of pairs in a Directory. A TermInfos can be written once, in order.
• TermPositionVector: Extends TermFreqVector to provide additional information about positions in which each of the terms is found.
• FieldsReader: Class responsible for access to stored document fields. It uses <segment>.fdt and <segment>.fdx; files.
• MultiReader: An IndexReader which reads multiple indexes, appending their content.
• TermFreqVector: Provides access to stored term vector of a document field.
• TermInfo: A TermInfo is the record of information stored for a term.
• MultipleTermPositions: Describe class MultipleTermPositions here.

Home | Contact Us | Privacy Policy | Terms of Service