Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.blocktreeords

Class FSTOrdsOutputs

java.lang.Object

org.apache.lucene.util.fst.Outputs<FSTOrdsOutputs.Output>

org.apache.lucene.codecs.blocktreeords.FSTOrdsOutputs

final class FSTOrdsOutputs
extends Outputs<FSTOrdsOutputs.Output>

A custom FST outputs implementation that stores block data (BytesRef), long ordStart, long numTerms.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FSTOrdsOutputs.Output

Field Summary

Fields

Modifier and Type	Field	Description
private static final BytesRef	NO_BYTES
static final FSTOrdsOutputs.Output	NO_OUTPUT

Constructor Summary

Constructors

Constructor	Description
FSTOrdsOutputs()

Method Summary

Modifier and Type	Method	Description
FSTOrdsOutputs.Output	add(FSTOrdsOutputs.Output prefix, FSTOrdsOutputs.Output output)	Eg add("foo", "bar") -> "foobar"
FSTOrdsOutputs.Output	common(FSTOrdsOutputs.Output output1, FSTOrdsOutputs.Output output2)	Eg common("foobar", "food") -> "foo"
FSTOrdsOutputs.Output	getNoOutput()	NOTE: this output is compared with == so you must ensure that all methods return the single object if it's really no output
FSTOrdsOutputs.Output	newOutput(BytesRef bytes, long startOrd, long endOrd)
String	outputToString(FSTOrdsOutputs.Output output)
long	ramBytesUsed(FSTOrdsOutputs.Output output)	Return memory usage for the provided output.
FSTOrdsOutputs.Output	read(DataInput in)	Decode an output value previously written with Outputs.write(Object, DataOutput).
void	skipFinalOutput(DataInput in)	Skip the output previously written with Outputs.writeFinalOutput(T, org.apache.lucene.store.DataOutput); defaults to just calling Outputs.readFinalOutput(org.apache.lucene.store.DataInput) and discarding the result.
void	skipOutput(DataInput in)	Skip the output; defaults to just calling Outputs.read(org.apache.lucene.store.DataInput) and discarding the result.
FSTOrdsOutputs.Output	subtract(FSTOrdsOutputs.Output output, FSTOrdsOutputs.Output inc)	Eg subtract("foobar", "foo") -> "bar"
void	write(FSTOrdsOutputs.Output prefix, DataOutput out)	Encode an output value into a DataOutput.

Methods inherited from class org.apache.lucene.util.fst.Outputs

merge, readFinalOutput, writeFinalOutput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NO_OUTPUT

public static final FSTOrdsOutputs.Output NO_OUTPUT

NO_BYTES

private static final BytesRef NO_BYTES

Constructor Details

FSTOrdsOutputs

FSTOrdsOutputs()

Method Details

common

public FSTOrdsOutputs.Output common(FSTOrdsOutputs.Output output1,
 FSTOrdsOutputs.Output output2)

Description copied from class: Outputs

Eg common("foobar", "food") -> "foo"

Specified by:

common in class Outputs<FSTOrdsOutputs.Output>

subtract

public FSTOrdsOutputs.Output subtract(FSTOrdsOutputs.Output output,
 FSTOrdsOutputs.Output inc)

Description copied from class: Outputs

Eg subtract("foobar", "foo") -> "bar"

Specified by:

subtract in class Outputs<FSTOrdsOutputs.Output>

add

public FSTOrdsOutputs.Output add(FSTOrdsOutputs.Output prefix,
 FSTOrdsOutputs.Output output)

Description copied from class: Outputs

Eg add("foo", "bar") -> "foobar"

Specified by:

add in class Outputs<FSTOrdsOutputs.Output>

write

public void write(FSTOrdsOutputs.Output prefix,
 DataOutput out)
           throws IOException

Description copied from class: Outputs

Encode an output value into a DataOutput.

Specified by:

write in class Outputs<FSTOrdsOutputs.Output>

Throws:

IOException

read

public FSTOrdsOutputs.Output read(DataInput in)
                           throws IOException

Description copied from class: Outputs

Decode an output value previously written with Outputs.write(Object, DataOutput).

Specified by:

read in class Outputs<FSTOrdsOutputs.Output>

Throws:

IOException

skipOutput

public void skipOutput(DataInput in)
                throws IOException

Description copied from class: Outputs

Skip the output; defaults to just calling Outputs.read(org.apache.lucene.store.DataInput) and discarding the result.

Overrides:

skipOutput in class Outputs<FSTOrdsOutputs.Output>

Throws:

IOException

skipFinalOutput

public void skipFinalOutput(DataInput in)
                     throws IOException

Description copied from class: Outputs

Skip the output previously written with Outputs.writeFinalOutput(T, org.apache.lucene.store.DataOutput); defaults to just calling Outputs.readFinalOutput(org.apache.lucene.store.DataInput) and discarding the result.

Overrides:

skipFinalOutput in class Outputs<FSTOrdsOutputs.Output>

Throws:

IOException

getNoOutput

public FSTOrdsOutputs.Output getNoOutput()

Description copied from class: Outputs

NOTE: this output is compared with == so you must ensure that all methods return the single object if it's really no output

Specified by:

getNoOutput in class Outputs<FSTOrdsOutputs.Output>

outputToString

public String outputToString(FSTOrdsOutputs.Output output)

Specified by:

outputToString in class Outputs<FSTOrdsOutputs.Output>

newOutput

public FSTOrdsOutputs.Output newOutput(BytesRef bytes,
 long startOrd,
 long endOrd)

ramBytesUsed

public long ramBytesUsed(FSTOrdsOutputs.Output output)

Description copied from class: Outputs

Return memory usage for the provided output.

Specified by:

ramBytesUsed in class Outputs<FSTOrdsOutputs.Output>

See Also:

• Accountable