Module org.apache.lucene.core

Package org.apache.lucene.store

Class IOContext

java.lang.Object

org.apache.lucene.store.IOContext

public class IOContext
extends Object

IOContext holds additional details on the merge/search context. A IOContext object can never be initialized as null as passed as a parameter to either Directory.openInput(String, IOContext) or Directory.createOutput(String, IOContext)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	IOContext.Context	Context is a enumerator which specifies the context in which the Directory is being used for.

Field Summary

Fields

Modifier and Type	Field	Description
final IOContext.Context	context	An object of a enumerator Context type
static final IOContext	DEFAULT
final FlushInfo	flushInfo
final boolean	load	This flag is used for files that are a small fraction of the total index size and are expected to be heavily accessed in random-access fashion.
static final IOContext	LOAD
final MergeInfo	mergeInfo
static final IOContext	READ
final boolean	readOnce	This flag indicates that the file will be opened, then fully read sequentially then closed.
static final IOContext	READONCE

Constructor Summary

Constructors

Modifier	Constructor	Description
	IOContext()
private	IOContext(boolean readOnce, boolean load)
	IOContext(FlushInfo flushInfo)
	IOContext(IOContext.Context context)
private	IOContext(IOContext.Context context, MergeInfo mergeInfo)
	IOContext(IOContext ctxt, boolean readOnce)	This constructor is used to initialize a IOContext instance with a new value for the readOnce variable.
	IOContext(MergeInfo mergeInfo)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

context

public final IOContext.Context context

An object of a enumerator Context type

mergeInfo

public final MergeInfo mergeInfo

flushInfo

public final FlushInfo flushInfo

readOnce

public final boolean readOnce

This flag indicates that the file will be opened, then fully read sequentially then closed.

load

public final boolean load

This flag is used for files that are a small fraction of the total index size and are expected to be heavily accessed in random-access fashion. Some Directory implementations may choose to load such files into physical memory (e.g. Java heap) as a way to provide stronger guarantees on query latency.

DEFAULT

public static final IOContext DEFAULT

READONCE

public static final IOContext READONCE

READ

public static final IOContext READ

LOAD

public static final IOContext LOAD

Constructor Details

IOContext

public IOContext()

IOContext

public IOContext(FlushInfo flushInfo)

IOContext

public IOContext(IOContext.Context context)

IOContext

private IOContext(boolean readOnce,
 boolean load)

IOContext

public IOContext(MergeInfo mergeInfo)

IOContext

private IOContext(IOContext.Context context,
 MergeInfo mergeInfo)

IOContext

public IOContext(IOContext ctxt,
 boolean readOnce)

This constructor is used to initialize a IOContext instance with a new value for the readOnce variable.

Parameters:

ctxt - IOContext object whose information is used to create the new instance except the readOnce variable.

readOnce - The new IOContext object will use this value for readOnce.

Method Details

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object