DirectPostingsFormat.DirectField

java.lang.Object
- org.apache.lucene.index.Terms
- - org.apache.lucene.codecs.memory.DirectPostingsFormat.DirectField

All Implemented Interfaces:: Accountable

Enclosing class:: DirectPostingsFormat

private static final class DirectPostingsFormat.DirectField
extends Terms
implements Accountable

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`DirectPostingsFormat.DirectField.DirectIntersectTermsEnum`
`private class`	`DirectPostingsFormat.DirectField.DirectTermsEnum`
`private static class`	`DirectPostingsFormat.DirectField.HighFreqTerm`
`private static class`	`DirectPostingsFormat.DirectField.IntArrayWriter`
`private static class`	`DirectPostingsFormat.DirectField.LowFreqTerm`
`private static class`	`DirectPostingsFormat.DirectField.TermAndSkip`

Field Summary

Fields
Modifier and Type	Field and Description
`private static long`	`BASE_RAM_BYTES_USED`
`private int`	`count`
`private int`	`docCount`
`private boolean`	`hasFreq`
`private boolean`	`hasOffsets`
`private boolean`	`hasPayloads`
`private boolean`	`hasPos`
`private int`	`minSkipCount`
`private int[]`	`sameCounts`
`private int`	`skipCount`
`private int[]`	`skipOffsets`
`private int[]`	`skips`
`private long`	`sumDocFreq`
`private long`	`sumTotalTermFreq`
`private byte[]`	`termBytes`
`private int[]`	`termOffsets`
`private DirectPostingsFormat.DirectField.TermAndSkip[]`	`terms`

Fields inherited from class org.apache.lucene.index.Terms
EMPTY_ARRAY

Constructor Summary

Constructors
Constructor and Description
`DirectField(SegmentReadState state, java.lang.String field, Terms termsIn, int minSkipCount, int lowFreqCutoff)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) int`	`compare(int ord, BytesRef other)`
`private void`	`finishSkips()`
`int`	`getDocCount()` Returns the number of documents that have at least one term for this field.
`long`	`getSumDocFreq()` Returns the sum of `TermsEnum.docFreq()` for all terms in this field.
`long`	`getSumTotalTermFreq()` Returns the sum of `TermsEnum.totalTermFreq()` for all terms in this field.
`boolean`	`hasFreqs()` Returns true if documents in this field store per-document term frequency (`PostingsEnum.freq()`).
`boolean`	`hasOffsets()` Returns true if documents in this field store offsets.
`boolean`	`hasPayloads()` Returns true if documents in this field store payloads.
`boolean`	`hasPositions()` Returns true if documents in this field store positions.
`TermsEnum`	`intersect(CompiledAutomaton compiled, BytesRef startTerm)` Returns a TermsEnum that iterates over all terms and documents that are accepted by the provided `CompiledAutomaton`.
`TermsEnum`	`iterator()` Returns an iterator that will step through all terms.
`long`	`ramBytesUsed()` Return the memory usage of this object in bytes.
`private void`	`saveSkip(int ord, int backCount)`
`private void`	`setSkips(int termOrd, byte[] termBytes)`
`long`	`size()` Returns the number of terms for this field, or -1 if this measure isn't stored by the codec.
`java.lang.String`	`toString()`

Methods inherited from class org.apache.lucene.index.Terms
getMax, getMin, getStats

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

Methods inherited from interface org.apache.lucene.util.Accountable
getChildResources

- Field Detail
  - BASE_RAM_BYTES_USED
```
private static final long BASE_RAM_BYTES_USED
```
  - termBytes
```
private final byte[] termBytes
```
  - termOffsets
```
private final int[] termOffsets
```
  - skips
```
private final int[] skips
```
  - skipOffsets
```
private final int[] skipOffsets
```
  - terms
```
private final DirectPostingsFormat.DirectField.TermAndSkip[] terms
```
  - hasFreq
```
private final boolean hasFreq
```
  - hasPos
```
private final boolean hasPos
```
  - hasOffsets
```
private final boolean hasOffsets
```
  - hasPayloads
```
private final boolean hasPayloads
```
  - sumTotalTermFreq
```
private final long sumTotalTermFreq
```
  - docCount
```
private final int docCount
```
  - sumDocFreq
```
private final long sumDocFreq
```
  - skipCount
```
private int skipCount
```
  - count
```
private int count
```
  - sameCounts
```
private int[] sameCounts
```
  - minSkipCount
```
private final int minSkipCount
```
- Constructor Detail
  - DirectField
```
public DirectField(SegmentReadState state,
                   java.lang.String field,
                   Terms termsIn,
                   int minSkipCount,
                   int lowFreqCutoff)
            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - ramBytesUsed
```
public long ramBytesUsed()
```
    Description copied from interface: Accountable
    
    Return the memory usage of this object in bytes. Negative values are illegal.
    
    Specified by:
    
    ramBytesUsed in interface Accountable
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - compare
```
int compare(int ord,
            BytesRef other)
```
  - setSkips
```
private void setSkips(int termOrd,
                      byte[] termBytes)
```
  - finishSkips
```
private void finishSkips()
```
  - saveSkip
```
private void saveSkip(int ord,
                      int backCount)
```
  - iterator
```
public TermsEnum iterator()
```
    Description copied from class: Terms
    
    Returns an iterator that will step through all terms. This method will not return null.
    
    Specified by:
    
    iterator in class Terms
  - intersect
```
public TermsEnum intersect(CompiledAutomaton compiled,
                           BytesRef startTerm)
```
    Description copied from class: Terms
    
    Returns a TermsEnum that iterates over all terms and documents that are accepted by the provided CompiledAutomaton. If the startTerm is provided then the returned enum will only return terms > startTerm, but you still must call next() first to get to the first term. Note that the provided startTerm must be accepted by the automaton.
    This is an expert low-level API and will only work for NORMAL compiled automata. To handle any compiled automata you should instead use CompiledAutomaton.getTermsEnum(org.apache.lucene.index.Terms) instead.
    NOTE: the returned TermsEnum cannot seek
    .
    
    Overrides:
    
    intersect in class Terms
  - size
```
public long size()
```
    Description copied from class: Terms
    
    Returns the number of terms for this field, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.
    
    Specified by:
    
    size in class Terms
  - getSumTotalTermFreq
```
public long getSumTotalTermFreq()
```
    Description copied from class: Terms
    
    Returns the sum of TermsEnum.totalTermFreq() for all terms in this field. Note that, just like other term measures, this measure does not take deleted documents into account.
    
    Specified by:
    
    getSumTotalTermFreq in class Terms
  - getSumDocFreq
```
public long getSumDocFreq()
```
    Description copied from class: Terms
    
    Returns the sum of TermsEnum.docFreq() for all terms in this field. Note that, just like other term measures, this measure does not take deleted documents into account.
    
    Specified by:
    
    getSumDocFreq in class Terms
  - getDocCount
```
public int getDocCount()
```
    Description copied from class: Terms
    
    Returns the number of documents that have at least one term for this field. Note that, just like other term measures, this measure does not take deleted documents into account.
    
    Specified by:
    
    getDocCount in class Terms
  - hasFreqs
```
public boolean hasFreqs()
```
    Description copied from class: Terms
    
    Returns true if documents in this field store per-document term frequency (PostingsEnum.freq()).
    
    Specified by:
    
    hasFreqs in class Terms
  - hasOffsets
```
public boolean hasOffsets()
```
    Description copied from class: Terms
    
    Returns true if documents in this field store offsets.
    
    Specified by:
    
    hasOffsets in class Terms
  - hasPositions
```
public boolean hasPositions()
```
    Description copied from class: Terms
    
    Returns true if documents in this field store positions.
    
    Specified by:
    
    hasPositions in class Terms
  - hasPayloads
```
public boolean hasPayloads()
```
    Description copied from class: Terms
    
    Returns true if documents in this field store payloads.
    
    Specified by:
    
    hasPayloads in class Terms

Class DirectPostingsFormat.DirectField

Nested Class Summary

Field Summary

Fields inherited from class org.apache.lucene.index.Terms

Constructor Summary

Method Summary

Methods inherited from class org.apache.lucene.index.Terms

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.lucene.util.Accountable

Field Detail

BASE_RAM_BYTES_USED

termBytes

termOffsets

skips

skipOffsets

terms

hasFreq

hasPos

hasOffsets

hasPayloads

sumTotalTermFreq

docCount

sumDocFreq

skipCount

count

sameCounts

minSkipCount

Constructor Detail

DirectField

Method Detail

ramBytesUsed

toString

compare

setSkips

finishSkips

saveSkip

iterator

intersect

size

getSumTotalTermFreq

getSumDocFreq

getDocCount

hasFreqs

hasOffsets

hasPositions

hasPayloads