Class Lucene3xSegmentInfoFormat

Lucene3x ReadOnly SegmentInfoFormat implementation.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance

object

SegmentInfoFormat

Lucene3xSegmentInfoFormat

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Codecs.Lucene3x

Assembly: Lucene.Net.dll

Syntax

[Obsolete("(4.0) this is only used to read indexes created before 4.0.")]
public class Lucene3xSegmentInfoFormat : SegmentInfoFormat

Fields

DS_COMPOUND_KEY

Lucene3x ReadOnly SegmentInfoFormat implementation.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public static readonly string DS_COMPOUND_KEY

Field Value

Type	Description
string

DS_NAME_KEY

Lucene3x ReadOnly SegmentInfoFormat implementation.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public static readonly string DS_NAME_KEY

Field Value

Type	Description
string

DS_OFFSET_KEY

Lucene3x ReadOnly SegmentInfoFormat implementation.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public static readonly string DS_OFFSET_KEY

Field Value

Type	Description
string

FORMAT_3_1

Each segment records the Lucene version that created it.

Declaration

public static readonly int FORMAT_3_1

Field Value

Type	Description
int

FORMAT_DIAGNOSTICS

This format adds optional per-segment String diagnostics storage, and switches userData to Map.

Declaration

public static readonly int FORMAT_DIAGNOSTICS

Field Value

Type	Description
int

FORMAT_HAS_VECTORS

Each segment records whether it has term vectors.

Declaration

public static readonly int FORMAT_HAS_VECTORS

Field Value

Type	Description
int

NORMGEN_KEY

Lucene3x ReadOnly SegmentInfoFormat implementation.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public static readonly string NORMGEN_KEY

Field Value

Type	Description
string

NORMGEN_PREFIX

Lucene3x ReadOnly SegmentInfoFormat implementation.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public static readonly string NORMGEN_PREFIX

Field Value

Type	Description
string

UPGRADED_SI_CODEC_NAME

Lucene3x ReadOnly SegmentInfoFormat implementation.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public static readonly string UPGRADED_SI_CODEC_NAME

Field Value

Type	Description
string

UPGRADED_SI_EXTENSION

Extension used for saving each SegmentInfo, once a 3.x index is first committed to with 4.0.

Declaration

public static readonly string UPGRADED_SI_EXTENSION

Field Value

Type	Description
string

UPGRADED_SI_VERSION_CURRENT

Lucene3x ReadOnly SegmentInfoFormat implementation.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public static readonly int UPGRADED_SI_VERSION_CURRENT

Field Value

Type	Description
int

UPGRADED_SI_VERSION_START

Lucene3x ReadOnly SegmentInfoFormat implementation.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public static readonly int UPGRADED_SI_VERSION_START

Field Value

Type	Description
int

Properties

SegmentInfoReader

Returns the SegmentInfoReader for reading SegmentInfo instances.

Declaration

public override SegmentInfoReader SegmentInfoReader { get; }

Property Value

Type	Description
SegmentInfoReader

Overrides

SegmentInfoFormat.SegmentInfoReader

SegmentInfoWriter

Returns the SegmentInfoWriter for writing SegmentInfo instances.

Declaration

public override SegmentInfoWriter SegmentInfoWriter { get; }

Property Value

Type	Description
SegmentInfoWriter

Overrides

SegmentInfoFormat.SegmentInfoWriter

Methods

GetDocStoreIsCompoundFile(SegmentInfo)

Lucene3x ReadOnly SegmentInfoFormat implementation.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public static bool GetDocStoreIsCompoundFile(SegmentInfo si)

Parameters

Type	Name	Description
SegmentInfo	si

Returns

Type	Description
bool	Whether doc store files are stored in compound file (*.cfx).

GetDocStoreOffset(SegmentInfo)

Lucene3x ReadOnly SegmentInfoFormat implementation.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public static int GetDocStoreOffset(SegmentInfo si)

Parameters

Type	Name	Description
SegmentInfo	si

Returns

Type	Description
int	If this segment shares stored fields & vectors, this offset is where in that file this segment's docs begin.

GetDocStoreSegment(SegmentInfo)

Lucene3x ReadOnly SegmentInfoFormat implementation.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public static string GetDocStoreSegment(SegmentInfo si)

Parameters

Type	Name	Description
SegmentInfo	si

Returns

Type	Description
string	Name used to derive fields/vectors file we share with other segments.