StoredQuery (Stardog-8.0.0 API)

```
public interface StoredQuery
```
Represents a query stored in the server. Stored queries can be executed directly by using their name. Shared queries can be executed by any user. Private queries can only be executed by their creator or super users. Stored queries can be executed over the getDatabase() database} associated with the query. The special value "*" indicates a query can be executed over any database.

Since:

4.2

Version:

4.2

Author:

Evren Sirin

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALL_DATABASES` Special value indicating a stored query can be executed over all databases.
`static Pattern`	`VALID_NAME_PATTERN` Regex for validating stored query names

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`close()` After this call the query can no longer be used.
`com.google.common.collect.Multimap<IRI,Value>`	`getAnnotations()` Returns the additional annotations associated with the stored query.
`String`	`getCreator()` Returns the name of the user who stored the query.
`String`	`getDatabase()` Returns the name of the database for this query.
`String`	`getDescription()` Returns the description of the stored query.
`String`	`getName()` Returns the name of the stored query.
`String`	`getQuery()` Returns the query string.
`String`	`getSchema()` Returns the reasoning schema that will be used by this query or `null schema` if reasoning is not used.
`boolean`	`isAvailable()` true, if not closed.
`boolean`	`isReasoning()` Returns `true` if this query is going to be executed with reasoning enabled.
`boolean`	`isShared()` Returns `true` if this query is shared by all the users.
`static boolean`	`isValidName(String name)` Returns `true` if the given name is a valid stored query name.
`StoredQuery`	`withName(String name)` Creates a copy of this query with a different name.

- Field Detail
  - ALL_DATABASES
```
static final String ALL_DATABASES
```
    Special value indicating a stored query can be executed over all databases.
    
    See Also:
    
    Constant Field Values
  - VALID_NAME_PATTERN
```
static final Pattern VALID_NAME_PATTERN
```
    Regex for validating stored query names
- Method Detail
  - getName
```
String getName()
```
    Returns the name of the stored query.
    
    Returns:
    
    the name of the stored query.
  - getDescription
```
String getDescription()
```
    Returns the description of the stored query.
    
    Returns:
    
    the description of the stored query.
  - getQuery
```
String getQuery()
```
    Returns the query string.
    
    Returns:
    
    the query string
  - getCreator
```
String getCreator()
```
    Returns the name of the user who stored the query.
    
    Returns:
    
    the name of the user who stored the query.
  - getDatabase
```
String getDatabase()
```
    Returns the name of the database for this query. The special value "*" can be used to indicate a query can be executed over any database.
    
    Returns:
    
    the name of the database for this query.
  - isShared
```
boolean isShared()
```
    Returns true if this query is shared by all the users. Shared queries can be executed by any user.
    
    Returns:
    
    true if this query is shared by all the users
  - isReasoning
```
boolean isReasoning()
```
    Returns true if this query is going to be executed with reasoning enabled.
    
    Returns:
    
    true if this query is going to be executed with reasoning enabled
  - getSchema
```
String getSchema()
```
    Returns the reasoning schema that will be used by this query or null schema if reasoning is not used. If the schema is set to anything other than null then that schema wil lbe used for execution regardless of the schema specified for the connection. If the schema is set to null then schema settings of the connection will be used for execution.
    
    Returns:
    
    the name of the reasoning schema
  - getAnnotations
```
com.google.common.collect.Multimap<IRI,Value> getAnnotations()
```
    Returns the additional annotations associated with the stored query.
    
    Returns:
    
    the additional annotations associated with the stored query.
  - close
```
void close()
```
    After this call the query can no longer be used.
  - isAvailable
```
boolean isAvailable()
```
    true, if not closed.
  - withName
```
StoredQuery withName(String name)
```
    Creates a copy of this query with a different name.
    
    Parameters:
    
    name - new name
    
    Returns:
    
    a query with specified name
  - isValidName
```
static boolean isValidName(String name)
```
    Returns true if the given name is a valid stored query name.
    
    Parameters:
    
    name - query name to validate
    
    Returns:
    
    true if the given name is a valid stored query name.

Interface StoredQuery

Field Summary

Method Summary

Field Detail

ALL_DATABASES

VALID_NAME_PATTERN

Method Detail

getName

getDescription

getQuery

getCreator

getDatabase

isShared

isReasoning

getSchema

getAnnotations

close

isAvailable

withName

isValidName