com.bigdata.rdf.sail.webapp.client

Class RemoteRepository.QueryOrUpdate

java.lang.Object

com.bigdata.rdf.sail.webapp.client.RemoteRepository.QueryOrUpdate

All Implemented Interfaces:

IPreparedOperation, IPreparedQuery

Enclosing class:

RemoteRepository

protected abstract class RemoteRepository.QueryOrUpdate
extends Object
implements IPreparedOperation, IPreparedQuery

A prepared query will hold metadata for a particular query instance.

Right now, the only metadata is the query ID.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConnectOptions	opts
protected String	query

Constructor Summary

Constructors

Constructor and Description
RemoteRepository.QueryOrUpdate(ConnectOptions opts, UUID id, String query)
RemoteRepository.QueryOrUpdate(ConnectOptions opts, UUID uuid, String query, boolean update)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRequestParam(String name, String... val)
String	getHeader(String name) Return the value of the specified HTTP header.
long	getMaxQueryMillis() Return the maximum time in milliseconds that the query will be permitted to run.
UUID	getQueryId() Return the UUID that will be used to uniquely identify this operation (query, update, etc.).
boolean	isUpdate() Return true iff this is a SPARQL UPDATE request (versus a SPARQL query).
void	setAcceptHeader(String value) Convenience method to set the Accept header.
void	setHeader(String name, String value) Override the value of the specified HTTP header.
void	setMaxQueryMillis(long timeout) Specify the maximum time in milliseconds that the query will be permitted to run.
protected void	setupConnectOptions() Setup the connection options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

opts

protected final ConnectOptions opts

query

protected final String query

Constructor Detail

RemoteRepository.QueryOrUpdate

public RemoteRepository.QueryOrUpdate(ConnectOptions opts,
                              UUID id,
                              String query)

RemoteRepository.QueryOrUpdate

public RemoteRepository.QueryOrUpdate(ConnectOptions opts,
                              UUID uuid,
                              String query,
                              boolean update)

Parameters:

id - The query id.

query - The SPARQL query or update string.

update - true iff this is a SPARQL update.

Method Detail

getQueryId

public final UUID getQueryId()

Description copied from interface: IPreparedOperation

Return the UUID that will be used to uniquely identify this operation (query, update, etc.).

Specified by:

getQueryId in interface IPreparedOperation

isUpdate

public final boolean isUpdate()

Description copied from interface: IPreparedOperation

Return true iff this is a SPARQL UPDATE request (versus a SPARQL query).

Specified by:

isUpdate in interface IPreparedOperation

addRequestParam

public void addRequestParam(String name,
                   String... val)

Specified by:

addRequestParam in interface IPreparedQuery

setupConnectOptions

protected void setupConnectOptions()

Setup the connection options.

setAcceptHeader

public void setAcceptHeader(String value)

Description copied from interface: IPreparedOperation

Convenience method to set the Accept header.

Specified by:

setAcceptHeader in interface IPreparedOperation

Parameters:

value - The value to be used.

setHeader

public void setHeader(String name,
             String value)

Description copied from interface: IPreparedOperation

Override the value of the specified HTTP header.

Specified by:

setHeader in interface IPreparedOperation

Parameters:

name - The name of the HTTP header.

value - The value to be used.

setMaxQueryMillis

public void setMaxQueryMillis(long timeout)

Description copied from interface: IPreparedOperation

Specify the maximum time in milliseconds that the query will be permitted to run. A negative or zero value indicates an unlimited query time (which is the default).

Specified by:

setMaxQueryMillis in interface IPreparedOperation

Parameters:

timeout - The timeout in milliseconds.

See Also:

(Set timeout on remote query)

getMaxQueryMillis

public long getMaxQueryMillis()

Return the maximum time in milliseconds that the query will be permitted to run. A negative or zero value indicates an unlimited query time (which is the default).

Note: -1L is returned if the http header is not specified.

Specified by:

getMaxQueryMillis in interface IPreparedOperation

Returns:

The timeout in milliseceonds.

getHeader

public String getHeader(String name)

Description copied from interface: IPreparedOperation

Return the value of the specified HTTP header.

Specified by:

getHeader in interface IPreparedOperation

Parameters:

name - The name of the HTTP header.

Returns:

The value -or- null if the header is not defined.