Interface StreamingQueryResponse

    • Method Detail

      • getDocuments

        java.lang.Iterable<SearchDocument> getDocuments()
                                                 throws java.io.IOException
        Get the response documents.

        This method will throw an exception if documents are not yet available, or were not requested.

        Throws:
        java.io.IOException
      • getDocumentIds

        java.lang.Iterable<java.lang.String> getDocumentIds()
                                                     throws java.io.IOException
        Get the response document ids.

        This method will throw an exception if document ids are not yet available, or were not requested.

        Throws:
        java.io.IOException
      • getFacets

        java.lang.Iterable<StreamingFacetResponse> getFacets()
                                                      throws java.io.IOException
        Get the facets.

        This method will throw an exception if facets are not yet available, or were not requested.

        Throws:
        java.io.IOException
      • getQueryResponse

        QueryResponse getQueryResponse()
                                throws java.io.IOException,
                                       AttivioException
        Get the QueryResponse for the query.

        This method will throw an exception if the query response is not yet available, or if the query execution resulted in an exception.

        NOTE: this method may return null if stream was closed prematurely.

        Throws:
        java.io.IOException
        AttivioException
      • close

        void close()
            throws java.io.IOException
        Closes the streaming connection.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        java.io.IOException
      • cancel

        void cancel()
             throws java.io.IOException
        Force disconnect the client connection. Ignores thread guards on purpose.
        Throws:
        java.io.IOException