org.apache.lucene.index

Class SegmentInfo

java.lang.Object

org.apache.lucene.index.SegmentInfo

All Implemented Interfaces:

java.lang.Cloneable

public final class SegmentInfo
extends java.lang.Object
implements java.lang.Cloneable

Information about a segment such as it's name, directory, and files related to the segment.

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

Field Summary

Fields

Modifier and Type	Field and Description
Directory	dir
int	docCount
java.lang.String	name

Constructor Summary

Constructors

Constructor and Description
SegmentInfo(java.lang.String name, int docCount, Directory dir, boolean isCompoundFile, boolean hasSingleNormFile, boolean hasProx, boolean hasVectors)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
boolean	equals(java.lang.Object obj) We consider another SegmentInfo instance equal if it has the same dir and same name.
java.util.List<java.lang.String>	files()
int	getDelCount()
java.lang.String	getDelFileName()
java.util.Map<java.lang.String,java.lang.String>	getDiagnostics()
boolean	getDocStoreIsCompoundFile()
int	getDocStoreOffset()
java.lang.String	getDocStoreSegment()
boolean	getHasProx()
boolean	getHasVectors()
java.lang.String	getNormFileName(int number) Get the file name for the norms file for this field.
boolean	getUseCompoundFile() Returns true if this segment is stored as a compound file; else, false.
java.lang.String	getVersion() Returns the version of the code which wrote the segment.
boolean	hasDeletions()
int	hashCode()
boolean	hasSeparateNorms() Returns true if any fields in this segment have separate norms.
boolean	hasSeparateNorms(int fieldNumber) Returns true if this field for this segment has saved a separate norms file (__N.sX).
void	setDocStoreSegment(java.lang.String segment)
void	setHasVectors(boolean v)
long	sizeInBytes(boolean includeDocStores) Returns total size in bytes of all of files used by this segment (if includeDocStores is true), or the size of all files except the store files otherwise.
java.lang.String	toString()
java.lang.String	toString(Directory dir, int pendingDelCount) Used for debugging.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

name

public java.lang.String name

docCount

public int docCount

dir

public Directory dir

Constructor Detail

SegmentInfo

public SegmentInfo(java.lang.String name,
                   int docCount,
                   Directory dir,
                   boolean isCompoundFile,
                   boolean hasSingleNormFile,
                   boolean hasProx,
                   boolean hasVectors)

Method Detail

getDiagnostics

public java.util.Map<java.lang.String,java.lang.String> getDiagnostics()

sizeInBytes

public long sizeInBytes(boolean includeDocStores)
                 throws java.io.IOException

Returns total size in bytes of all of files used by this segment (if includeDocStores is true), or the size of all files except the store files otherwise.

Throws:

java.io.IOException

getHasVectors

public boolean getHasVectors()
                      throws java.io.IOException

Throws:

java.io.IOException

setHasVectors

public void setHasVectors(boolean v)

hasDeletions

public boolean hasDeletions()
                     throws java.io.IOException

Throws:

java.io.IOException

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

getDelFileName

public java.lang.String getDelFileName()

hasSeparateNorms

public boolean hasSeparateNorms(int fieldNumber)
                         throws java.io.IOException

Returns true if this field for this segment has saved a separate norms file (__N.sX).

Parameters:

fieldNumber - the field index to check

Throws:

java.io.IOException

hasSeparateNorms

public boolean hasSeparateNorms()
                         throws java.io.IOException

Returns true if any fields in this segment have separate norms.

Throws:

java.io.IOException

getNormFileName

public java.lang.String getNormFileName(int number)
                                 throws java.io.IOException

Get the file name for the norms file for this field.

Parameters:

number - field index

Throws:

java.io.IOException

getUseCompoundFile

public boolean getUseCompoundFile()
                           throws java.io.IOException

Returns true if this segment is stored as a compound file; else, false.

Throws:

java.io.IOException

getDelCount

public int getDelCount()
                throws java.io.IOException

Throws:

java.io.IOException

getDocStoreOffset

public int getDocStoreOffset()

getDocStoreIsCompoundFile

public boolean getDocStoreIsCompoundFile()

getDocStoreSegment

public java.lang.String getDocStoreSegment()

setDocStoreSegment

public void setDocStoreSegment(java.lang.String segment)

getHasProx

public boolean getHasProx()

files

public java.util.List<java.lang.String> files()
                                       throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(Directory dir,
                                 int pendingDelCount)

Used for debugging. Format may suddenly change.

Current format looks like _a(3.1):c45/4->_1, which means the segment's name is _a; it was created with Lucene 3.1 (or '?' if it's unkown); it's using compound file format (would be C if not compound); it has 45 documents; it has 4 deletions (this part is left off when there are no deletions); it's using the shared doc stores named _1 (this part is left off if doc stores are private).

equals

public boolean equals(java.lang.Object obj)

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

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getVersion

public java.lang.String getVersion()

Returns the version of the code which wrote the segment.