Class IndexReaderContext

    • Field Summary

      Fields 
      Modifier and Type Field Description
      int docBaseInParent
      the doc base for this reader in the parent, 0 if parent is null
      boolean isTopLevel
      true if this context struct represents the top level reader within the hierarchical context
      int ordInParent
      the ord for this reader in the parent, 0 if parent is null
      CompositeReaderContext parent
      The reader context for this reader's immediate parent, or null if none
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract java.util.List<IndexReaderContext> children()
      Returns the context's children iff this context is a composite context otherwise null.
      abstract java.util.List<AtomicReaderContext> leaves()
      Returns the context's leaves if this context is a top-level context.
      abstract IndexReader reader()
      Returns the IndexReader, this context represents.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • parent

        public final CompositeReaderContext parent
        The reader context for this reader's immediate parent, or null if none
      • isTopLevel

        public final boolean isTopLevel
        true if this context struct represents the top level reader within the hierarchical context
      • docBaseInParent

        public final int docBaseInParent
        the doc base for this reader in the parent, 0 if parent is null
      • ordInParent

        public final int ordInParent
        the ord for this reader in the parent, 0 if parent is null
    • Method Detail

      • leaves

        public abstract java.util.List<AtomicReaderContext> leaves()
                                                            throws java.lang.UnsupportedOperationException
        Returns the context's leaves if this context is a top-level context. For convenience, if this is an AtomicReaderContext this returns itself as the only leaf.

        Note: this is convenience method since leaves can always be obtained by walking the context tree using children().

        Throws:
        java.lang.UnsupportedOperationException - if this is not a top-level context.
        See Also:
        children()
      • children

        public abstract java.util.List<IndexReaderContext> children()
        Returns the context's children iff this context is a composite context otherwise null.