Class DocumentAnalysisRequest

    • Constructor Detail

      • DocumentAnalysisRequest

        public DocumentAnalysisRequest()
        Constructs a new request with a default uri of "/documentanalysis".
      • DocumentAnalysisRequest

        public DocumentAnalysisRequest​(String uri)
        Constructs a new request with the given request handler uri.
        Parameters:
        uri - The of the request handler.
    • Method Detail

      • addDocument

        public DocumentAnalysisRequest addDocument​(SolrInputDocument doc)
        Adds a document to be analyzed.
        Parameters:
        doc - The document to be analyzed.
        Returns:
        This DocumentAnalysisRequest (fluent interface support).
      • setQuery

        public DocumentAnalysisRequest setQuery​(String query)
        Sets the query to be analyzed. By default the query is set to null, meaning no query analysis will be performed.
        Parameters:
        query - The query to be analyzed.
        Returns:
        This DocumentAnalysisRequest (fluent interface support).
      • setShowMatch

        public DocumentAnalysisRequest setShowMatch​(boolean showMatch)
        Sets whether index time tokens that match query time tokens should be marked as a "match". By default this is set to false. Obviously, this flag is ignored if when the query is set to null.
        Parameters:
        showMatch - Sets whether index time tokens that match query time tokens should be marked as a "match".
        Returns:
        This DocumentAnalysisRequest (fluent interface support).
      • getQuery

        public String getQuery()
        Returns the query that will be analyzed when processing the request. May return null indicating that no query time analysis is taking place.
        Returns:
        The query that will be analyzed when processing the request.
        See Also:
        setQuery(String)
      • isShowMatch

        public boolean isShowMatch()
        Returns whether index time tokens that match query time tokens will be marked as a "match".
        Returns:
        Whether index time tokens that match query time tokens will be marked as a "match".
        See Also:
        setShowMatch(boolean)