com.epimorphics.lda.core

Class APIResultSet

java.lang.Object

com.epimorphics.lda.core.APIResultSet

All Implemented Interfaces:

SetsMetadata

public class APIResultSet
extends Object
implements SetsMetadata

Wrapper for the results of an API query before rendering. A ResultSet is an ordered list of results and an associated RDF graph. It may also carry the query used to get the detailed information from the remote endpoint(s).

Version:

$Revision: $

Author:

Dave Reynolds

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	APIResultSet.MergedModels

Field Summary

Fields

Modifier and Type	Field and Description
protected URI	contentLocation
protected String	detailsQuery
protected boolean	enableETags
protected long	hash
protected boolean	isCompleted
protected Map<String,com.hp.hpl.jena.rdf.model.Model>	metadata Map holding named metadata options.
protected APIResultSet.MergedModels	model
protected List<com.hp.hpl.jena.rdf.model.Resource>	results
protected com.hp.hpl.jena.rdf.model.Resource	root
protected String	selectQuery
protected Date	timestamp

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	APIResultSet(com.hp.hpl.jena.graph.Graph graph, List<com.hp.hpl.jena.rdf.model.Resource> results, boolean isCompleted, boolean enableETags, String detailsQuery, Map<String,com.hp.hpl.jena.rdf.model.Model> meta, View v)
	APIResultSet(com.hp.hpl.jena.graph.Graph graph, List<com.hp.hpl.jena.rdf.model.Resource> results, boolean isCompleted, boolean enableETags, String detailsQuery, View v)
protected	APIResultSet(com.hp.hpl.jena.rdf.model.Resource root, URI contentLocation, List<com.hp.hpl.jena.rdf.model.Resource> results, boolean isCompleted, APIResultSet.MergedModels model, String detailsQuery, long hash, Date timestamp, String selectQuery, boolean enableETags, View view, Map<String,com.hp.hpl.jena.rdf.model.Model> metadata)

Method Summary

Methods

Modifier and Type	Method and Description
APIResultSet	applyEdits(ModelPrefixEditor mpe)
APIResultSet	clone() Return a new result set with this one as its initial content but where additions to this model do not affect the source
Date	createdAt()
boolean	enableETags() Answer true iff this resultset was built with etags enabled
URI	getContentLocation()
String	getDetailsQuery() Answer the query string, if available, used to get the details of the values of properties of the selected items.
APIResultSet	getFilteredSet(View v, String languages) Generate and return a new copy of the model filtered to only include statements reachable from the results via allowed properties in the given set.
long	getHash()
com.hp.hpl.jena.rdf.model.Model	getMergedModel()
com.hp.hpl.jena.shared.PrefixMapping	getModelPrefixes()
APIResultSet.MergedModels	getModels() Answer the model this result-set wraps.
List<com.hp.hpl.jena.rdf.model.Resource>	getResultList() Answer the list of item resources of this result-set.
com.hp.hpl.jena.rdf.model.Resource	getRoot() Answer the root result of this result-set.
String	getSelectQuery() Answer the query string used to select the item resources of this result-set.
View	getView()
void	includeMetadata(String[] options) Add to the main model the metadata named by the options.
boolean	isCompleted()
boolean	isEmpty() Answer true if this result set is empty, ie, either it is empty or all the items in it have no properties.
com.hp.hpl.jena.rdf.model.StmtIterator	listStatements(com.hp.hpl.jena.rdf.model.Resource S, com.hp.hpl.jena.rdf.model.Property P, com.hp.hpl.jena.rdf.model.RDFNode O) Answer s statement iterator which delivers all statements matching (S, P, O) in the merged model.
long	modelSize() Answer the size of this result-set's model.
void	setContentLocation(URI contentLocation)
void	setMetadata(String option, com.hp.hpl.jena.rdf.model.Model meta) Set the metadata section called option to the model meta.
void	setNsPrefixes(com.hp.hpl.jena.shared.PrefixMapping pm) Set the prefixes of this result-set's model.
void	setRoot(com.hp.hpl.jena.rdf.model.Resource root) Set the resource to be used as root in this result-set (returned by getRoot()).
APIResultSet	setSelectQuery(String selectQuery)
static void	setUsedPrefixes(APIResultSet.MergedModels model, com.hp.hpl.jena.shared.PrefixMapping supplied) Set prefixes for the namespaces of terms that Elda uses in its generated models.
static void	setUsedPrefixes(com.hp.hpl.jena.rdf.model.Model model, com.hp.hpl.jena.shared.PrefixMapping supplied)

Methods inherited from class java.lang.Object

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

Field Detail

root

protected com.hp.hpl.jena.rdf.model.Resource root

contentLocation

protected URI contentLocation

results

protected List<com.hp.hpl.jena.rdf.model.Resource> results

isCompleted

protected final boolean isCompleted

model

protected APIResultSet.MergedModels model

detailsQuery

protected final String detailsQuery

hash

protected long hash

timestamp

protected Date timestamp

selectQuery

protected String selectQuery

enableETags

protected boolean enableETags

metadata

protected final Map<String,com.hp.hpl.jena.rdf.model.Model> metadata

Map holding named metadata options.

Constructor Detail

APIResultSet

protected APIResultSet(com.hp.hpl.jena.rdf.model.Resource root,
            URI contentLocation,
            List<com.hp.hpl.jena.rdf.model.Resource> results,
            boolean isCompleted,
            APIResultSet.MergedModels model,
            String detailsQuery,
            long hash,
            Date timestamp,
            String selectQuery,
            boolean enableETags,
            View view,
            Map<String,com.hp.hpl.jena.rdf.model.Model> metadata)

APIResultSet

public APIResultSet(com.hp.hpl.jena.graph.Graph graph,
            List<com.hp.hpl.jena.rdf.model.Resource> results,
            boolean isCompleted,
            boolean enableETags,
            String detailsQuery,
            View v)

APIResultSet

protected APIResultSet(com.hp.hpl.jena.graph.Graph graph,
            List<com.hp.hpl.jena.rdf.model.Resource> results,
            boolean isCompleted,
            boolean enableETags,
            String detailsQuery,
            Map<String,com.hp.hpl.jena.rdf.model.Model> meta,
            View v)

Method Detail

getContentLocation

public URI getContentLocation()

setContentLocation

public void setContentLocation(URI contentLocation)

getHash

public long getHash()

setUsedPrefixes

public static void setUsedPrefixes(APIResultSet.MergedModels model,
                   com.hp.hpl.jena.shared.PrefixMapping supplied)

Set prefixes for the namespaces of terms that Elda uses in its generated models. THey may be over-ridden by the supplied mapping.

setUsedPrefixes

public static void setUsedPrefixes(com.hp.hpl.jena.rdf.model.Model model,
                   com.hp.hpl.jena.shared.PrefixMapping supplied)

getModels

public APIResultSet.MergedModels getModels()

Answer the model this result-set wraps.

getMergedModel

public com.hp.hpl.jena.rdf.model.Model getMergedModel()

modelSize

public long modelSize()

Answer the size of this result-set's model.

setNsPrefixes

public void setNsPrefixes(com.hp.hpl.jena.shared.PrefixMapping pm)

Set the prefixes of this result-set's model.

getResultList

public List<com.hp.hpl.jena.rdf.model.Resource> getResultList()

Answer the list of item resources of this result-set.

getDetailsQuery

public String getDetailsQuery()

Answer the query string, if available, used to get the details of the values of properties of the selected items.

getSelectQuery

public String getSelectQuery()

Answer the query string used to select the item resources of this result-set.

setRoot

public void setRoot(com.hp.hpl.jena.rdf.model.Resource root)

Set the resource to be used as root in this result-set (returned by getRoot()).

getRoot

public com.hp.hpl.jena.rdf.model.Resource getRoot()

Answer the root result of this result-set.

isCompleted

public boolean isCompleted()

createdAt

public Date createdAt()

getFilteredSet

public APIResultSet getFilteredSet(View v,
                          String languages)

Generate and return a new copy of the model filtered to only include statements reachable from the results via allowed properties in the given set. Will not include any root resource, need to create page information after filtering. Applies the prefix editor to the model if necessary.

Parameters:

v - the view to filter the results with

languages - acceptable language codes for literals

applyEdits

public APIResultSet applyEdits(ModelPrefixEditor mpe)

clone

public APIResultSet clone()

Return a new result set with this one as its initial content but where additions to this model do not affect the source

Overrides:

clone in class Object

listStatements

public com.hp.hpl.jena.rdf.model.StmtIterator listStatements(com.hp.hpl.jena.rdf.model.Resource S,
                                                    com.hp.hpl.jena.rdf.model.Property P,
                                                    com.hp.hpl.jena.rdf.model.RDFNode O)

Answer s statement iterator which delivers all statements matching (S, P, O) in the merged model.

setMetadata

public void setMetadata(String option,
               com.hp.hpl.jena.rdf.model.Model meta)

Set the metadata section called option to the model meta.

Specified by:

setMetadata in interface SetsMetadata

includeMetadata

public void includeMetadata(String[] options)

Add to the main model the metadata named by the options.

setSelectQuery

public APIResultSet setSelectQuery(String selectQuery)

isEmpty

public boolean isEmpty()

Answer true if this result set is empty, ie, either it is empty or all the items in it have no properties.

enableETags

public boolean enableETags()

Answer true iff this resultset was built with etags enabled

getView

public View getView()

getModelPrefixes

public com.hp.hpl.jena.shared.PrefixMapping getModelPrefixes()