Class QueryResultView

java.lang.Object

org.eclipse.rdf4j.http.server.repository.QueryResultView

All Implemented Interfaces:

org.springframework.web.servlet.View

Direct Known Subclasses:

BooleanQueryResultView, ExplainQueryResultView, GraphQueryResultView, TupleQueryResultView

public abstract class QueryResultView
extends Object
implements org.springframework.web.servlet.View

Base class for rendering query results.

Author:

Herko ter Horst, Arjohn Kampman

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BREAKER_HANDLE_KEY
static final String	CONNECTION_KEY	Key by which the current RepositoryConnection is stored in the Model.
static final String	FACTORY_KEY	Key by which the query result writer factory is stored in the model.
static final String	FILENAME_HINT_KEY	Key by which a filename hint is stored in the model.
static final String	HEADERS_ONLY
static final String	QUERY_EXPLAIN_RESULT_KEY	Key by which the query result explanation is stored in the model.
static final String	QUERY_RESULT_KEY	Key by which the query result is stored in the model.

Fields inherited from interface org.springframework.web.servlet.View

PATH_VARIABLES, RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

Constructor Summary

Constructors

Constructor	Description
QueryResultView()

Method Summary

Modifier and Type	Method	Description
protected void	logEndOfRequest(jakarta.servlet.http.HttpServletRequest request)
final void	render(Map model, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected abstract void	renderInternal(Map model, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected void	sendServiceUnavailable(jakarta.servlet.http.HttpServletResponse response, QueryInterruptedException exception, String fallbackMessage)
protected void	setContentDisposition(Map model, jakarta.servlet.http.HttpServletResponse response, FileFormat fileFormat)
protected void	setContentType(jakarta.servlet.http.HttpServletResponse response, FileFormat fileFormat)

Methods inherited from class Object

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

Methods inherited from interface org.springframework.web.servlet.View

getContentType

Field Details

QUERY_RESULT_KEY

public static final String QUERY_RESULT_KEY

Key by which the query result is stored in the model.

See Also:

• Constant Field Values

QUERY_EXPLAIN_RESULT_KEY

public static final String QUERY_EXPLAIN_RESULT_KEY

Key by which the query result explanation is stored in the model.

See Also:

• Constant Field Values

FACTORY_KEY

public static final String FACTORY_KEY

Key by which the query result writer factory is stored in the model.

See Also:

• Constant Field Values

FILENAME_HINT_KEY

public static final String FILENAME_HINT_KEY

Key by which a filename hint is stored in the model. The filename hint may be used to present the client with a suggestion for a filename to use for storing the result.

See Also:

• Constant Field Values

CONNECTION_KEY

public static final String CONNECTION_KEY

Key by which the current RepositoryConnection is stored in the Model. If this is present, the QueryResultView will take care to close the connection after processing the query result.

See Also:

• Constant Field Values

HEADERS_ONLY

public static final String HEADERS_ONLY

See Also:

• Constant Field Values

BREAKER_HANDLE_KEY

public static final String BREAKER_HANDLE_KEY

See Also:

• Constant Field Values

Constructor Details

QueryResultView

public QueryResultView()

Method Details

render

public final void render(Map model,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                  throws IOException

Specified by:

render in interface org.springframework.web.servlet.View

Throws:

IOException

renderInternal

protected abstract void renderInternal(Map model,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                                throws IOException

Throws:

IOException

setContentType

protected void setContentType(jakarta.servlet.http.HttpServletResponse response,
 FileFormat fileFormat)
                       throws IOException

Throws:

IOException

setContentDisposition

protected void setContentDisposition(Map model,
 jakarta.servlet.http.HttpServletResponse response,
 FileFormat fileFormat)
                              throws IOException

Throws:

IOException

logEndOfRequest

protected void logEndOfRequest(jakarta.servlet.http.HttpServletRequest request)

sendServiceUnavailable

protected void sendServiceUnavailable(jakarta.servlet.http.HttpServletResponse response,
 QueryInterruptedException exception,
 String fallbackMessage)
                               throws IOException

Throws:

IOException