org.apache.lucene.util.fst

Class ListOfOutputs<T>

java.lang.Object

org.apache.lucene.util.fst.Outputs<java.lang.Object>

org.apache.lucene.util.fst.ListOfOutputs<T>

public final class ListOfOutputs<T>
extends Outputs<java.lang.Object>

Wraps another Outputs implementation and encodes one or more of its output values. You can use this when a single input may need to map to more than one output, maintaining order: pass the same input with a different output by calling Builder.add(IntsRef,Object) multiple times. The builder will then combine the outputs using the Outputs.merge(Object,Object) method.

The resulting FST may not be minimal when an input has more than one output, as this requires pushing all multi-output values to a final state.

NOTE: the only way to create multiple outputs is to add the same input to the FST multiple times in a row. This is how the FST maps a single input to multiple outputs (e.g. you cannot pass a List<Object> to Builder.add(org.apache.lucene.util.IntsRef, T)). If your outputs are longs, and you need at most 2, then use UpToTwoPositiveIntOutputs instead since it stores the outputs more compactly (by stealing a bit from each long value).

NOTE: this cannot wrap itself (ie you cannot make an FST with List<List<Object>> outputs using this).

Constructor Summary

Constructors

Constructor and Description
ListOfOutputs(Outputs<T> outputs)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	add(java.lang.Object prefix, java.lang.Object output) Eg add("foo", "bar") -> "foobar"
java.util.List<T>	asList(java.lang.Object output)
java.lang.Object	common(java.lang.Object output1, java.lang.Object output2) Eg common("foobar", "food") -> "foo"
java.lang.Object	getNoOutput() NOTE: this output is compared with == so you must ensure that all methods return the single object if it's really no output
java.lang.Object	merge(java.lang.Object first, java.lang.Object second)
java.lang.String	outputToString(java.lang.Object output)
long	ramBytesUsed(java.lang.Object output) Return memory usage for the provided output.
java.lang.Object	read(DataInput in) Decode an output value previously written with Outputs.write(Object, DataOutput).
java.lang.Object	readFinalOutput(DataInput in) Decode an output value previously written with Outputs.writeFinalOutput(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.
java.lang.Object	subtract(java.lang.Object object, java.lang.Object inc) Eg subtract("foobar", "foo") -> "bar"
java.lang.String	toString()
void	write(java.lang.Object output, DataOutput out) Encode an output value into a DataOutput.
void	writeFinalOutput(java.lang.Object output, DataOutput out) Encode an final node output value into a DataOutput.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListOfOutputs

public ListOfOutputs(Outputs<T> outputs)

Method Detail

common

public java.lang.Object common(java.lang.Object output1,
                               java.lang.Object output2)

Description copied from class: Outputs

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

Specified by:

common in class Outputs<java.lang.Object>

subtract

public java.lang.Object subtract(java.lang.Object object,
                                 java.lang.Object inc)

Description copied from class: Outputs

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

Specified by:

subtract in class Outputs<java.lang.Object>

add

public java.lang.Object add(java.lang.Object prefix,
                            java.lang.Object output)

Description copied from class: Outputs

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

Specified by:

add in class Outputs<java.lang.Object>

write

public void write(java.lang.Object output,
                  DataOutput out)
           throws java.io.IOException

Description copied from class: Outputs

Encode an output value into a DataOutput.

Specified by:

write in class Outputs<java.lang.Object>

Throws:

java.io.IOException

writeFinalOutput

public void writeFinalOutput(java.lang.Object output,
                             DataOutput out)
                      throws java.io.IOException

Description copied from class: Outputs

Encode an final node output value into a DataOutput. By default this just calls Outputs.write(Object, DataOutput).

Overrides:

writeFinalOutput in class Outputs<java.lang.Object>

Throws:

java.io.IOException

read

public java.lang.Object read(DataInput in)
                      throws java.io.IOException

Description copied from class: Outputs

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

Specified by:

read in class Outputs<java.lang.Object>

Throws:

java.io.IOException

skipOutput

public void skipOutput(DataInput in)
                throws java.io.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<java.lang.Object>

Throws:

java.io.IOException

readFinalOutput

public java.lang.Object readFinalOutput(DataInput in)
                                 throws java.io.IOException

Description copied from class: Outputs

Decode an output value previously written with Outputs.writeFinalOutput(Object, DataOutput). By default this just calls Outputs.read(DataInput).

Overrides:

readFinalOutput in class Outputs<java.lang.Object>

Throws:

java.io.IOException

skipFinalOutput

public void skipFinalOutput(DataInput in)
                     throws java.io.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<java.lang.Object>

Throws:

java.io.IOException

getNoOutput

public java.lang.Object 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<java.lang.Object>

outputToString

public java.lang.String outputToString(java.lang.Object output)

Specified by:

outputToString in class Outputs<java.lang.Object>

merge

public java.lang.Object merge(java.lang.Object first,
                              java.lang.Object second)

Overrides:

merge in class Outputs<java.lang.Object>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

asList

public java.util.List<T> asList(java.lang.Object output)

ramBytesUsed

public long ramBytesUsed(java.lang.Object output)

Description copied from class: Outputs

Return memory usage for the provided output.

Specified by:

ramBytesUsed in class Outputs<java.lang.Object>

See Also:

Accountable