Class QueryElevationComponent.Elevation

  • Enclosing class:

    protected static class QueryElevationComponent.Elevation
    extends Object
    Elevation of some documents in search results, with potential exclusion of others. Immutable.
    • Field Detail

      • elevatedIds

        public final Set<org.apache.lucene.util.BytesRef> elevatedIds
      • includeQuery

        public final includeQuery
      • excludedIds

        public final Set<org.apache.lucene.util.BytesRef> excludedIds
      • excludeQueries

        public final[] excludeQueries
    • Constructor Detail

      • Elevation

        public Elevation​(Set<org.apache.lucene.util.BytesRef> elevatedIds,
                         Set<org.apache.lucene.util.BytesRef> excludedIds,
                         String queryFieldName)
        Constructs an elevation.
        elevatedIds - The ids of the elevated documents that should appear on top of search results, in configured order; can be null.
        excludedIds - The ids of the excluded documents that should not appear in search results; can be null.
        queryFieldName - The field name to use to create query terms.
      • Elevation

        protected Elevation​(Set<org.apache.lucene.util.BytesRef> elevatedIds,
                            Set<org.apache.lucene.util.BytesRef> excludedIds,
                  [] excludeQueries)