SortedVIntList (Lucene 3.6.2 API)
Keywords: org.apache.lucene.util.SortedVIntList class

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.lucene.util
Class SortedVIntList

    java.lang.Object
      org.apache.lucene.search.DocIdSet
          org.apache.lucene.util.SortedVIntList

    public class SortedVIntList

extends DocIdSet

Stores and iterate on sorted integers in compressed form in RAM.
The code for compressing the differences between ascending integers was borrowed from `IndexInput` and `IndexOutput`.

NOTE: this class assumes the stored integers are doc Ids (hence why it extends `DocIdSet`). Therefore its `iterator()` assumes `DocIdSetIterator.NO_MORE_DOCS` can be used as sentinel. If you intent to use this value, then make sure it's not used during search flow.

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

Field Summary

Fields inherited from class org.apache.lucene.search.DocIdSet
`EMPTY_DOCIDSET`

Constructor Summary
`SortedVIntList(BitSet bits)` Create a SortedVIntList from a BitSet.
`SortedVIntList(DocIdSetIterator docIdSetIterator)` Create a SortedVIntList.
`SortedVIntList(int... sortedInts)` Create a SortedVIntList from all elements of an array of integers.
`SortedVIntList(int[] sortedInts, int inputSize)` Create a SortedVIntList from an array of integers.

Method Summary
`int` | `getByteSize()`
`boolean` | `isCacheable()` This DocIdSet implementation is cacheable.
`DocIdSetIterator` | `iterator()` Provides a `DocIdSetIterator` to access the set.
`int` | `size()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### SortedVIntList

    public SortedVIntList(int... sortedInts)

  Create a SortedVIntList from all elements of an array of integers.

  Parameters:
    `sortedInts` - A sorted array of non negative integers.

### SortedVIntList

    public SortedVIntList(int[] sortedInts,
                          int inputSize)

  Create a SortedVIntList from an array of integers.

  Parameters:
    `sortedInts` - An array of sorted non negative integers.
    `inputSize` - The number of integers to be used from the array.

### SortedVIntList

    public SortedVIntList(BitSet bits)

  Create a SortedVIntList from a BitSet.

  Parameters:
    `bits` - A bit set representing a set of integers.

### SortedVIntList

    public SortedVIntList(DocIdSetIterator docIdSetIterator)
                   throws IOException

  Create a SortedVIntList.

  Parameters:
    `docIdSetIterator` - An iterator providing document numbers as a set of integers. This DocIdSetIterator is iterated completely when this constructor is called and it must provide the integers in non decreasing order.
  Throws:
    `IOException`

Method Detail

### size

    public int size()

  Returns:
    The total number of sorted integers.

### getByteSize

    public int getByteSize()

  Returns:
    The size of the byte array storing the compressed sorted integers.

### isCacheable

    public boolean isCacheable()

  This DocIdSet implementation is cacheable.

  Overrides:
    `isCacheable` in class `DocIdSet`

### iterator

    public DocIdSetIterator iterator()

  Description copied from class: `DocIdSet`
  Provides a `DocIdSetIterator` to access the set. This implementation can return `null` or `DocIdSet.EMPTY_DOCIDSET.iterator()` if there are no docs that match.

  Specified by:
    `iterator` in class `DocIdSet`
  Returns:
    An iterator over the sorted integers.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD