org.apache.lucene.util.fst
Class PositiveIntOutputs

java.lang.Object
  extended by org.apache.lucene.util.fst.Outputs<Long>
      extended by org.apache.lucene.util.fst.PositiveIntOutputs

public final class PositiveIntOutputs
extends Outputs<Long>

Output is a long, for each input term. NOTE: the resulting FST is not guaranteed to be minimal! See Builder. You cannot store 0 output with this (that's reserved to mean "no output")!

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

Method Summary
 Long add(Long prefix, Long output)
          Eg add("foo", "bar") -> "foobar"
 Long common(Long output1, Long output2)
          Eg common("foo", "foobar") -> "foo"
 Long get(long v)
           
 Long getNoOutput()
          NOTE: this output is compared with == so you must ensure that all methods return the single object if it's really no output
static PositiveIntOutputs getSingleton(boolean doShare)
           
 String outputToString(Long output)
           
 Long read(DataInput in)
           
 Long subtract(Long output, Long inc)
          Eg subtract("foobar", "foo") -> "bar"
 void write(Long output, DataOutput out)
           
 
Methods inherited from class org.apache.lucene.util.fst.Outputs
merge
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getSingleton

public static PositiveIntOutputs getSingleton(boolean doShare)

get

public Long get(long v)

common

public Long common(Long output1,
                   Long output2)
Description copied from class: Outputs
Eg common("foo", "foobar") -> "foo"

Specified by:
common in class Outputs<Long>

subtract

public Long subtract(Long output,
                     Long inc)
Description copied from class: Outputs
Eg subtract("foobar", "foo") -> "bar"

Specified by:
subtract in class Outputs<Long>

add

public Long add(Long prefix,
                Long output)
Description copied from class: Outputs
Eg add("foo", "bar") -> "foobar"

Specified by:
add in class Outputs<Long>

write

public void write(Long output,
                  DataOutput out)
           throws IOException
Specified by:
write in class Outputs<Long>
Throws:
IOException

read

public Long read(DataInput in)
          throws IOException
Specified by:
read in class Outputs<Long>
Throws:
IOException

getNoOutput

public Long 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<Long>

outputToString

public String outputToString(Long output)
Specified by:
outputToString in class Outputs<Long>


Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.