com.facetmap
Interface FacetSpace

All Known Implementing Classes:
MutableSimpleFacetSpace, SimpleFacetSpace, SqlFacetSpace

public interface FacetSpace

A FacetSpace represents a particular faceted classification system. It contains the entire pandimensional space of all Facet structures. The Facets are normal to each other; in other words, there is one dimension in the FacetSpace for each facet added to it, and browsing motion along one dimension does not cause motion along other dimensions. This allows the user to move fluidly from one Selection to another, within the FacetSpace, much like Wonka's Great Glass Elevator.

A FacetSpace essentially just registers and provides its various Facets to the Facetmap engine, or to the consumer rendering data in a Selection.

This version of Facetmap forces a FacetSpace to have explicit dimensionality -- that is, facets are predefined, assigned and indexed. Future versions may allow implicit facet structures, or a more generic method of organizing facet structures.


Method Summary
 CompoundHeadingFacet getCompoundHeadingFacet(java.lang.String id)
          Returns the CompoundHeadingFacet with the given identifier.
 DateFacet getDateFacet(java.lang.String id)
          Returns the DateFacet with the given identifier.
 Facet getFacet(int index)
          Returns the Facet at the given index.
 Facet getFacet(java.lang.String id)
          Returns the Facet with the given identifier.
 int getFacetCount()
          Returns the number of Facets in this FacetSpace.
 java.util.List getFacets()
          Returns an immutable list of Facets in this FacetSpace.
 GeographyFacet getGeographyFacet(java.lang.String id)
          Returns the GeographyFacet with the given identifier.
 KeywordFacet getKeywordFacet(java.lang.String id)
          Returns the KeywordFacet with the given identifier.
 SpectrumFacet getSpectrumFacet(java.lang.String id)
          Returns the SpectrumFacet with the given identifier.
 TaxonomyFacet getTaxonomyFacet(java.lang.String id)
          Returns the TaxonomyFacet with the given identifier.
 java.lang.String getVersion()
          Version ID for state integrity checking.
 int indexOf(Facet f)
          Returns the index number of the dimension the Facet occupies.
 

Method Detail

getVersion

java.lang.String getVersion()
Version ID for state integrity checking. For example, implementations may want to tag Selection refs with this value, and compare it later to see if the FacetSpace has changed.


getFacetCount

int getFacetCount()
Returns the number of Facets in this FacetSpace.


getFacets

java.util.List getFacets()
Returns an immutable list of Facets in this FacetSpace. This is offered in lieu of a list of facet IDs.


getFacet

Facet getFacet(int index)
               throws java.lang.ArrayIndexOutOfBoundsException
Returns the Facet at the given index.

Throws:
java.lang.ArrayIndexOutOfBoundsException

getFacet

Facet getFacet(java.lang.String id)
               throws UnknownReferenceException
Returns the Facet with the given identifier.

Throws:
UnknownReferenceException

indexOf

int indexOf(Facet f)
Returns the index number of the dimension the Facet occupies. getFacet(indexOf(F)) should return F.


getTaxonomyFacet

TaxonomyFacet getTaxonomyFacet(java.lang.String id)
                               throws UnknownReferenceException
Returns the TaxonomyFacet with the given identifier.

Throws:
UnknownReferenceException

getSpectrumFacet

SpectrumFacet getSpectrumFacet(java.lang.String id)
                               throws UnknownReferenceException
Returns the SpectrumFacet with the given identifier.

Throws:
UnknownReferenceException

getDateFacet

DateFacet getDateFacet(java.lang.String id)
                       throws UnknownReferenceException
Returns the DateFacet with the given identifier.

Throws:
UnknownReferenceException

getGeographyFacet

GeographyFacet getGeographyFacet(java.lang.String id)
                                 throws UnknownReferenceException
Returns the GeographyFacet with the given identifier.

Throws:
UnknownReferenceException

getKeywordFacet

KeywordFacet getKeywordFacet(java.lang.String id)
                             throws UnknownReferenceException
Returns the KeywordFacet with the given identifier.

Throws:
UnknownReferenceException

getCompoundHeadingFacet

CompoundHeadingFacet getCompoundHeadingFacet(java.lang.String id)
                                             throws UnknownReferenceException
Returns the CompoundHeadingFacet with the given identifier.

Throws:
UnknownReferenceException