com.epimorphics.server.webapi.facets

Class FacetResult

java.lang.Object

com.epimorphics.server.webapi.facets.FacetResult

public class FacetResult
extends Object

Represents a faceted search result. Only useful for result sets that fit in memory. The facets are generated by looking in the data for values of properties that are marked by a suitable UI marker class. Only works at model (not dataset) level.

Author:

Dave Reynolds

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PAGESIZE

Constructor Summary

Constructors

Constructor and Description
FacetResult(String query, String state, List<FacetSpec> specList, com.hp.hpl.jena.rdf.model.Model model) Create and run the search.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	facetCounts(com.hp.hpl.jena.rdf.model.Model model)
Facet	facetForVar(String varname) Locate the facet corresponding to the given variable name
List<FacetResultEntry>	getAllResults() Return all the results after the current facet filter has been applied.
List<Facet>	getFacets() Return the list facets discovered, ordered by localname of the facet property name
FacetSpec	getFacetSpec(String name) Return the facet specification with the given name
List<FacetSpec>	getFacetSpecs() Return the list of facet specifications, ordered by name
List<FacetResultEntry>	getResultsPage(int pagenum) Return the results after the current facet filter has been applied.
protected void	initFacets(com.hp.hpl.jena.rdf.model.Model model)
int	numberOfPages()
String	serialize() Serialize the state of facet selection.
String	serializeWith(String add, com.hp.hpl.jena.rdf.model.RDFNode value) Seralize the state of facet selection with the addition of the given facet value
String	serializeWithout(String omit) Seralize the state of facet selection with the omission of the named facet
void	setPageSize(int ps)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PAGESIZE

public static final int DEFAULT_PAGESIZE

See Also:

Constant Field Values

Constructor Detail

FacetResult

public FacetResult(String query,
           String state,
           List<FacetSpec> specList,
           com.hp.hpl.jena.rdf.model.Model model)

Create and run the search.

Parameters:

query - graphpattern part of the query query which will bind ?item to the desired matching resource

state - serialized facet search state

facetspec - base resource whose facet:facet values define the facets to be used

model - the model to be queried, should be suitably locked until the constructor has finished the query

Method Detail

initFacets

protected void initFacets(com.hp.hpl.jena.rdf.model.Model model)

facetCounts

protected void facetCounts(com.hp.hpl.jena.rdf.model.Model model)

getAllResults

public List<FacetResultEntry> getAllResults()

Return all the results after the current facet filter has been applied. Each entry is a map whose "item" value will be the result itself and the other values will correspond to facet variable names. There will only be one entry for each item, with the other values merged.

getResultsPage

public List<FacetResultEntry> getResultsPage(int pagenum)

Return the results after the current facet filter has been applied. Each entry is a map whose "item" value will be the result itself and the other values will correspond to facet variable names. There will only be one entry for each item, with the other values merged.

numberOfPages

public int numberOfPages()

setPageSize

public void setPageSize(int ps)

getFacetSpecs

public List<FacetSpec> getFacetSpecs()

Return the list of facet specifications, ordered by name

getFacetSpec

public FacetSpec getFacetSpec(String name)

Return the facet specification with the given name

getFacets

public List<Facet> getFacets()

Return the list facets discovered, ordered by localname of the facet property name

Returns:

serialize

public String serialize()

Serialize the state of facet selection. Fragile assumes states don't have '=' or '|' characters.

serializeWith

public String serializeWith(String add,
                   com.hp.hpl.jena.rdf.model.RDFNode value)

Seralize the state of facet selection with the addition of the given facet value

serializeWithout

public String serializeWithout(String omit)

Seralize the state of facet selection with the omission of the named facet

facetForVar

public Facet facetForVar(String varname)

Locate the facet corresponding to the given variable name