# Serialized Form

Package org.apache.lucene.document

Class org.apache.lucene.document.AbstractField extends Object implements Serializable

Serialized Fields

### name

    String name

### storeTermVector

    boolean storeTermVector

### storeOffsetWithTermVector

    boolean storeOffsetWithTermVector

### storePositionWithTermVector

    boolean storePositionWithTermVector

### omitNorms

    boolean omitNorms

### isStored

    boolean isStored

### isIndexed

    boolean isIndexed

### isTokenized

    boolean isTokenized

### isBinary

    boolean isBinary

### isCompressed

    boolean isCompressed

### lazy

    boolean lazy

### omitTf

    boolean omitTf

### boost

    float boost

### fieldsData

    Object fieldsData

### binaryLength

    int binaryLength

### binaryOffset

    int binaryOffset

Class org.apache.lucene.document.Document extends Object implements Serializable

Serialized Fields

### fields

    List<E> fields

### boost

    float boost

Class org.apache.lucene.document.Field extends AbstractField implements Serializable

Class org.apache.lucene.document.Field.Index extends Parameter implements Serializable

Class org.apache.lucene.document.Field.Store extends Parameter implements Serializable

Class org.apache.lucene.document.Field.TermVector extends Parameter implements Serializable

Class org.apache.lucene.document.FieldSelectorResult extends Object implements Serializable

Serialized Fields

### id

    int id

Class org.apache.lucene.document.LoadFirstFieldSelector extends Object implements Serializable

Class org.apache.lucene.document.MapFieldSelector extends Object implements Serializable

Serialized Fields

### fieldSelections

    Map<K,V> fieldSelections

Class org.apache.lucene.document.SetBasedFieldSelector extends Object implements Serializable

Serialized Fields

### fieldsToLoad

    Set<E> fieldsToLoad

### lazyFieldsToLoad

    Set<E> lazyFieldsToLoad

Package org.apache.lucene.index

Class org.apache.lucene.index.CorruptIndexException extends IOException implements Serializable

Class org.apache.lucene.index.FieldReaderException extends RuntimeException implements Serializable

Class org.apache.lucene.index.MergePolicy.MergeAbortedException extends IOException implements Serializable

Class org.apache.lucene.index.MergePolicy.MergeException extends RuntimeException implements Serializable

Serialized Fields

### dir

    Directory dir

Class org.apache.lucene.index.Payload extends Object implements Serializable

Serialized Fields

### data

    byte[] data

  the byte array containing the payload data

### offset

    int offset

  the offset within the byte array

### length

    int length

  the length of the payload data

Class org.apache.lucene.index.StaleReaderException extends IOException implements Serializable

Class org.apache.lucene.index.Term extends Object implements Serializable

Serialization Methods

### readObject

    private void readObject(ObjectInputStream in)
                     throws IOException,
                            ClassNotFoundException

  Throws:
    `IOException`
    `ClassNotFoundException`

Serialized Fields

### field

    String field

### text

    String text

Package org.apache.lucene.queryParser

Class org.apache.lucene.queryParser.ParseException extends Exception implements Serializable

Serialized Fields

### specialConstructor

    boolean specialConstructor

  This variable determines which constructor was used to create this object and thereby affects the semantics of the "getMessage" method (see below).

### currentToken

    Token currentToken

  This is the last token that has been consumed successfully. If this object has been created due to a parse error, the token followng this token will (therefore) be the first error token.

### expectedTokenSequences

    int[][] expectedTokenSequences

  Each entry in this array is an array of integers. Each array of integers represents a sequence of tokens (by their ordinal values) that is expected at this point of the parse.

### tokenImage

    String[] tokenImage

  This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred. This array is defined in the generated ...Constants interface.

### eol

    String eol

  The end of line string for this machine.

Class org.apache.lucene.queryParser.QueryParser.Operator extends Parameter implements Serializable

Class org.apache.lucene.queryParser.TokenMgrError extends Error implements Serializable

Serialized Fields

### errorCode

    int errorCode

  Indicates the reason why the exception is thrown. It will have one of the above 4 values.

Package org.apache.lucene.search

Class org.apache.lucene.search.BooleanClause extends Object implements Serializable

Serialized Fields

### query

    Query query

  The query whose matching documents are combined by the boolean query.

### occur

    BooleanClause.Occur occur

Class org.apache.lucene.search.BooleanClause.Occur extends Parameter implements Serializable

Class org.apache.lucene.search.BooleanQuery extends Query implements Serializable

Serialized Fields

### clauses

    ArrayList<E> clauses

### disableCoord

    boolean disableCoord

### minNrShouldMatch

    int minNrShouldMatch

Class org.apache.lucene.search.BooleanQuery.TooManyClauses extends RuntimeException implements Serializable

Class org.apache.lucene.search.CachingSpanFilter extends SpanFilter implements Serializable

Serialized Fields

### filter

    SpanFilter filter

Class org.apache.lucene.search.CachingWrapperFilter extends Filter implements Serializable

Serialized Fields

### filter

    Filter filter

Class org.apache.lucene.search.ComplexExplanation extends Explanation implements Serializable

Serialized Fields

### match

    Boolean match

Class org.apache.lucene.search.ConstantScoreQuery extends Query implements Serializable

Serialized Fields

### filter

    Filter filter

Class org.apache.lucene.search.ConstantScoreQuery.ConstantWeight extends Object implements Serializable

Serialized Fields

### similarity

    Similarity similarity

### queryNorm

    float queryNorm

### queryWeight

    float queryWeight

Class org.apache.lucene.search.ConstantScoreRangeQuery extends Query implements Serializable

Serialized Fields

### fieldName

    String fieldName

### lowerVal

    String lowerVal

### upperVal

    String upperVal

### includeLower

    boolean includeLower

### includeUpper

    boolean includeUpper

### collator

    Collator collator

Class org.apache.lucene.search.DefaultSimilarity extends Similarity implements Serializable

Class org.apache.lucene.search.DisjunctionMaxQuery extends Query implements Serializable

Serialized Fields

### disjuncts

    ArrayList<E> disjuncts

### tieBreakerMultiplier

    float tieBreakerMultiplier

Class org.apache.lucene.search.Explanation extends Object implements Serializable

Serialized Fields

### value

    float value

### description

    String description

### details

    ArrayList<E> details

Class org.apache.lucene.search.FieldDoc extends ScoreDoc implements Serializable

Serialized Fields

### fields

    Comparable<T>[] fields

  Expert: The values which are used to sort the referenced document. The order of these will match the original sort criteria given by a Sort object. Each Object will be either an Integer, Float or String, depending on the type of values in the terms of the original field.

  See Also:
    `Sort`, `Searcher.search(Query,Filter,int,Sort)`

Class org.apache.lucene.search.Filter extends Object implements Serializable

Class org.apache.lucene.search.FilteredQuery extends Query implements Serializable

Serialized Fields

### query

    Query query

### filter

    Filter filter

Class org.apache.lucene.search.FuzzyQuery extends MultiTermQuery implements Serializable

Serialized Fields

### minimumSimilarity

    float minimumSimilarity

### prefixLength

    int prefixLength

Class org.apache.lucene.search.Hit extends Object implements Serializable

Serialized Fields

### doc

    Document doc

  Deprecated.

### resolved

    boolean resolved

  Deprecated.

### hits

    Hits hits

  Deprecated.

### hitNumber

    int hitNumber

  Deprecated.

Class org.apache.lucene.search.MatchAllDocsQuery extends Query implements Serializable

Class org.apache.lucene.search.MultiPhraseQuery extends Query implements Serializable

Serialized Fields

### field

    String field

### termArrays

    ArrayList<E> termArrays

### positions

    ArrayList<E> positions

### slop

    int slop

Class org.apache.lucene.search.MultiTermQuery extends Query implements Serializable

Serialized Fields

### term

    Term term

Class org.apache.lucene.search.PhraseQuery extends Query implements Serializable

Serialized Fields

### field

    String field

### terms

    ArrayList<E> terms

### positions

    ArrayList<E> positions

### maxPosition

    int maxPosition

### slop

    int slop

Class org.apache.lucene.search.PrefixFilter extends Filter implements Serializable

Serialized Fields

### prefix

    Term prefix

Class org.apache.lucene.search.PrefixQuery extends Query implements Serializable

Serialized Fields

### prefix

    Term prefix

Class org.apache.lucene.search.Query extends Object implements Serializable

Serialized Fields

### boost

    float boost

Class org.apache.lucene.search.QueryFilter extends CachingWrapperFilter implements Serializable

Class org.apache.lucene.search.QueryWrapperFilter extends Filter implements Serializable

Serialized Fields

### query

    Query query

Class org.apache.lucene.search.RangeFilter extends Filter implements Serializable

Serialized Fields

### fieldName

    String fieldName

### lowerTerm

    String lowerTerm

### upperTerm

    String upperTerm

### includeLower

    boolean includeLower

### includeUpper

    boolean includeUpper

### collator

    Collator collator

Class org.apache.lucene.search.RangeQuery extends Query implements Serializable

Serialized Fields

### lowerTerm

    Term lowerTerm

### upperTerm

    Term upperTerm

### inclusive

    boolean inclusive

### collator

    Collator collator

Class org.apache.lucene.search.RemoteCachingWrapperFilter extends Filter implements Serializable

Serialized Fields

### filter

    Filter filter

Class org.apache.lucene.search.RemoteSearchable extends UnicastRemoteObject implements Serializable

Serialized Fields

### local

    Searchable local

Class org.apache.lucene.search.RemoteSearchable_Stub extends RemoteStub implements Serializable

serialVersionUID: 2L

Class org.apache.lucene.search.ScoreDoc extends Object implements Serializable

Serialized Fields

### score

    float score

  Expert: The score of this document for the query.

### doc

    int doc

  Expert: A hit document's number.

  See Also:
    `Searcher.doc(int)`

Class org.apache.lucene.search.Similarity extends Object implements Serializable

Class org.apache.lucene.search.SimilarityDelegator extends Similarity implements Serializable

Serialized Fields

### delegee

    Similarity delegee

Class org.apache.lucene.search.Sort extends Object implements Serializable

Serialized Fields

### fields

    SortField[] fields

Class org.apache.lucene.search.SortComparator extends Object implements Serializable

Class org.apache.lucene.search.SortField extends Object implements Serializable

Serialized Fields

### field

    String field

### type

    int type

### locale

    Locale locale

### reverse

    boolean reverse

### factory

    SortComparatorSource factory

Class org.apache.lucene.search.SpanFilter extends Filter implements Serializable

Class org.apache.lucene.search.SpanQueryFilter extends SpanFilter implements Serializable

Serialized Fields

### query

    SpanQuery query

Class org.apache.lucene.search.TermQuery extends Query implements Serializable

Serialized Fields

### term

    Term term

Class org.apache.lucene.search.TimeLimitedCollector.TimeExceededException extends RuntimeException implements Serializable

Serialized Fields

### timeAllowed

    long timeAllowed

### timeElapsed

    long timeElapsed

### lastDocCollected

    int lastDocCollected

Class org.apache.lucene.search.TopDocs extends Object implements Serializable

Serialized Fields

### totalHits

    int totalHits

  Expert: The total number of hits for the query.

  See Also:
    `Hits.length()`

### scoreDocs

    ScoreDoc[] scoreDocs

  Expert: The top hits for the query.

### maxScore

    float maxScore

  Expert: Stores the maximum score value encountered, needed for normalizing.

Class org.apache.lucene.search.TopFieldDocs extends TopDocs implements Serializable

Serialized Fields

### fields

    SortField[] fields

  The fields which were used to sort results by.

Class org.apache.lucene.search.WildcardQuery extends MultiTermQuery implements Serializable

Serialized Fields

### termContainsWildcard

    boolean termContainsWildcard

Package org.apache.lucene.search.function

Class org.apache.lucene.search.function.ByteFieldSource extends FieldCacheSource implements Serializable

Serialized Fields

### parser

    FieldCache.ByteParser parser

Class org.apache.lucene.search.function.CustomScoreQuery extends Query implements Serializable

Serialized Fields

### subQuery

    Query subQuery

### valSrcQueries

    ValueSourceQuery[] valSrcQueries

### strict

    boolean strict

Class org.apache.lucene.search.function.FieldCacheSource extends ValueSource implements Serializable

Serialized Fields

### field

    String field

Class org.apache.lucene.search.function.FieldScoreQuery extends ValueSourceQuery implements Serializable

Class org.apache.lucene.search.function.FloatFieldSource extends FieldCacheSource implements Serializable

Serialized Fields

### parser

    FieldCache.FloatParser parser

Class org.apache.lucene.search.function.IntFieldSource extends FieldCacheSource implements Serializable

Serialized Fields

### parser

    FieldCache.IntParser parser

Class org.apache.lucene.search.function.OrdFieldSource extends ValueSource implements Serializable

Serialized Fields

### field

    String field

Class org.apache.lucene.search.function.ReverseOrdFieldSource extends ValueSource implements Serializable

Serialized Fields

### field

    String field

Class org.apache.lucene.search.function.ShortFieldSource extends FieldCacheSource implements Serializable

Serialized Fields

### parser

    FieldCache.ShortParser parser

Class org.apache.lucene.search.function.ValueSource extends Object implements Serializable

Class org.apache.lucene.search.function.ValueSourceQuery extends Query implements Serializable

Serialized Fields

### valSrc

    ValueSource valSrc

Package org.apache.lucene.search.payloads

Class org.apache.lucene.search.payloads.BoostingTermQuery extends SpanTermQuery implements Serializable

Class org.apache.lucene.search.payloads.BoostingTermQuery.BoostingTermWeight extends SpanWeight implements Serializable

Package org.apache.lucene.search.spans

Class org.apache.lucene.search.spans.SpanFirstQuery extends SpanQuery implements Serializable

Serialized Fields

### match

    SpanQuery match

### end

    int end

Class org.apache.lucene.search.spans.SpanNearQuery extends SpanQuery implements Serializable

Serialized Fields

### clauses

    List<E> clauses

### slop

    int slop

### inOrder

    boolean inOrder

### field

    String field

Class org.apache.lucene.search.spans.SpanNotQuery extends SpanQuery implements Serializable

Serialized Fields

### include

    SpanQuery include

### exclude

    SpanQuery exclude

Class org.apache.lucene.search.spans.SpanOrQuery extends SpanQuery implements Serializable

Serialized Fields

### clauses

    List<E> clauses

### field

    String field

Class org.apache.lucene.search.spans.SpanQuery extends Query implements Serializable

Class org.apache.lucene.search.spans.SpanTermQuery extends SpanQuery implements Serializable

Serialized Fields

### term

    Term term

Class org.apache.lucene.search.spans.SpanWeight extends Object implements Serializable

Serialized Fields

### similarity

    Similarity similarity

### value

    float value

### idf

    float idf

### queryNorm

    float queryNorm

### queryWeight

    float queryWeight

### terms

    Set<E> terms

### query

    SpanQuery query

Package org.apache.lucene.store

Class org.apache.lucene.store.AlreadyClosedException extends IllegalStateException implements Serializable

Class org.apache.lucene.store.LockObtainFailedException extends IOException implements Serializable

Class org.apache.lucene.store.LockReleaseFailedException extends IOException implements Serializable

Class org.apache.lucene.store.RAMDirectory extends Directory implements Serializable

serialVersionUID: 1L

Serialized Fields

### fileMap

    HashMap<K,V> fileMap

### sizeInBytes

    long sizeInBytes

Package org.apache.lucene.util

Class org.apache.lucene.util.OpenBitSet extends DocIdSet implements Serializable

Serialized Fields

### bits

    long[] bits

### wlen

    int wlen

Class org.apache.lucene.util.OpenBitSetDISI extends OpenBitSet implements Serializable

Class org.apache.lucene.util.Parameter extends Object implements Serializable

Serialization Methods

### readResolve

    protected Object readResolve()
                          throws ObjectStreamException

  Resolves the deserialized instance to the local reference for accurate equals() and == comparisons.

  Throws:
    `ObjectStreamException`

Serialized Fields

### name

    String name

Copyright © 2000-2009 Apache Software Foundation. All Rights Reserved.