Class SolrReturnFields


  • public class SolrReturnFields
    extends ReturnFields
    The default implementation of return fields parsing for Solr.
    • Method Detail

      • getFetchOptimizer

        public org.apache.solr.search.SolrDocumentFetcher.RetrieveFieldsOptimizer getFetchOptimizer​(Supplier<org.apache.solr.search.SolrDocumentFetcher.RetrieveFieldsOptimizer> supplier)
      • getLuceneFieldNames

        public Set<String> getLuceneFieldNames​(boolean ignoreWantsAll)
        Description copied from class: ReturnFields
        Set of field names with their exact names from the lucene index.
        Specified by:
        getLuceneFieldNames in class ReturnFields
        Parameters:
        ignoreWantsAll - If true, it returns any additional specified field names, in spite of also wanting all fields. Example: when fl=*,field1, returns ["field1"]. If false, the method returns null when all fields are wanted. Example: when fl=*,field1, returns null. Note that this method returns null regardless of ignoreWantsAll if all fields are requested and no explicit field names are specified.
      • getRequestedFieldNames

        public Set<String> getRequestedFieldNames()
        Description copied from class: ReturnFields
        The requested field names (includes pseudo fields)

        Specified by:
        getRequestedFieldNames in class ReturnFields
        Returns:
        Set of field names or null (all fields).
      • getExplicitlyRequestedFieldNames

        public Set<String> getExplicitlyRequestedFieldNames()
        Description copied from class: ReturnFields
        The explicitly requested field names (includes pseudo fields)

        Specified by:
        getExplicitlyRequestedFieldNames in class ReturnFields
        Returns:
        Set of explicitly requested field names or null (no explict)
      • hasPatternMatching

        public boolean hasPatternMatching()
        Description copied from class: ReturnFields
        Returns true if the fieldnames should be picked with a pattern
        Specified by:
        hasPatternMatching in class ReturnFields
      • wantsField

        public boolean wantsField​(String name)
        Description copied from class: ReturnFields
        Returns true if the specified field should be returned to the external client -- either using its own name, or via an alias. This method returns false even if the specified name is needed as an "extra" field for use by transformers.
        Specified by:
        wantsField in class ReturnFields
      • wantsAllFields

        public boolean wantsAllFields()
        Description copied from class: ReturnFields
        Returns true if all fields should be returned to the external client.
        Specified by:
        wantsAllFields in class ReturnFields
      • wantsScore

        public boolean wantsScore()
        Description copied from class: ReturnFields
        Returns true if the score should be returned.
        Specified by:
        wantsScore in class ReturnFields