Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.memory

Class FSTTermOutputs

java.lang.Object

org.apache.lucene.util.fst.Outputs<FSTTermOutputs.TermData>

org.apache.lucene.codecs.memory.FSTTermOutputs

class FSTTermOutputs
extends Outputs<FSTTermOutputs.TermData>

An FST Outputs implementation for FSTTermsWriter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	FSTTermOutputs.TermData	Represents the metadata for one term.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	hasPos
private static final FSTTermOutputs.TermData	NO_OUTPUT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FSTTermOutputs(FieldInfo fieldInfo)

Method Summary

Modifier and Type	Method	Description
FSTTermOutputs.TermData	add(FSTTermOutputs.TermData t1, FSTTermOutputs.TermData t2)	Eg add("foo", "bar") -> "foobar"
(package private) static boolean	bytesEqual(FSTTermOutputs.TermData t1, FSTTermOutputs.TermData t2)
FSTTermOutputs.TermData	common(FSTTermOutputs.TermData t1, FSTTermOutputs.TermData t2)	Eg common("foobar", "food") -> "foo"
FSTTermOutputs.TermData	getNoOutput()	NOTE: this output is compared with == so you must ensure that all methods return the single object if it's really no output
String	outputToString(FSTTermOutputs.TermData data)
long	ramBytesUsed(FSTTermOutputs.TermData output)	Return memory usage for the provided output.
FSTTermOutputs.TermData	read(DataInput in)	Decode an output value previously written with Outputs.write(Object, DataOutput).
void	skipOutput(DataInput in)	Skip the output; defaults to just calling Outputs.read(org.apache.lucene.store.DataInput) and discarding the result.
(package private) static boolean	statsEqual(FSTTermOutputs.TermData t1, FSTTermOutputs.TermData t2)
FSTTermOutputs.TermData	subtract(FSTTermOutputs.TermData t1, FSTTermOutputs.TermData t2)	Eg subtract("foobar", "foo") -> "bar"
void	write(FSTTermOutputs.TermData data, DataOutput out)	Encode an output value into a DataOutput.

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

merge, readFinalOutput, skipFinalOutput, writeFinalOutput

Methods inherited from class java.lang.Object

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

Field Details

NO_OUTPUT

private static final FSTTermOutputs.TermData NO_OUTPUT

hasPos

private final boolean hasPos

Constructor Details

FSTTermOutputs

protected FSTTermOutputs(FieldInfo fieldInfo)

Method Details

ramBytesUsed

public long ramBytesUsed(FSTTermOutputs.TermData output)

Description copied from class: Outputs

Return memory usage for the provided output.

Specified by:

ramBytesUsed in class Outputs<FSTTermOutputs.TermData>

See Also:

• Accountable

common

public FSTTermOutputs.TermData common(FSTTermOutputs.TermData t1,
 FSTTermOutputs.TermData t2)

Description copied from class: Outputs

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

Specified by:

common in class Outputs<FSTTermOutputs.TermData>

subtract

public FSTTermOutputs.TermData subtract(FSTTermOutputs.TermData t1,
 FSTTermOutputs.TermData t2)

Description copied from class: Outputs

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

Specified by:

subtract in class Outputs<FSTTermOutputs.TermData>

add

public FSTTermOutputs.TermData add(FSTTermOutputs.TermData t1,
 FSTTermOutputs.TermData t2)

Description copied from class: Outputs

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

Specified by:

add in class Outputs<FSTTermOutputs.TermData>

write

public void write(FSTTermOutputs.TermData data,
 DataOutput out)
           throws IOException

Description copied from class: Outputs

Encode an output value into a DataOutput.

Specified by:

write in class Outputs<FSTTermOutputs.TermData>

Throws:

IOException

read

public FSTTermOutputs.TermData 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<FSTTermOutputs.TermData>

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<FSTTermOutputs.TermData>

Throws:

IOException

getNoOutput

public FSTTermOutputs.TermData 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<FSTTermOutputs.TermData>

outputToString

public String outputToString(FSTTermOutputs.TermData data)

Specified by:

outputToString in class Outputs<FSTTermOutputs.TermData>

statsEqual

static boolean statsEqual(FSTTermOutputs.TermData t1,
 FSTTermOutputs.TermData t2)

bytesEqual

static boolean bytesEqual(FSTTermOutputs.TermData t1,
 FSTTermOutputs.TermData t2)