Package org.hibernate.search

Interface ProjectionConstants

All Known Subinterfaces:
FullTextQuery, FullTextQuery, HSQuery
All Known Implementing Classes:
FullTextQueryImpl, FullTextQueryImpl, HSQueryImpl
public interface ProjectionConstants
Defined projection constants.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    BOOST
    Deprecated.
    always return 1
    static final String
    DOCUMENT
    The Lucene document returned by a search.
    static final String
    DOCUMENT_ID
    Lucene Document id.
    static final String
    EXPLANATION
    Lucene Explanation object describing the score computation for the matching object/document This feature is relatively expensive, do not use unless you return a limited amount of objects (using pagination) To retrieve explanation of a single result, consider retrieving DOCUMENT_ID and using fullTextQuery.explain(int)
    static final String
    ID
    Object id property
    static final String
    OBJECT_CLASS
    Represents the Hibernate entity class returned in a search.
    static final String
    SCORE
    The legacy document's score from a search.
    static final String
    THIS
    Represents the Hibernate entity returned in a search.

  • Field Details

    • THIS

      static final String THIS
      Represents the Hibernate entity returned in a search.
      See Also:

    • DOCUMENT

      static final String DOCUMENT
      The Lucene document returned by a search.
      See Also:

    • SCORE

      static final String SCORE
      The legacy document's score from a search.
      See Also:

    • BOOST

      static final String BOOST
      Deprecated.
      always return 1
      The boost value of the Lucene document.
      See Also:

    • ID

      static final String ID
      Object id property
      See Also:

    • DOCUMENT_ID

      static final String DOCUMENT_ID
      Lucene Document id.

      Expert: Lucene document id can change overtime between 2 different IndexReader opening.

      See Also:

    • EXPLANATION

      static final String EXPLANATION
      Lucene Explanation object describing the score computation for the matching object/document This feature is relatively expensive, do not use unless you return a limited amount of objects (using pagination) To retrieve explanation of a single result, consider retrieving DOCUMENT_ID and using fullTextQuery.explain(int)
      See Also:

    • OBJECT_CLASS

      static final String OBJECT_CLASS
      Represents the Hibernate entity class returned in a search. In contrast to the other constants this constant represents an actual field value of the underlying Lucene document and hence can directly be used in queries.
      See Also: