com.hp.hpl.swade.portal
Interface Facet

All Superinterfaces:

java.lang.Comparable

All Known Implementing Classes:

FacetImpl, HierarchicalFacetImpl, QueryFacetImpl

public interface Facet

extends java.lang.Comparable

A Facet instance represents the definition of a facet which can be used for browsing a datasource.

Version:

$Revision: 1.3 $ on $Date: 2004/06/20 15:03:09 $

Author:

Dave Reynolds

Method Summary

void	clearCache() Clear any state cache.
java.lang.String	getDisplayName() Return the displayable name of the face.
FacetState	getEncodedState(java.lang.String encoding, DataSource datasource) Return a state object which represents a browse state over this facet as encoded in a request parameter string.
com.hp.hpl.jena.rdf.model.Property	getFacetDirectLink() Return the RDF property which links objects to the facet values.
com.hp.hpl.jena.rdf.model.Property	getFacetLink() Return the RDF property which links objects to the facet values.
FacetState	getInitialState() Return a state object which represents the initial unconstrained state of using this facet.
java.lang.String	getParameterName() Return a name that can be used to encode the state of this facet in a request parameter string.
NodeWrapper	getSpec() Return the definition resource for this facet.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Return the displayable name of the face.

getParameterName

public java.lang.String getParameterName()

Return a name that can be used to encode the state of this facet in a request parameter string.

getInitialState

public FacetState getInitialState()

Return a state object which represents the initial unconstrained state of using this facet.

getEncodedState

public FacetState getEncodedState(java.lang.String encoding,
                                  DataSource datasource)

Return a state object which represents a browse state over this facet as encoded in a request parameter string. Needs the DataSource context to disambiguate any encoded prefixes.

getFacetLink

public com.hp.hpl.jena.rdf.model.Property getFacetLink()

Return the RDF property which links objects to the facet values. The is the "closed" version which shows inherited values as well. In fact not all facets need have such a well defined linking property so this interface will generalization if this code ever grows up from "quick" hack to real code.

getFacetDirectLink

public com.hp.hpl.jena.rdf.model.Property getFacetDirectLink()

Return the RDF property which links objects to the facet values. This is the direct version which only shows asserted values.

getSpec

public NodeWrapper getSpec()

Return the definition resource for this facet.

clearCache

public void clearCache()

Clear any state cache.