com.epimorphics.server.webapi.facets

Class FacetState

java.lang.Object

com.epimorphics.server.webapi.facets.FacetState

public class FacetState
extends Object

Represents the state of facet selection in a way that can be serialized/deserialized in a URI.

Author:

Dave Reynolds

Field Summary

Fields

Modifier and Type	Field and Description
static int	SEARCH_LENGTH_LIMIT

Constructor Summary

Constructors

Constructor and Description
FacetState(List<FacetSpec> specList)

Method Summary

Methods

Modifier and Type	Method and Description
String	expandQuery(String baseQuery) Expand the given base SPARQL query (which is assumed to bind a ?item var) with additional OPTIONALs to retrieve facet values and FILTERs to filter them.
FacetSpec	getFacetSpec(String name) Return the facet specification with the given name
List<FacetSpec>	getFacetSpecs() Return the list of facet specifications, ordered by name
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	setState(String serialize) Parse a serialize state of facet selection and apply it

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_LENGTH_LIMIT

public static final int SEARCH_LENGTH_LIMIT

See Also:

Constant Field Values

Constructor Detail

FacetState

public FacetState(List<FacetSpec> specList)

Method Detail

expandQuery

public String expandQuery(String baseQuery)

Expand the given base SPARQL query (which is assumed to bind a ?item var) with additional OPTIONALs to retrieve facet values and FILTERs to filter them.

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

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

setState

public void setState(String serialize)

Parse a serialize state of facet selection and apply it