Class TPFResponseImpl

java.lang.Object

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

se.liu.ida.hefquin.engine.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.engine.federation.access.impl.response.DataRetrievalResponseBase

data, errorDescription, errorStatusCode

Constructor Summary

Constructors

Constructor	Description
TPFResponseImpl(List<Triple> matchingTriples, List<Triple> metadataTriples, String nextPageURL, int tripleCount, FederationMember fm, DataRetrievalRequest request, Date requestStartTime)	Constructs a response with the given matching triples, metadata triples, next page URL, triple count, federation member, request, and request start time.
TPFResponseImpl(List<Triple> matchingTriples, List<Triple> metadataTriples, String nextPageURL, int tripleCount, FederationMember fm, DataRetrievalRequest request, Date requestStartTime, Integer errorStatusCode, String errorDescription)	Constructs a response with the given matching triples, metadata triples, next page URL, triple count, federation member, request, request start time, and error details.
TPFResponseImpl(List<Triple> matchingTriples, List<Triple> metadataTriples, String nextPageURL, int tripleCount, FederationMember fm, DataRetrievalRequest request, Date requestStartTime, Date retrievalEndTime)	Constructs a response with the given matching triples, metadata triples, next page URL, triple count, federation member, request, request start time, and retrieval end time.
TPFResponseImpl(List<Triple> matchingTriples, List<Triple> metadataTriples, String nextPageURL, int tripleCount, FederationMember fm, DataRetrievalRequest request, Date requestStartTime, Date retrievalEndTime, Integer errorStatusCode, String errorDescription)	Constructs a response with the given matching triples, metadata triples, next page URL, triple count, federation member, request, request start time, retrieval end time, and error details.
TPFResponseImpl(List<Triple> matchingTriples, List<Triple> metadataTriples, String nextPageURL, FederationMember fm, DataRetrievalRequest request, Date requestStartTime)	Constructs a response with the given matching triples, metadata triples, next page URL, federation member, request, and request start time.
TPFResponseImpl(List<Triple> matchingTriples, List<Triple> metadataTriples, String nextPageURL, FederationMember fm, DataRetrievalRequest request, Date requestStartTime, int errorStatusCode, String errorDescription)	Constructs a response with the given matching triples, metadata triples, next page URL, federation member, request, request start time, and error details.
TPFResponseImpl(List<Triple> matchingTriples, List<Triple> metadataTriples, String nextPageURL, FederationMember fm, DataRetrievalRequest request, Date requestStartTime, Date retrievalEndTime)	Constructs a response with the given matching triples, metadata triples, next page URL, federation member, request, request start time, and retrieval end time.
TPFResponseImpl(List<Triple> matchingTriples, List<Triple> metadataTriples, String nextPageURL, FederationMember fm, DataRetrievalRequest request, Date requestStartTime, Date retrievalEndTime, Integer errorStatusCode, String errorDescription)	Constructs a response with the given matching triples, metadata triples, next page URL, federation member, request, request start time, retrieval end time, and error details.

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()	Returns an iterator over the matched triples in the TPF response.
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.engine.federation.access.impl.response.DataRetrievalResponseBase

getErrorDescription, getErrorStatusCode, getFederationMember, getRequest, getRequestStartTime, getRetrievalEndTime

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.engine.federation.access.DataRetrievalResponse

getErrorDescription, getErrorStatusCode, getFederationMember, getRequest, getRequestDuration, getRequestStartTime, getRetrievalEndTime, isError

Methods inherited from interface se.liu.ida.hefquin.engine.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,
 FederationMember fm,
 DataRetrievalRequest request,
 Date requestStartTime)

Constructs a response with the given matching triples, metadata triples, next page URL, federation member, request, 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

fm - the federation member from which the data was retrieved

request - the original data retrieval request

requestStartTime - the timestamp when the request started

TPFResponseImpl

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

Constructs a response with the given matching triples, metadata triples, next page URL, federation member, request, 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

fm - the federation member from which the data was retrieved

request - the original data retrieval request

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,
 FederationMember fm,
 DataRetrievalRequest request,
 Date requestStartTime)

Constructs a response with the given matching triples, metadata triples, next page URL, triple count, federation member, request, 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

fm - the federation member from which the data was retrieved

request - the original data retrieval request

requestStartTime - the timestamp when the request started

TPFResponseImpl

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

Constructs a response with the given matching triples, metadata triples, next page URL, triple count, federation member, request, 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

fm - the federation member from which the data was retrieved

request - the original data retrieval request

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,
 FederationMember fm,
 DataRetrievalRequest request,
 Date requestStartTime,
 int errorStatusCode,
 String errorDescription)

Constructs a response with the given matching triples, metadata triples, next page URL, federation member, request, request start time, and error details. The retrieval end time is automatically set to the current time at the moment of construction.

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

fm - the federation member from which the data was retrieved

request - the original data retrieval request

requestStartTime - the timestamp when the request started

errorStatusCode - the HTTP status code representing an error, or null if no error occurred

errorDescription - a short description of the error, or null if no error occurred

TPFResponseImpl

public TPFResponseImpl(List<Triple> matchingTriples,
 List<Triple> metadataTriples,
 String nextPageURL,
 FederationMember fm,
 DataRetrievalRequest request,
 Date requestStartTime,
 Date retrievalEndTime,
 Integer errorStatusCode,
 String errorDescription)

Constructs a response with the given matching triples, metadata triples, next page URL, federation member, request, request start time, retrieval end time, and error details.

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

fm - the federation member from which the data was retrieved

request - the original data retrieval request

requestStartTime - the timestamp when the request started

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

errorStatusCode - the HTTP status code representing an error, or null if no error occurred

errorDescription - a short description of the error, or null if no error occurred

TPFResponseImpl

public TPFResponseImpl(List<Triple> matchingTriples,
 List<Triple> metadataTriples,
 String nextPageURL,
 int tripleCount,
 FederationMember fm,
 DataRetrievalRequest request,
 Date requestStartTime,
 Integer errorStatusCode,
 String errorDescription)

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

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

fm - the federation member from which the data was retrieved

request - the original data retrieval request

requestStartTime - the timestamp when the request started

errorStatusCode - the HTTP status code representing an error, or null if no error occurred

errorDescription - a short description of the error, or null if no error occurred

TPFResponseImpl

public TPFResponseImpl(List<Triple> matchingTriples,
 List<Triple> metadataTriples,
 String nextPageURL,
 int tripleCount,
 FederationMember fm,
 DataRetrievalRequest request,
 Date requestStartTime,
 Date retrievalEndTime,
 Integer errorStatusCode,
 String errorDescription)

Constructs a response with the given matching triples, metadata triples, next page URL, triple count, federation member, request, request start time, retrieval end time, and error details.

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

fm - the federation member from which the data was retrieved

request - the original data retrieval request

requestStartTime - the timestamp when the request started

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

errorStatusCode - the HTTP status code representing an error, or null if no error occurred

errorDescription - a short description of the error, or null if no error occurred

Method Details

getMetadata

public Iterable<Triple> getMetadata()

Description copied from interface: TPFResponse

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

Specified by:

getMetadata in interface TPFResponse

isLastPage

public Boolean isLastPage()

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

getNextPageURL

public String getNextPageURL()

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

getCardinalityEstimate

public Integer getCardinalityEstimate()

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

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>>

Returns:

the data retrieved in this response

Throws:

UnsupportedOperationDueToRetrievalError

getPayload

public Iterable<Triple> getPayload()
                            throws UnsupportedOperationDueToRetrievalError

Returns an iterator over the matched triples in the TPF response.

Specified by:

getPayload in interface TPFResponse

Throws:

UnsupportedOperationDueToRetrievalError