Class CodecReader

    • Constructor Detail

      • CodecReader

        protected CodecReader()
        Sole constructor. (For invocation by subclass constructors, typically implicit.)
    • Method Detail

      • getFieldsReader

        public abstract StoredFieldsReader getFieldsReader()
        Expert: retrieve thread-private StoredFieldsReader
      • getTermVectorsReader

        public abstract TermVectorsReader getTermVectorsReader()
        Expert: retrieve thread-private TermVectorsReader
      • getNormsReader

        public abstract NormsProducer getNormsReader()
        Expert: retrieve underlying NormsProducer
      • getDocValuesReader

        public abstract DocValuesProducer getDocValuesReader()
        Expert: retrieve underlying DocValuesProducer
      • getPostingsReader

        public abstract FieldsProducer getPostingsReader()
        Expert: retrieve underlying FieldsProducer
      • getPointsReader

        public abstract PointsReader getPointsReader()
        Expert: retrieve underlying PointsReader
      • getTermVectors

        public final Fields getTermVectors​(int docID)
                                    throws java.io.IOException
        Description copied from class: IndexReader
        Retrieve term vectors for this document, or null if term vectors were not indexed. The returned Fields instance acts like a single-document inverted index (the docID will be 0).
        Specified by:
        getTermVectors in class IndexReader
        Throws:
        java.io.IOException
      • checkBounds

        private void checkBounds​(int docID)
      • terms

        public final Terms terms​(java.lang.String field)
                          throws java.io.IOException
        Description copied from class: LeafReader
        Returns the Terms index for this field, or null if it has none.
        Specified by:
        terms in class LeafReader
        Throws:
        java.io.IOException
      • getNumericDocValues

        public final NumericDocValues getNumericDocValues​(java.lang.String field)
                                                   throws java.io.IOException
        Description copied from class: LeafReader
        Returns NumericDocValues for this field, or null if no numeric doc values were indexed for this field. The returned instance should only be used by a single thread.
        Specified by:
        getNumericDocValues in class LeafReader
        Throws:
        java.io.IOException
      • getBinaryDocValues

        public final BinaryDocValues getBinaryDocValues​(java.lang.String field)
                                                 throws java.io.IOException
        Description copied from class: LeafReader
        Returns BinaryDocValues for this field, or null if no binary doc values were indexed for this field. The returned instance should only be used by a single thread.
        Specified by:
        getBinaryDocValues in class LeafReader
        Throws:
        java.io.IOException
      • getPointValues

        public final PointValues getPointValues​(java.lang.String field)
                                         throws java.io.IOException
        Description copied from class: LeafReader
        Returns the PointValues used for numeric or spatial searches for the given field, or null if there are no point fields.
        Specified by:
        getPointValues in class LeafReader
        Throws:
        java.io.IOException
      • doClose

        protected void doClose()
                        throws java.io.IOException
        Description copied from class: IndexReader
        Implements close.
        Specified by:
        doClose in class IndexReader
        Throws:
        java.io.IOException
      • 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
      • getChildResources

        public java.util.Collection<Accountable> getChildResources()
        Description copied from interface: Accountable
        Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).
        Specified by:
        getChildResources in interface Accountable
        See Also:
        Accountables
      • checkIntegrity

        public void checkIntegrity()
                            throws java.io.IOException
        Description copied from class: LeafReader
        Checks consistency of this reader.

        Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.

        Specified by:
        checkIntegrity in class LeafReader
        Throws:
        java.io.IOException