Interface TPFResponse

All Superinterfaces:

DataRetrievalResponse<Iterable<Triple>>, TriplesResponse

All Known Implementing Classes:

TPFResponseImpl

public interface TPFResponse
extends TriplesResponse

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.
default int	getMetadataSize()	Returns the number of triples that are returned by getMetadata().
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.
default int	getPayloadSize()	Returns the number of triples that are returned by getPayload().
default int	getSize()	Returns the number of triples contained in this response, which considers both the payload and the metadata.
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 interface se.liu.ida.hefquin.federation.access.DataRetrievalResponse

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

Method Details

getSize

default int getSize()
             throws UnsupportedOperationDueToRetrievalError

Returns the number of triples contained in this response, which considers both the payload and the metadata.

Specified by:

getSize in interface TriplesResponse

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

Iterable<Triple> getPayload()
                     throws UnsupportedOperationDueToRetrievalError

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.

Throws:

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

getPayloadSize

default int getPayloadSize()
                    throws UnsupportedOperationDueToRetrievalError

Returns the number of triples that are returned by getPayload().

Throws:

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

getMetadata

Iterable<Triple> getMetadata()
                      throws UnsupportedOperationDueToRetrievalError

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

Throws:

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

getMetadataSize

default int getMetadataSize()
                     throws UnsupportedOperationDueToRetrievalError

Returns the number of triples that are returned by getMetadata().

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

Boolean isLastPage()
            throws UnsupportedOperationDueToRetrievalError

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.

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

String getNextPageURL()
               throws UnsupportedOperationDueToRetrievalError

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.

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

Integer getCardinalityEstimate()
                        throws UnsupportedOperationDueToRetrievalError

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

Throws:

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