core/org.gnit.lucenekmp.index/SegmentInfo

SegmentInfo

class SegmentInfo(dir: Directory, version: Version, minVersion: Version?, name: String, maxDoc: Int, isCompoundFile: Boolean, hasBlocks: Boolean, codec: Codec?, diagnostics: MutableMap<String, String>, id: ByteArray, attributes: MutableMap<String, String>, indexSort: Sort?)

Information about a segment such as its name, directory, and files related to the segment.

Constructors

SegmentInfo

constructor(dir: Directory, version: Version, minVersion: Version?, name: String, maxDoc: Int, isCompoundFile: Boolean, hasBlocks: Boolean, codec: Codec?, diagnostics: MutableMap<String, String>, id: ByteArray, attributes: MutableMap<String, String>, indexSort: Sort?)

Types

Companion

object Companion

Return the sort order of this segment, or null if the index has no sort.

Properties

attributes

var attributes: MutableMap<String, String>

Returns the internal codec attributes map.

codec

var codec: Codec

diagnostics

var diagnostics: MutableMap<String, String>

dir

val dir: Directory

Where this segment resides.

hasBlocks

var hasBlocks: Boolean

Returns true if this segment contains documents written as blocks.

indexSort

val indexSort: Sort?

minVersion

var minVersion: Version?

Return the minimum Lucene version that contributed documents to this segment, or null if it is unknown.

name

val name: String

Unique segment name in the directory.

useCompoundFile

var useCompoundFile: Boolean

Mark whether this segment is stored as a compound file.

version

val version: Version

Functions

addDiagnostics

fun addDiagnostics(diagnostics: MutableMap<String, String>)

Adds or modifies this segment's diagnostics.

addFile

fun addFile(file: String)

Add this file to the set of files written for this segment.

addFiles

fun addFiles(files: MutableCollection<String>)

Add these files to the set of files written for this segment.

equals

open operator override fun equals(obj: Any?): Boolean

We consider another SegmentInfo instance equal if it has the same dir and same name.

files

fun files(): MutableSet<String>

Return all files referenced by this SegmentInfo.

getAttribute

fun getAttribute(key: String): String

Get a codec attribute value, or null if it does not exist

getId

fun getId(): ByteArray

Return the id that uniquely identifies this segment.

hashCode

open override fun hashCode(): Int

maxDoc

fun maxDoc(): Int

Returns number of documents in this segment (deletions are not taken into account).

namedForThisSegment

fun namedForThisSegment(file: String): String

strips any segment name from the file, naming it with this segment this is because "segment names" can change, e.g. by addIndexes(Dir)

putAttribute

fun putAttribute(key: String, value: String): String?

Puts a codec attribute value.

setFiles

fun setFiles(files: MutableCollection<String>)

Sets the files written for this segment.

setHasBlocks

fun setHasBlocks()

Sets the hasBlocks property to true. This setting is viral and can't be unset.

setMaxDoc

fun setMaxDoc(maxDoc: Int)

toString

open override fun toString(): String

fun toString(delCount: Int): String

Used for debugging. Format may suddenly change.