Interface QueryResultHandler

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void endQueryResult()
      Indicates the end of a sequence of solutions.
      void handleBoolean​(boolean value)
      Handles the specified boolean value.
      void handleLinks​(java.util.List<java.lang.String> linkUrls)
      Handles the links elements which are present in SPARQL Results JSON and SPARQL Results XML documents in the header.
      void handleSolution​(BindingSet bindingSet)
      Handles a solution.
      void startQueryResult​(java.util.List<java.lang.String> bindingNames)
      Indicates the start of a sequence of Solutions.
    • Method Detail

      • handleLinks

        void handleLinks​(java.util.List<java.lang.String> linkUrls)
                  throws QueryResultHandlerException
        Handles the links elements which are present in SPARQL Results JSON and SPARQL Results XML documents in the header.

        NOTE: If the format does not support links, it must silently ignore a call to this method.

        An accumulating handler should accumulate these links.

        Parameters:
        linkUrls - The URLs of the links to handle.
        Throws:
        QueryResultHandlerException - If there was an error handling the set of link URLs. This error is not thrown in cases where links are not supported.
        See Also:
        "link"
      • startQueryResult

        void startQueryResult​(java.util.List<java.lang.String> bindingNames)
                       throws TupleQueryResultHandlerException
        Indicates the start of a sequence of Solutions. The supplied bindingNames are an indication of the values that are in the Solutions. For example, a SPARQL query like select ?X ?Y where { ?X ?P ?Y } will have binding names X and Y.
        Parameters:
        bindingNames - An ordered set of binding names.
        Throws:
        TupleQueryResultHandlerException - If there was an error during the starting of the query result handler. This exception may be thrown if the handleBoolean(boolean) method was called before this method and the handler cannot process both boolean and tuple results simultaneously.
        java.lang.UnsupportedOperationException - If this method is not supported
        java.lang.IllegalStateException - If the handleSolution(BindingSet) or endQueryResult() methods were called before this method and the handler cannot process multiple sets of tuple results simultaneously.
      • endQueryResult

        void endQueryResult()
                     throws TupleQueryResultHandlerException
        Indicates the end of a sequence of solutions.
        Throws:
        TupleQueryResultHandlerException - If there was an error during the ending of the query result handler. This exception may be thrown if the handleBoolean(boolean) method was called before this method and the handler cannot process both boolean and tuple results simultaneously.
        java.lang.UnsupportedOperationException - If this method is not supported
        java.lang.IllegalStateException - If the endQueryResult() was previously called for this handler or startQueryResult(List) was NOT called before this method.
      • handleSolution

        void handleSolution​(BindingSet bindingSet)
                     throws TupleQueryResultHandlerException
        Handles a solution.
        Parameters:
        bindingSet - A single set of tuple results, with binding names bound to values. Each of the binding names in the solution must have previously been registered with the startQueryResult(List) method.
        Throws:
        TupleQueryResultHandlerException - If there was an error during the handling of the query solution. This exception may be thrown if the handleBoolean(boolean) method was called before this method and the handler cannot process both boolean and tuple results simultaneously.
        java.lang.UnsupportedOperationException - If this method is not supported
        java.lang.IllegalStateException - If the endQueryResult() method was called before this method or startQueryResult(List) was NOT called before this method.