Class TPFResponseImpl

java.lang.Object

se.liu.ida.hefquin.federation.access.impl.response.DataRetrievalResponseBase<Iterable<Triple>>

se.liu.ida.hefquin.federation.access.impl.response.TPFResponseImpl

All Implemented Interfaces:

DataRetrievalResponse<Iterable<Triple>>, TPFResponse, TriplesResponse

public class TPFResponseImpl
extends DataRetrievalResponseBase<Iterable<Triple>>
implements TPFResponse

Field Summary

Fields

Modifier and Type	Field	Description
protected final Integer	cardEstimate
protected final List<Triple>	metadataTriples
protected final String	nextPageURL

Fields inherited from class se.liu.ida.hefquin.federation.access.impl.response.DataRetrievalResponseBase

data, errorDescription, errorStatusCode, exception, requestStartTime, retrievalEndTime

Constructor Summary

Constructors

Constructor	Description
TPFResponseImpl(int errorStatusCode, String errorDescription, Date requestStartTime)	Constructs a response for the case that the response was an error message.
TPFResponseImpl(int errorStatusCode, String errorDescription, Date requestStartTime, Date retrievalEndTime)	Constructs a response for the case that the response was an error message.
TPFResponseImpl(Exception exception, Date requestStartTime)	Constructs a defective response for the case that an exception was thrown when producing the response.
TPFResponseImpl(Exception exception, Date requestStartTime, Date retrievalEndTime)	Constructs a defective response for the case that an exception was thrown when producing the response.
TPFResponseImpl(List<Triple> matchingTriples, List<Triple> metadataTriples, String nextPageURL, int tripleCount, Date requestStartTime)	Constructs a response with the given matching triples, metadata triples, next page URL, triple count, and request start time.
TPFResponseImpl(List<Triple> matchingTriples, List<Triple> metadataTriples, String nextPageURL, int tripleCount, Date requestStartTime, Date retrievalEndTime)	Constructs a response with the given matching triples, metadata triples, next page URL, triple count, request start time, and retrieval end time.
TPFResponseImpl(List<Triple> matchingTriples, List<Triple> metadataTriples, String nextPageURL, Date requestStartTime)	Constructs a response with the given matching triples, metadata triples, next page URL, and request start time.
TPFResponseImpl(List<Triple> matchingTriples, List<Triple> metadataTriples, String nextPageURL, Date requestStartTime, Date retrievalEndTime)	Constructs a response with the given matching triples, metadata triples, next page URL, request start time, and retrieval end time.

Method Summary

Modifier and Type	Method	Description
Integer	getCardinalityEstimate()	Returns the cardinality estimate provided as metadata in the given TPF response.
Iterable<Triple>	getMetadata()	Returns an iterator over all metadata triples contained in the given TPF response.
String	getNextPageURL()	Returns the URL via which the next page of the TPF can be requested.
Iterable<Triple>	getPayload()	While DataRetrievalResponse.getResponseData() returns an iterator over all triples contained in the given TPF response, this method here returns an iterator only over the matching triples that have been requested.
Iterable<Triple>	getResponseData()	Returns an iterator over all triples contained in the TPF response, concatenating the payload and metadata into a single iterable.
Boolean	isLastPage()	Returns true if the metadata of the given TPF response indicates that this response is the last page of matching triples.

Methods inherited from class se.liu.ida.hefquin.federation.access.impl.response.DataRetrievalResponseBase

getErrorDescription, getErrorStatusCode, getException, getRequestStartTime, getRetrievalEndTime, throwExceptionIfNoResponseData

Methods inherited from class java.lang.Object

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

Methods inherited from interface se.liu.ida.hefquin.federation.access.DataRetrievalResponse

getErrorDescription, getErrorStatusCode, getException, getRequestDuration, getRequestStartTime, getRetrievalEndTime, isDefective, isError

Methods inherited from interface se.liu.ida.hefquin.federation.access.TPFResponse

getMetadataSize, getPayloadSize, getSize

Field Details

metadataTriples

protected final List<Triple> metadataTriples

cardEstimate

protected final Integer cardEstimate

nextPageURL

protected final String nextPageURL

Constructor Details

TPFResponseImpl

public TPFResponseImpl(List<Triple> matchingTriples,
 List<Triple> metadataTriples,
 String nextPageURL,
 Date requestStartTime)

Constructs a response with the given matching triples, metadata triples, next page URL, and request start time. The retrieval end time is automatically set to the current time at the moment of construction. This constructor assumes no error occurred.

Parameters:

matchingTriples - the list of triples matching the request pattern (must not be null)

metadataTriples - the list of metadata triples (must not be null)

nextPageURL - the URL for the next page of results, or null if there is none

requestStartTime - the timestamp when the request started

TPFResponseImpl

public TPFResponseImpl(List<Triple> matchingTriples,
 List<Triple> metadataTriples,
 String nextPageURL,
 Date requestStartTime,
 Date retrievalEndTime)

Constructs a response with the given matching triples, metadata triples, next page URL, request start time, and retrieval end time. This constructor assumes no error occurred.

Parameters:

matchingTriples - the list of triples matching the request pattern (must not be null)

metadataTriples - the list of metadata triples (must not be null)

nextPageURL - the URL for the next page of results, or null if there is none

requestStartTime - the timestamp when the request started

retrievalEndTime - the time at which the retrieval of this response was completed (must not be null)

TPFResponseImpl

public TPFResponseImpl(List<Triple> matchingTriples,
 List<Triple> metadataTriples,
 String nextPageURL,
 int tripleCount,
 Date requestStartTime)

Constructs a response with the given matching triples, metadata triples, next page URL, triple count, and request start time. The retrieval end time is automatically set to the current time at the moment of construction. This constructor assumes no error occurred.

Parameters:

matchingTriples - the list of triples matching the request pattern (must not be null)

metadataTriples - the list of metadata triples (must not be null)

nextPageURL - the URL for the next page of results, or null if there is none

tripleCount - the triple count

requestStartTime - the timestamp when the request started

TPFResponseImpl

public TPFResponseImpl(List<Triple> matchingTriples,
 List<Triple> metadataTriples,
 String nextPageURL,
 int tripleCount,
 Date requestStartTime,
 Date retrievalEndTime)

Constructs a response with the given matching triples, metadata triples, next page URL, triple count, request start time, and retrieval end time. This constructor assumes no error occurred.

Parameters:

matchingTriples - the list of triples matching the request pattern (must not be null)

metadataTriples - the list of metadata triples (must not be null)

nextPageURL - the URL for the next page of results, or null if there is none

tripleCount - the triple count

requestStartTime - the timestamp when the request started

retrievalEndTime - the time at which the retrieval of this response was completed (must not be null)

TPFResponseImpl

public TPFResponseImpl(int errorStatusCode,
 String errorDescription,
 Date requestStartTime)

Constructs a response for the case that the response was an error message. The retrieval end time is automatically set to the current time at the moment of construction. *@param errorStatusCode the HTTP status code of the error message (must not be null)

Parameters:

errorDescription - a short description of the error (may be null)

requestStartTime - the time at which the request was initiated (must not be null)

TPFResponseImpl

public TPFResponseImpl(int errorStatusCode,
 String errorDescription,
 Date requestStartTime,
 Date retrievalEndTime)

Constructs a response for the case that the response was an error message. *@param errorStatusCode the HTTP status code of the error message (must not be null)

Parameters:

errorDescription - a short description of the error (may be null)

requestStartTime - the time at which the request was initiated (must not be null)

retrievalEndTime - the time at which the retrieval of this response was completed (must not be null)

TPFResponseImpl

public TPFResponseImpl(Exception exception,
 Date requestStartTime)

Constructs a defective response for the case that an exception was thrown when producing the response. The retrieval end time is automatically set to the current time at the moment of construction.

Parameters:

exception - the exception (must not be null)

requestStartTime - the time at which the request was initiated (must not be null)

TPFResponseImpl

public TPFResponseImpl(Exception exception,
 Date requestStartTime,
 Date retrievalEndTime)

Constructs a defective response for the case that an exception was thrown when producing the response.

Parameters:

exception - the exception (must not be null)

requestStartTime - the time at which the request was initiated (must not be null)

retrievalEndTime - the time at which the creation of this response resulted in an exception (must not be null)

Method Details

getMetadata

public Iterable<Triple> getMetadata()
                             throws UnsupportedOperationDueToRetrievalError

Description copied from interface: TPFResponse

Returns an iterator over all metadata triples contained in the given TPF response.

Specified by:

getMetadata in interface TPFResponse

Throws:

UnsupportedOperationDueToRetrievalError - if the response to the corresponding request was an error message (see DataRetrievalResponse.isError()) or the response is defective (see DataRetrievalResponse.isDefective()).

isLastPage

public Boolean isLastPage()
                   throws UnsupportedOperationDueToRetrievalError

Description copied from interface: TPFResponse

Returns true if the metadata of the given TPF response indicates that this response is the last page of matching triples. Returns null of there is no metadata related to paging.

Specified by:

isLastPage in interface TPFResponse

Throws:

UnsupportedOperationDueToRetrievalError - if the response to the corresponding request was an error message (see DataRetrievalResponse.isError()) or the response is defective (see DataRetrievalResponse.isDefective()).

getNextPageURL

public String getNextPageURL()
                      throws UnsupportedOperationDueToRetrievalError

Description copied from interface: TPFResponse

Returns the URL via which the next page of the TPF can be requested. Returns null of no such URL is mentioned in the metadata.

Specified by:

getNextPageURL in interface TPFResponse

Throws:

UnsupportedOperationDueToRetrievalError - if the response to the corresponding request was an error message (see DataRetrievalResponse.isError()) or the response is defective (see DataRetrievalResponse.isDefective()).

getCardinalityEstimate

public Integer getCardinalityEstimate()
                               throws UnsupportedOperationDueToRetrievalError

Description copied from interface: TPFResponse

Returns the cardinality estimate provided as metadata in the given TPF response. Returns null if there is no metadata with a cardinality estimate.

Specified by:

getCardinalityEstimate in interface TPFResponse

Throws:

UnsupportedOperationDueToRetrievalError - if the response to the corresponding request was an error message (see DataRetrievalResponse.isError()) or the response is defective (see DataRetrievalResponse.isDefective()).

getResponseData

public Iterable<Triple> getResponseData()
                                 throws UnsupportedOperationDueToRetrievalError

Returns an iterator over all triples contained in the TPF response, concatenating the payload and metadata into a single iterable.

Specified by:

getResponseData in interface DataRetrievalResponse<Iterable<Triple>>

Overrides:

getResponseData in class DataRetrievalResponseBase<Iterable<Triple>>

Throws:

UnsupportedOperationDueToRetrievalError - if the response to the corresponding request was an error message (see DataRetrievalResponse.isError()) or the response is defective (see DataRetrievalResponse.isDefective()).

getPayload

public Iterable<Triple> getPayload()
                            throws UnsupportedOperationDueToRetrievalError

Description copied from interface: TPFResponse

While DataRetrievalResponse.getResponseData() returns an iterator over all triples contained in the given TPF response, this method here returns an iterator only over the matching triples that have been requested.

Specified by:

getPayload in interface TPFResponse

Throws:

UnsupportedOperationDueToRetrievalError - if the response to the corresponding request was an error message (see DataRetrievalResponse.isError()) or the response is defective (see DataRetrievalResponse.isDefective()).