Package com.stardog.stark.query

Interface Query

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static long NO_TIMEOUT
      Constant for no timeout

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default java.lang.String baseIRI()
      Return the base URI for this query
      Dataset dataset()
      Return the Dataset within the database the query should be executed against.
      Query dataset​(Dataset theDataset)
      Specify the Dataset within the database the query should be executed against.
      QueryLanguage language()
      The language the query is serialized in
      Query parameter​(java.lang.String theName, boolean theValue)
      Set the parameter to the `xsd:boolean` value
      Query parameter​(java.lang.String theName, byte theValue)
      Set the parameter to the xsd:byte value
      Query parameter​(java.lang.String theName, double theValue)
      Set the parameter to the `xsd:double` value
      Query parameter​(java.lang.String theName, float theValue)
      Set the parameter to the `xsd:float` value
      Query parameter​(java.lang.String theName, int theValue)
      Set the parameter to the `xsd:int` value
      Query parameter​(java.lang.String theName, long theValue)
      Set the parameter to the `xsd:long` value
      Query parameter​(java.lang.String theName, short theValue)
      Set the parameter to the `xsd:short` value
      Query parameter​(java.lang.String theName, Value theValue)
      Set the Value of the parameter
      Query parameter​(java.lang.String theName, java.lang.Object theObj)
      Set the parameter to the specified value.
      Query parameter​(java.lang.String theName, java.lang.String theValue)
      Set the parameter to the xsd:string value
      Query parameter​(java.lang.String theName, java.net.URI theURI)
      Set the parameter to the xsd:URI value
      Query parameter​(java.lang.String theName, java.util.Date theValue)
      Set the parameter to the xsd:date value
      Query parameter​(java.lang.String theName, java.util.GregorianCalendar theValue)
      Set the parameter to the xsd:dateTime value
      java.util.Map<java.lang.String,​Value> parameters()
      Return *a copy* of the current parameters.
      boolean reasoning()
      Return whether or not reasoning should be used when evaluating this query
      Query reasoning​(boolean theEnabled)
      Set whether or not this query should be evaluated using reasoning
      Query removeParameter​(java.lang.String theName)
      Unset the given parameter.
      java.lang.String string()
      The query string
      long timeout()
      Return the timeout of this Query *in milliseconds*.
      Query timeout​(long theTimeout, java.util.concurrent.TimeUnit theUnit)
      Set the timeout of this Query

    • Method Detail

      • reasoning

        boolean reasoning()
        Return whether or not reasoning should be used when evaluating this query
        Returns:
        `true` if enabled, `false` otherwise

      • reasoning

        @Nonnull
Query reasoning​(boolean theEnabled)
        Set whether or not this query should be evaluated using reasoning
        Parameters:
        theEnabled - `true` to use reasoning, `false` otherwise
        Returns:
        this `Query`

      • string

        @Nonnull
java.lang.String string()
        The query string
        Returns:
        the query string

      • baseIRI

        @Nonnull
default java.lang.String baseIRI()
        Return the base URI for this query
        Returns:
        the base

      • language

        @Nonnull
QueryLanguage language()
        The language the query is serialized in
        Returns:
        the query language

      • timeout

        long timeout()
        Return the timeout of this Query *in milliseconds*.
        Returns:
        the timeout (ms); `-1L` is returned when the timeout value is *not* set

      • timeout

        @Nonnull
Query timeout​(long theTimeout,
              @Nonnull
              java.util.concurrent.TimeUnit theUnit)
        Set the timeout of this Query
        Parameters:
        theTimeout - the timeout, `-1L` should be used to disable the timeout
        theUnit - the unit for the timeout value
        Returns:
        this object

      • dataset

        @Nonnull
Dataset dataset()
        Return the Dataset within the database the query should be executed against.
        Returns:
        the active graph for the query
        API Note:
        Some query languages allow the active graph, ie the dataset, to be specified _within_ the query. In those cases, it is expected that this dataset would *override* any provided in the query.

      • dataset

        @Nonnull
Query dataset​(@Nonnull
              Dataset theDataset)
        Specify the Dataset within the database the query should be executed against.
        Parameters:
        theDataset - the dataset
        Returns:
        this query
        API Note:
        Some query languages allow the active graph, ie the dataset, to be specified _within_ the query. In those cases, it is expected that this dataset would *override* any provided in the query.

      • parameter

        @Nonnull
Query parameter​(@Nonnull
                java.lang.String theName,
                @Nonnull
                Value theValue)
        Set the Value of the parameter
        Parameters:
        theName - the parameter to set
        theValue - the value of the parameter
        Returns:
        this query

      • parameter

        @Nonnull
Query parameter​(@Nonnull
                java.lang.String theName,
                int theValue)
        Set the parameter to the `xsd:int` value
        Parameters:
        theName - the parameter to set
        theValue - the value of the parameter
        Returns:
        this query

      • parameter

        @Nonnull
Query parameter​(@Nonnull
                java.lang.String theName,
                long theValue)
        Set the parameter to the `xsd:long` value
        Parameters:
        theName - the parameter to set
        theValue - the value of the parameter
        Returns:
        this query

      • parameter

        @Nonnull
Query parameter​(@Nonnull
                java.lang.String theName,
                float theValue)
        Set the parameter to the `xsd:float` value
        Parameters:
        theName - the parameter to set
        theValue - the value of the parameter
        Returns:
        this query

      • parameter

        @Nonnull
Query parameter​(@Nonnull
                java.lang.String theName,
                double theValue)
        Set the parameter to the `xsd:double` value
        Parameters:
        theName - the parameter to set
        theValue - the value of the parameter
        Returns:
        this query

      • parameter

        @Nonnull
Query parameter​(@Nonnull
                java.lang.String theName,
                short theValue)
        Set the parameter to the `xsd:short` value
        Parameters:
        theName - the parameter to set
        theValue - the value of the parameter
        Returns:
        this query

      • parameter

        @Nonnull
Query parameter​(@Nonnull
                java.lang.String theName,
                boolean theValue)
        Set the parameter to the `xsd:boolean` value
        Parameters:
        theName - the parameter to set
        theValue - the value of the parameter
        Returns:
        this query

      • parameter

        @Nonnull
Query parameter​(@Nonnull
                java.lang.String theName,
                byte theValue)
        Set the parameter to the xsd:byte value
        Parameters:
        theName - the parameter to set
        theValue - the value of the parameter
        Returns:
        this query

      • parameter

        @Nonnull
Query parameter​(@Nonnull
                java.lang.String theName,
                @Nonnull
                java.lang.String theValue)
        Set the parameter to the xsd:string value
        Parameters:
        theName - the parameter to set
        theValue - the value of the parameter
        Returns:
        this query

      • parameter

        @Nonnull
Query parameter​(@Nonnull
                java.lang.String theName,
                @Nonnull
                java.util.Date theValue)
        Set the parameter to the xsd:date value
        Parameters:
        theName - the parameter to set
        theValue - the value of the parameter
        Returns:
        this query

      • parameter

        @Nonnull
Query parameter​(@Nonnull
                java.lang.String theName,
                @Nonnull
                java.util.GregorianCalendar theValue)
        Set the parameter to the xsd:dateTime value
        Parameters:
        theName - the parameter to set
        theValue - the value of the parameter
        Returns:
        this query

      • parameter

        @Nonnull
Query parameter​(@Nonnull
                java.lang.String theName,
                @Nonnull
                java.net.URI theURI)
        Set the parameter to the xsd:URI value
        Parameters:
        theName - the parameter to set
        theURI - the value of the parameter
        Returns:
        this query

      • parameter

        @Nonnull
Query parameter​(@Nonnull
                java.lang.String theName,
                @Nonnull
                java.lang.Object theObj)
        Set the parameter to the specified value. Convenience method which will delegate to one of the other parameter(...) methods
        Parameters:
        theName - the parameter name
        theObj - the param value
        Returns:
        this query

      • removeParameter

        @Nonnull
Query removeParameter​(@Nonnull
                      java.lang.String theName)
        Unset the given parameter. If it is not set, this method does nothing.
        Parameters:
        theName - the parameter
        Returns:
        this query

      • parameters

        @Nonnull
java.util.Map<java.lang.String,​Value> parameters()
        Return *a copy* of the current parameters. Modifications to this `Map` are not reflected in the current set parameters.
        Returns:
        the parameters