A B C D E F G H I L M N O P R S T U V W X

A

ACCESS_ERROR - Static variable in class com.facetmap.simple.ResourceKey
 
addChildren(Node, TaxonomicHeading, Taxonomy) - Method in class com.facetmap.simple.XmlConverter
 
addFacet(Facet) - Method in interface com.facetmap.FacetSpace
Appends the given Taxonomy to this FacetSpace.
addFacet(Facet) - Method in class com.facetmap.simple.SimpleFacetSpace
 
appendHeadingInto(TaxonomicHeading, TaxonomicHeading) - Method in interface com.facetmap.Taxonomy
Inserts child as a forward Heading of parent, which also provides that parent is a backward Heading of child.
appendHeadingInto(TaxonomicHeading, TaxonomicHeading) - Method in class com.facetmap.simple.SimpleTaxonomy
Convenience method to insert a heading into a parent heading, in a position after all existing children.
autoSelectOnlyChild - Variable in class com.facetmap.simple.MapAdapter
 

B

BrowseXmlServlet - class com.facetmap.servlet.BrowseXmlServlet.
 
BrowseXmlServlet() - Constructor for class com.facetmap.servlet.BrowseXmlServlet
 
build(Parser, boolean) - Method in class com.facetmap.servlet.FacetMapServlet
Deprecated. only used in FilesystemMapServlet, I believe, which is slated for destruction also.
build(BufferedReader, Parser, boolean) - Static method in class com.facetmap.servlet.FacetMapServlet
Deprecated. see above

C

clear() - Method in class com.facetmap.simple.SimpleResourceSpace
 
com.facetmap - package com.facetmap
 
com.facetmap.servlet - package com.facetmap.servlet
 
com.facetmap.simple - package com.facetmap.simple
 
configException - Variable in class com.facetmap.servlet.FacetMapServlet
 
configProps - Variable in class com.facetmap.servlet.FacetMapServlet
Contains properties set in the properties file.
configure() - Method in class com.facetmap.servlet.FacetMapServlet
 
configured - Variable in class com.facetmap.servlet.FacetMapServlet
 
containsAnyResources() - Method in interface com.facetmap.Selection
 
containsAnyResources() - Method in class com.facetmap.simple.SelectionData
 
containsHeading(String) - Method in interface com.facetmap.Taxonomy
 
containsHeading(String) - Method in class com.facetmap.simple.SimpleTaxonomy
 
context - Variable in class com.facetmap.servlet.FacetMapServlet
 
countAllResources(Selection) - Method in interface com.facetmap.Map
Counts all Resources in a Selection, with possible savings from doing all at once.
countAllResources(Selection) - Method in class com.facetmap.simple.MapAdapter
Default simply calls Selection.getContainedResourceCount() .
countResources() - Method in class com.facetmap.simple.SimpleResourceSpace
 
create(SimpleResource) - Method in class com.facetmap.simple.SimpleResourceSpace
Merely indexes the resource, sets its ID, and returns it.
createDOMParser() - Method in class com.facetmap.simple.XmlConverter
 
createDoctypeTransformers() - Static method in class com.facetmap.simple.XmlConverter
 
createElementTransformers() - Static method in class com.facetmap.simple.XmlConverter
 
createFacet(String, String, Heading) - Method in interface com.facetmap.FacetSpace
Creates a new Facet structure suitable for adding to this FacetSpace.
createFacet(String, String, Heading) - Method in class com.facetmap.simple.SimpleFacetSpace
 
createFromXml(String, URL, File) - Static method in class com.facetmap.simple.SimpleFacetmap
 
createFromXml(InputStream, URL, File) - Static method in class com.facetmap.simple.SimpleFacetmap
 
createLogService(ServletContext) - Method in class com.facetmap.servlet.FacetMapServlet
 
createMap() - Method in class com.facetmap.simple.DelimitedTextParser
The class will call this method when it needs a Map object.
createMap(String) - Method in class com.facetmap.simple.SimpleFacetmap.SimpleXmlConverter
 
createMap(String) - Method in class com.facetmap.simple.XmlConverter
The class will call this method when it needs a Map object.
createNewMap(ServletContext) - Method in class com.facetmap.servlet.FacetMapServlet
Creates (by default) a parser that will parse a map containing SimpleResource-style resources.
createNewMap(ServletContext) - Method in class com.facetmap.simple.SimpleFacetmapServlet
 
createResource(String) - Method in class com.facetmap.simple.DelimitedResourceReader
 
createSpectrum(String, String, String, int, int) - Method in interface com.facetmap.FacetSpace
Creates a new Spectrum facet structure suitable for adding to this FacetSpace.
createSpectrum(String, String, String, int, int) - Method in class com.facetmap.simple.SimpleFacetSpace
 
createTaxonomicHeading(String, String) - Method in interface com.facetmap.Taxonomy
Creates a new Heading suitable for adding to this Taxonomy.
createTaxonomicHeading(String, String) - Method in class com.facetmap.simple.SimpleTaxonomy
 
createTaxonomy(String, String, String) - Method in interface com.facetmap.FacetSpace
Creates a new Taxonomy facet structure suitable for adding to this FacetSpace.
createTaxonomy(String, String, String) - Method in class com.facetmap.simple.SimpleFacetSpace
 

D

DOCTYPE_TRANSFORMERS - Static variable in class com.facetmap.simple.XmlConverter
 
DataException - exception com.facetmap.DataException.
Indicates a problem with data provided to the FacetMap engine.
DataException() - Constructor for class com.facetmap.DataException
 
DataException(String) - Constructor for class com.facetmap.DataException
 
DelimitedResourceReader - class com.facetmap.simple.DelimitedResourceReader.
Reads Resources from plaintext and registers them in a SimpleResourceSpace.
DelimitedResourceReader(SimpleResourceSpace, Map) - Constructor for class com.facetmap.simple.DelimitedResourceReader
 
DelimitedTaxonomyReader - class com.facetmap.simple.DelimitedTaxonomyReader.
Reads a text file that represents a facet taxonomy as follows: The first line is the name of the root heading.
DelimitedTaxonomyReader(FacetSpace) - Constructor for class com.facetmap.simple.DelimitedTaxonomyReader
 
DelimitedTextParser - class com.facetmap.simple.DelimitedTextParser.
This Parser implementation recognizes a data format that was the first format ever used to express a FacetMap map.
DelimitedTextParser() - Constructor for class com.facetmap.simple.DelimitedTextParser
 
decodeRef(String) - Method in interface com.facetmap.Selection
Sets the Headings of this Selection according to the given ref.
decodeRef(String) - Method in class com.facetmap.simple.SelectionData
Sets the Headings of this Selection according to the given ref.
defineHeading(String, int, int) - Method in interface com.facetmap.Spectrum
Explicitly define a heading within this Spectrum.
doAddToFacetSpace() - Method in interface com.facetmap.Facet
Contains any custom processing that must be done when this structure is added to a FacetSpace.
doAddToFacetSpace() - Method in class com.facetmap.simple.SimpleTaxonomy
 
doEndMap() - Method in interface com.facetmap.Map
Readies the map for use.
doEndMap() - Method in class com.facetmap.simple.MapAdapter
Empty implementation.
doGet(HttpServletRequest, HttpServletResponse) - Method in class com.facetmap.servlet.BrowseXmlServlet
 
doInit(ServletContext) - Method in class com.facetmap.servlet.FacetMapServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class com.facetmap.servlet.BrowseXmlServlet
 
doStartMap() - Method in interface com.facetmap.Map
Prepares the map.
doStartMap() - Method in class com.facetmap.simple.MapAdapter
Empty implementation.
doc - Variable in class com.facetmap.simple.XmlConverter
 
doc - Variable in class com.facetmap.simple.XmlGenerator
 
docsDir - Variable in class com.facetmap.servlet.FacetMapServlet
 
docsUrl - Variable in class com.facetmap.servlet.FacetMapServlet
 
docsUrl - Variable in class com.facetmap.simple.XmlConverter
 
document - Variable in class com.facetmap.simple.XmlCache
 
documentOf(Map) - Method in class com.facetmap.simple.XmlGenerator
 
documentOf(Selection) - Method in class com.facetmap.simple.XmlGenerator
 
documentOf(Exception) - Method in class com.facetmap.simple.XmlGenerator
 
domParser - Variable in class com.facetmap.simple.XmlCache
 
dumpError(Exception) - Static method in class com.facetmap.simple.XfmlTransformer
 

E

ELEMENT_TRANSFORMERS - Static variable in class com.facetmap.simple.XmlConverter
 
exception - Variable in class com.facetmap.InternalException
 

F

FACETMAP_ATTR - Static variable in class com.facetmap.servlet.FacetMapServlet
 
Facet - interface com.facetmap.Facet.
The high abstraction of a dimension in the FacetSpace.
FacetMapServlet - class com.facetmap.servlet.FacetMapServlet.
You will probably have to extend this class to customize FacetMap to your own site.
FacetMapServlet() - Constructor for class com.facetmap.servlet.FacetMapServlet
 
FacetSpace - interface com.facetmap.FacetSpace.
Represents the entire pandimensional space of all Facet structures.
fSpace - Variable in class com.facetmap.simple.DelimitedTextParser
 
facetCount - Variable in class com.facetmap.simple.SelectionData
 
facetHash - Variable in class com.facetmap.simple.SimpleFacetSpace
Indexes facets by name.
facetSpace - Variable in class com.facetmap.simple.SimpleFacetmap
 
facetmap - Variable in class com.facetmap.simple.SelectionData
 
facets - Variable in class com.facetmap.simple.SimpleFacetSpace
Indexes facets by number.
fillSubset(SelectionData, int) - Method in class com.facetmap.simple.SimpleFacetmap
Populates a subset (containing all subselections) for a single facet.
fillSuperset(SelectionData, int) - Method in class com.facetmap.simple.SimpleFacetmap
Populates a subset (containing all subselections) for a single facet.

G

get(String) - Method in class com.facetmap.simple.TransformerPersister
 
getAll() - Method in interface com.facetmap.ResourceSpace
Returns all resources.
getAll() - Method in class com.facetmap.simple.SimpleResourceSpace
Returns all resources, unsorted.
getAllResources(Selection) - Method in interface com.facetmap.Map
this is not useful.
getAllResources(Selection) - Method in class com.facetmap.simple.MapAdapter
 
getAllResources(Selection) - Method in class com.facetmap.simple.SimpleFacetmap
 
getAttribute(Object) - Method in interface com.facetmap.Resource
 
getAttribute(Object) - Method in class com.facetmap.simple.ResourceKey
 
getAttribute(Object) - Method in class com.facetmap.simple.SimpleResource
Recognizes keys Resource.LOCATION and Resource.TITLE, as well as the string IDs of each facet in the map.
getAutoSelectOnlyChild() - Method in interface com.facetmap.Map
Return current value of autoSelectOnlyChild.
getAutoSelectOnlyChild() - Method in class com.facetmap.simple.MapAdapter
 
getBackwardHeadings() - Method in interface com.facetmap.Heading
An empty Enumeration is returned if there are no headings to return.
getBackwardHeadings() - Method in class com.facetmap.simple.SimpleTaxHeading
 
getBackwardSelections(int) - Method in interface com.facetmap.Selection
An Enumeration of the Selections that represent "backtracking" in navigation along the given dimension of facetspace.
getBackwardSelections(int) - Method in class com.facetmap.simple.SelectionData
 
getBooleanParameter(String) - Method in class com.facetmap.servlet.FacetMapServlet
 
getById(int) - Method in interface com.facetmap.ResourceSpace
 
getById(int) - Method in class com.facetmap.simple.SimpleResourceSpace
Will return null if the passed id has no resource.
getChildCount() - Method in interface com.facetmap.TaxonomicHeading
 
getConfigurationException() - Method in class com.facetmap.servlet.FacetMapServlet
 
getContainedResourceCount() - Method in interface com.facetmap.Selection
 
getContainedResourceCount() - Method in class com.facetmap.simple.SelectionData
 
getContainedResources() - Method in interface com.facetmap.Selection
A Resource may have a Heading that is contained by a Heading in this Selection.
getContainedResources() - Method in class com.facetmap.simple.SelectionData
This selection's result set should never exceed the limit specified by resultLimit.
getDataOnlySerializer(Writer) - Static method in class com.facetmap.simple.XmlGenerator
 
getDefaultSerializer(Writer) - Static method in class com.facetmap.simple.XmlGenerator
 
getDefinedHeadingCount() - Method in interface com.facetmap.Spectrum
 
getDimensionCount() - Method in interface com.facetmap.Selection
 
getDimensionCount() - Method in class com.facetmap.simple.SelectionData
 
getDirectResources(Selection) - Method in interface com.facetmap.Map
this is not useful.
getDirectResources(Selection) - Method in class com.facetmap.simple.MapAdapter
Returns the Resources directly contained by this selection.
getDirectResources(Selection) - Method in class com.facetmap.simple.SimpleFacetmap
 
getDocsUrl() - Method in class com.facetmap.simple.XmlConverter
 
getDocument() - Method in class com.facetmap.simple.XmlCache
 
getException() - Method in class com.facetmap.InternalException
 
getFacet(int) - Method in interface com.facetmap.FacetSpace
Returns the Facet at the given index.
getFacet(String) - Method in interface com.facetmap.FacetSpace
Returns the Facet with the given identifier.
getFacet() - Method in interface com.facetmap.Heading
Structure to which this Heading belongs.
getFacet(int) - Method in class com.facetmap.simple.SimpleFacetSpace
 
getFacet(String) - Method in class com.facetmap.simple.SimpleFacetSpace
 
getFacet() - Method in class com.facetmap.simple.SimpleTaxHeading
 
getFacetCount() - Method in interface com.facetmap.FacetSpace
Returns the number of dimensions in this FacetSpace.
getFacetCount() - Method in class com.facetmap.simple.SimpleFacetSpace
 
getFacetSpace() - Method in interface com.facetmap.Map
 
getFacetSpace() - Method in class com.facetmap.simple.MapAdapter
 
getFacetSpace() - Method in class com.facetmap.simple.SimpleFacetmap
 
getForwardHeadings() - Method in interface com.facetmap.Heading
An empty Enumeration is returned if there are no headings to return.
getForwardHeadings() - Method in class com.facetmap.simple.SimpleTaxHeading
 
getForwardSelections(int) - Method in interface com.facetmap.Selection
An Enumeration of the Selections that are the possible "next steps" in navigation along the given dimension of facetspace.
getForwardSelections(int) - Method in class com.facetmap.simple.SelectionData
 
getHeading(String) - Method in interface com.facetmap.Facet
Retrieves the Heading, with the specified ID, that is contained by this Facet.
getHeading(int) - Method in interface com.facetmap.Resource
A Heading bound to this Resource.
getHeading(int) - Method in interface com.facetmap.Selection
Returns the Heading along the given dimension of facetspace.
getHeading(int, int) - Method in interface com.facetmap.Spectrum
Encapsulates a range of values in this Spectrum as a Heading.
getHeading(String) - Method in interface com.facetmap.Taxonomy
 
getHeading() - Method in class com.facetmap.simple.MapAdapter.Fbond
 
getHeading(int) - Method in class com.facetmap.simple.ResourceKey
 
getHeading(int) - Method in class com.facetmap.simple.SelectionData
Returns the Heading along the given dimension of facetspace.
getHeading(int) - Method in class com.facetmap.simple.SimpleResource
 
getHeading(String) - Method in class com.facetmap.simple.SimpleTaxonomy
 
getHeadingCount() - Method in interface com.facetmap.Resource
 
getHeadingCount() - Method in interface com.facetmap.Taxonomy
 
getHeadingCount() - Method in class com.facetmap.simple.ResourceKey
 
getHeadingCount() - Method in class com.facetmap.simple.SimpleResource
 
getHeadingCount() - Method in class com.facetmap.simple.SimpleTaxonomy
 
getId() - Method in interface com.facetmap.Facet
Unique identifier.
getId() - Method in interface com.facetmap.Heading
Unique identifier.
getId() - Method in interface com.facetmap.Resource
Unique identifier.
getId() - Method in class com.facetmap.simple.ResourceKey
 
getId() - Method in class com.facetmap.simple.SimpleResource
 
getId() - Method in class com.facetmap.simple.SimpleTaxHeading
 
getId() - Method in class com.facetmap.simple.SimpleTaxonomy
 
getInfo() - Method in interface com.facetmap.Map
Implementation-specific string for this FacetMap class.
getInfo() - Method in class com.facetmap.simple.SimpleFacetmap
Implementation-specific string for this FacetMap class.
getIntId() - Method in class com.facetmap.simple.SimpleTaxHeading
 
getIntParameter(String) - Method in class com.facetmap.servlet.FacetMapServlet
 
getLocalCopyFile(URL, File) - Method in class com.facetmap.simple.XmlCache
 
getMap() - Method in interface com.facetmap.Selection
 
getMap() - Method in class com.facetmap.simple.SelectionData
 
getMatchedResourceCount() - Method in interface com.facetmap.Selection
 
getMatchedResourceCount() - Method in class com.facetmap.simple.SelectionData
 
getMatchedResources() - Method in interface com.facetmap.Selection
If each of a Resource's Headings match this Selection's Headings, then that Resource is included in the returned array.
getMatchedResources() - Method in class com.facetmap.simple.SelectionData
 
getMaximum() - Method in interface com.facetmap.SpectrumHeading
 
getMinimum() - Method in interface com.facetmap.SpectrumHeading
 
getParameter(String) - Method in class com.facetmap.servlet.FacetMapServlet
 
getParameterNames() - Method in class com.facetmap.servlet.FacetMapServlet
 
getParentHeading() - Method in interface com.facetmap.TaxonomicHeading
 
getParentHeading() - Method in class com.facetmap.simple.SimpleTaxHeading
 
getRef() - Method in interface com.facetmap.Selection
Returns a String ID (known as a reference or "ref") that uniquely identifies this Selection.
getRef() - Method in class com.facetmap.simple.SelectionData
Returns a String ID (known as a reference or "ref") that uniquely identifies this Selection.
getRegistry() - Method in class com.facetmap.simple.TransformerPersister
Not ordinarily necessary but provided for hacking.
getResource() - Method in class com.facetmap.simple.MapAdapter.Fbond
 
getResourceCount() - Method in interface com.facetmap.ResourceSpace
 
getResourceCount() - Method in class com.facetmap.simple.SimpleResourceSpace
 
getResourceSpace() - Method in interface com.facetmap.Map
 
getResourceSpace() - Method in class com.facetmap.simple.MapAdapter
 
getResultLimit() - Method in class com.facetmap.simple.SimpleFacetmap
 
getRootHeading() - Method in interface com.facetmap.Facet
A facet structure is rooted at the heading returned by this method.
getRootHeading() - Method in class com.facetmap.simple.SimpleTaxonomy
 
getRootSelection() - Method in interface com.facetmap.Map
Produce a root Selection for the FacetSpace contained in the given facetmap.
getRootSelection() - Method in class com.facetmap.simple.MapAdapter
 
getRootSelection() - Method in class com.facetmap.simple.SimpleFacetmap
Generates the Selection with ref "" (the empty string).
getSelection(String) - Method in interface com.facetmap.Map
 
getSelection(Heading[]) - Method in interface com.facetmap.Map
 
getSelection(String) - Method in class com.facetmap.simple.MapAdapter
 
getSelection(String) - Method in class com.facetmap.simple.SimpleFacetmap
 
getSelection(Heading[]) - Method in class com.facetmap.simple.SimpleFacetmap
 
getShowEmptySelections() - Method in interface com.facetmap.Map
Return current value of showEmptySelections.
getShowEmptySelections() - Method in class com.facetmap.simple.MapAdapter
 
getSource(URL) - Method in class com.facetmap.simple.XfmlTransformer
 
getSource(File) - Method in class com.facetmap.simple.XfmlTransformer
 
getSpectrum(String) - Method in interface com.facetmap.FacetSpace
Returns the Spectrum with the given identifier.
getSpectrum(String) - Method in class com.facetmap.simple.SimpleFacetSpace
 
getStringId() - Method in class com.facetmap.simple.SimpleTaxonomy
 
getSubheadings() - Method in interface com.facetmap.TaxonomicHeading
Returns an Enumeration of TaxonomicHeading objects which are the forward Headings of this Heading -- the child nodes.
getSubheadings() - Method in class com.facetmap.simple.SimpleTaxHeading
 
getSubselectionContainingHeading(SelectionData, Heading, int) - Method in class com.facetmap.simple.SimpleFacetmap
Find the forward Selection of parentSelection that contains heading.
getSubset(int) - Method in class com.facetmap.simple.SelectionData
 
getSuperset(int) - Method in class com.facetmap.simple.SelectionData
 
getTaxonomicHeading(String) - Method in interface com.facetmap.Taxonomy
 
getTaxonomicHeading(String) - Method in class com.facetmap.simple.SimpleTaxonomy
 
getTaxonomy(String) - Method in interface com.facetmap.FacetSpace
Returns the Taxonomy with the given identifier.
getTaxonomy(String) - Method in class com.facetmap.simple.SimpleFacetSpace
 
getTaxonomy(int) - Method in class com.facetmap.simple.SimpleFacetSpace
 
getTitle() - Method in interface com.facetmap.Facet
The descriptive name of this structure, for display to users.
getTitle() - Method in interface com.facetmap.Heading
The descriptive name of this Heading, for display to users.
getTitle() - Method in interface com.facetmap.Map
A descriptive title for this FacetMap instance.
getTitle() - Method in class com.facetmap.simple.MapAdapter
 
getTitle() - Method in class com.facetmap.simple.SimpleTaxHeading
 
getTitle() - Method in class com.facetmap.simple.SimpleTaxonomy
 
getTitleTemplate() - Method in interface com.facetmap.Spectrum
 
getTransformerNames() - Method in class com.facetmap.simple.TransformerPersister
 
getUrlForDocs(String) - Method in class com.facetmap.servlet.FacetMapServlet
 
getVersion() - Method in interface com.facetmap.FacetSpace
Version ID for state integrity checking.
getVersion() - Method in class com.facetmap.simple.SimpleFacetSpace
Returns zero -- version is not supported by this implementation.
getViewPersister() - Method in class com.facetmap.servlet.FacetMapServlet
 

H

Heading - interface com.facetmap.Heading.
A possible attribute that a Resource may have; a node in a Facet structure.
headings - Variable in class com.facetmap.simple.SelectionData
 

I

ID - Static variable in class com.facetmap.simple.SimpleResource
 
INFO - Static variable in class com.facetmap.simple.SimpleFacetmap
 
InternalException - exception com.facetmap.InternalException.
Indicates a failure somewhere in the FacetMap engine or its subsystems.
InternalException() - Constructor for class com.facetmap.InternalException
 
InternalException(String) - Constructor for class com.facetmap.InternalException
 
InternalException(Exception) - Constructor for class com.facetmap.InternalException
 
id - Variable in class com.facetmap.simple.ResourceKey
 
id - Variable in class com.facetmap.simple.XmlGenerator.HeadingRef
 
index - Variable in class com.facetmap.simple.SimpleTaxonomy
 
indexOf(Facet) - Method in interface com.facetmap.FacetSpace
Returns the index number of the dimension the Facet occupies.
indexOf(Facet) - Method in class com.facetmap.simple.SimpleFacetSpace
 
init() - Method in class com.facetmap.servlet.FacetMapServlet
Wraps the initialization process so that the servlet container can call it on startup.
insertHeadingInto(TaxonomicHeading, TaxonomicHeading, int) - Method in interface com.facetmap.Taxonomy
Inserts child at the desired position among other children.
insertHeadingInto(TaxonomicHeading, TaxonomicHeading, int) - Method in class com.facetmap.simple.SimpleTaxonomy
A special subclass method that accommodates the index.
inserttaxidUrl - Variable in class com.facetmap.simple.XfmlTransformer
 
isConfigured() - Method in class com.facetmap.servlet.FacetMapServlet
 
isMasterRoot() - Method in interface com.facetmap.Selection
Returns true if each of this Selection's Headings is the Root of its Facet.
isMasterRoot() - Method in class com.facetmap.simple.SelectionData
Returns true if each of this Selection's Headings is the Root of its Facet.
isRoot() - Method in interface com.facetmap.Heading
Returns true if this Heading is the root, the starting Heading, of its Facet.
isSelected(TaxonomicHeading, SelectionData, SelectionData[]) - Method in class com.facetmap.simple.SimpleFacetmap
Determines whether the Heading is selected (either matched or contained) in the specified Selection.

L

LARGEST_MAXIMUM - Static variable in interface com.facetmap.Spectrum
 
LOCATION - Static variable in interface com.facetmap.Resource
A common attribute key to represent a path or URL for the resource.
loadRemoteDocument() - Method in class com.facetmap.simple.XmlCache
 
loadSpectrum(String, String) - Method in class com.facetmap.simple.XmlConverter
 
loadTaxonomy(String, String) - Method in class com.facetmap.simple.XmlConverter
 
localCopy - Variable in class com.facetmap.simple.XmlCache
 

M

Map - interface com.facetmap.Map.
Represents the connections from the ResourceSpace to the FacetSpace.
MapAdapter - class com.facetmap.simple.MapAdapter.
Convenience superclass; provides default implementations of many Map methods.
MapAdapter() - Constructor for class com.facetmap.simple.MapAdapter
 
MapAdapter.Fbond - class com.facetmap.simple.MapAdapter.Fbond.
 
MapAdapter.Fbond(Resource, Heading) - Constructor for class com.facetmap.simple.MapAdapter.Fbond
 
mHome - Variable in class com.facetmap.simple.DelimitedResourceReader
 
mHome - Variable in class com.facetmap.simple.XmlConverter
 
mHome - Variable in class com.facetmap.simple.XmlSimpleResourceParser
 
map(Resource, Heading) - Method in interface com.facetmap.Map
Establishes a bond between a resource and a heading.
map(Resource) - Method in interface com.facetmap.Map
Maps every Heading in a Resource, with possible savings from doing all at once.
map(Resource[]) - Method in interface com.facetmap.Map
Maps every Heading in all given Resources, with possible savings from doing all at once.
map - Variable in class com.facetmap.simple.DelimitedTextParser
 
map(Resource, Heading) - Method in class com.facetmap.simple.MapAdapter
 
map(Resource) - Method in class com.facetmap.simple.MapAdapter
Maps a resource to all its headings at once.
map(Resource[]) - Method in class com.facetmap.simple.MapAdapter
Maps headings for multiple resources.
map(Resource, Heading) - Method in class com.facetmap.simple.SimpleFacetmap
 
map(Resource[]) - Method in class com.facetmap.simple.SimpleFacetmap
 
map - Variable in class com.facetmap.simple.SimpleResourceSpace
 
map - Variable in class com.facetmap.simple.XmlGenerator
 
matchesAnyResources() - Method in interface com.facetmap.Selection
 
matchesAnyResources() - Method in class com.facetmap.simple.SelectionData
 
modelOf(Taxonomy) - Method in class com.facetmap.simple.XmlGenerator
 
modelOf(Spectrum) - Method in class com.facetmap.simple.XmlGenerator
 
modelOf(TaxonomicHeading) - Method in class com.facetmap.simple.XmlGenerator
 
modelOf(SpectrumHeading) - Method in class com.facetmap.simple.XmlGenerator
 
modelOf(Resource) - Method in class com.facetmap.simple.XmlGenerator
 
modelOf(XmlGenerator.HeadingRef) - Method in class com.facetmap.simple.XmlGenerator
 
modelOf(Selection) - Method in class com.facetmap.simple.XmlGenerator
 
modelOf(Exception) - Method in class com.facetmap.simple.XmlGenerator
 

N

NO_PREPROCESS - Static variable in class com.facetmap.simple.SimpleFacetmap
 
nameMap - Variable in class com.facetmap.simple.SimpleTaxonomy
 

O

outputDocument(Document, Writer) - Method in class com.facetmap.simple.XmlGenerator
 
outputDocumentElement(Document, Writer) - Method in class com.facetmap.simple.XmlGenerator
 
outputException(Exception, Writer) - Method in class com.facetmap.simple.XmlGenerator
 
outputMap(Map, Writer) - Method in class com.facetmap.simple.XmlGenerator
 
outputSelection(Selection, Writer) - Method in class com.facetmap.simple.XmlGenerator
 

P

Parser - interface com.facetmap.simple.Parser.
Indicates that a class can produce a Map from a given InputStream.
parse(BufferedReader) - Method in class com.facetmap.simple.DelimitedResourceReader
This method does not do its own synchronization; you should control thread issues from somewhere else, preferably by synchronizing on the underlying Map.
parse(BufferedReader) - Method in class com.facetmap.simple.DelimitedTaxonomyReader
 
parse(BufferedReader) - Method in class com.facetmap.simple.DelimitedTextParser
Creates a Map from FacetMap plaintext format.
parse(BufferedReader) - Method in interface com.facetmap.simple.Parser
 
parse(BufferedReader) - Method in class com.facetmap.simple.XmlConverter
 
parse(InputStream) - Method in class com.facetmap.simple.XmlConverter
 
parse(String) - Method in class com.facetmap.simple.XmlConverter
I think the latest xerces code can find a xml doc in a few places given a systemId.
parseMap(Element) - Method in class com.facetmap.simple.XmlConverter
 
parseRange(Element, Spectrum) - Method in class com.facetmap.simple.XmlConverter
This parser also adds the range to the spectrum (since that's required to create the range).
parseResource(Element) - Method in interface com.facetmap.simple.XmlResourceParser
 
parseResource(Element) - Method in class com.facetmap.simple.XmlSimpleResourceParser
 
parseResourceHeadings(Element, Resource) - Method in class com.facetmap.simple.XmlSimpleResourceParser
 
parseSpectrum(Element) - Method in class com.facetmap.simple.XmlConverter
 
parseSpectrum(Element, String) - Method in class com.facetmap.simple.XmlConverter
 
parseTaxonomy(BufferedReader) - Method in class com.facetmap.simple.DelimitedTextParser
 
parseTaxonomy(Element) - Method in class com.facetmap.simple.XmlConverter
 
parseTaxonomy(Element, String) - Method in class com.facetmap.simple.XmlConverter
 
preprocess() - Method in interface com.facetmap.Map
Does any calculation that needs to be done before the map can be browsed.
preprocess(Map) - Static method in class com.facetmap.servlet.FacetMapServlet
Does any calculation that needs to be done before the map can be browsed.
preprocess() - Method in class com.facetmap.simple.MapAdapter
 
preprocess() - Method in class com.facetmap.simple.SimpleFacetmap
 
processRequest(ServletRequest, Map) - Static method in class com.facetmap.servlet.ServletUtil
Returns the Selection encapsulated by the given request.

R

REF_DELIM - Static variable in class com.facetmap.simple.SelectionData
 
Resource - interface com.facetmap.Resource.
The ultimate object of desire, to put it one way.
ResourceKey - class com.facetmap.simple.ResourceKey.
This class only encapsulates an integer ID, but can be treated as a Resource so that it may seamlessly be used in FacetMap retrieval operations.
ResourceKey(int) - Constructor for class com.facetmap.simple.ResourceKey
 
ResourceSpace - interface com.facetmap.ResourceSpace.
The repository of Resource objects bound in a FacetMap.
rHome - Variable in class com.facetmap.simple.DelimitedResourceReader
 
rParser - Variable in class com.facetmap.simple.XmlConverter
 
rSpace - Variable in class com.facetmap.simple.DelimitedTextParser
 
readProps() - Method in class com.facetmap.servlet.FacetMapServlet
Populate configProps from file.
refresh(URLConnection, File) - Method in class com.facetmap.simple.XmlCache
 
refreshed - Variable in class com.facetmap.simple.XmlCache
 
registry - Variable in class com.facetmap.simple.TransformerPersister
 
resourceSpace - Variable in class com.facetmap.simple.MapAdapter
 
resources - Variable in class com.facetmap.simple.SimpleResourceSpace
 
resultCount - Variable in class com.facetmap.simple.SelectionData
 
resultLimit - Variable in class com.facetmap.simple.SelectionData
 
results - Variable in class com.facetmap.simple.SelectionData
 

S

SMALLEST_MINIMUM - Static variable in interface com.facetmap.Spectrum
The allowable extremes are set so that the number of possible values in any range is a positive number.
Selection - interface com.facetmap.Selection.
Encapsulates the available navigation options as well as the current result set of Resources.
SelectionData - class com.facetmap.simple.SelectionData.
A class intended for storage of Selection state.
SelectionData() - Constructor for class com.facetmap.simple.SelectionData
Construct a SelectionData with no state defined at all.
SelectionData(Map) - Constructor for class com.facetmap.simple.SelectionData
Create a SelectionData with default or null values.
ServletUtil - class com.facetmap.servlet.ServletUtil.
 
ServletUtil() - Constructor for class com.facetmap.servlet.ServletUtil
 
SimpleFacetSpace - class com.facetmap.simple.SimpleFacetSpace.
A Vector-based FacetSpace that only supports Taxonomy facets.
SimpleFacetSpace() - Constructor for class com.facetmap.simple.SimpleFacetSpace
Create an empty but valid SimpleFacetSpace.
SimpleFacetmap - class com.facetmap.simple.SimpleFacetmap.
 
SimpleFacetmap() - Constructor for class com.facetmap.simple.SimpleFacetmap
 
SimpleFacetmap.SimpleXmlConverter - class com.facetmap.simple.SimpleFacetmap.SimpleXmlConverter.
 
SimpleFacetmap.SimpleXmlConverter(URL, File) - Constructor for class com.facetmap.simple.SimpleFacetmap.SimpleXmlConverter
 
SimpleFacetmapServlet - class com.facetmap.simple.SimpleFacetmapServlet.
 
SimpleFacetmapServlet() - Constructor for class com.facetmap.simple.SimpleFacetmapServlet
 
SimpleResource - class com.facetmap.simple.SimpleResource.
 
SimpleResource(Map) - Constructor for class com.facetmap.simple.SimpleResource
 
SimpleResource(Map, String) - Constructor for class com.facetmap.simple.SimpleResource
 
SimpleResource(Map, String, String) - Constructor for class com.facetmap.simple.SimpleResource
 
SimpleResourceSpace - class com.facetmap.simple.SimpleResourceSpace.
An entirely RAM-based home.
SimpleResourceSpace(Map) - Constructor for class com.facetmap.simple.SimpleResourceSpace
 
SimpleTaxHeading - class com.facetmap.simple.SimpleTaxHeading.
 
SimpleTaxHeading(String) - Constructor for class com.facetmap.simple.SimpleTaxHeading
 
SimpleTaxHeading(String, String) - Constructor for class com.facetmap.simple.SimpleTaxHeading
 
SimpleTaxonomy - class com.facetmap.simple.SimpleTaxonomy.
There is a big problem with this class; namely, its Headings are stored in two different structures, neither of which is really definitive, and both of which are used.
SimpleTaxonomy(String, String, String) - Constructor for class com.facetmap.simple.SimpleTaxonomy
Construct Taxonomy with a dummy root Heading -- not recommended.
SimpleTaxonomy(String, String, SimpleTaxHeading) - Constructor for class com.facetmap.simple.SimpleTaxonomy
 
SimpleTaxonomy(String, String, SimpleTaxHeading, String) - Constructor for class com.facetmap.simple.SimpleTaxonomy
 
Spectrum - interface com.facetmap.Spectrum.
Represents a scalar Facet that doesn't necessarily have discrete Headings.
SpectrumHeading - interface com.facetmap.SpectrumHeading.
A Heading specialized for a Spectrum so it can represent a range of values.
seed(File) - Method in class com.facetmap.simple.XmlCache
 
setAttribute(Object, String) - Method in interface com.facetmap.Resource
 
setAttribute(Object, String) - Method in class com.facetmap.simple.ResourceKey
 
setAttribute(Object, String) - Method in class com.facetmap.simple.SimpleResource
 
setAutoSelectOnlyChild(boolean) - Method in interface com.facetmap.Map
If this parameter is set true, FacetMap will avoid the situation where there's only one possible next step in any dimension, by automatically selecting that next step and presenting the options from there.
setAutoSelectOnlyChild(boolean) - Method in class com.facetmap.simple.MapAdapter
 
setHeading(Heading) - Method in interface com.facetmap.Resource
Bind this Resource to the specified Heading.
setHeading(Heading) - Method in interface com.facetmap.Selection
Sets the given Heading as a Heading of this Selection.
setHeading(Heading) - Method in class com.facetmap.simple.MapAdapter.Fbond
 
setHeading(Heading) - Method in class com.facetmap.simple.ResourceKey
 
setHeading(Heading) - Method in class com.facetmap.simple.SelectionData
Sets the given Heading as a Heading of this Selection.
setHeading(Heading) - Method in class com.facetmap.simple.SimpleResource
 
setHeading(int, Heading) - Method in class com.facetmap.simple.SimpleResource
these methods may disappear
setHeadings(Heading[]) - Method in class com.facetmap.simple.SimpleResource
 
setId(int) - Method in class com.facetmap.simple.SimpleResource
this method may disappear
setParameter(String, String) - Method in class com.facetmap.servlet.FacetMapServlet
 
setResource(Resource) - Method in class com.facetmap.simple.MapAdapter.Fbond
 
setResourceSpace(ResourceSpace) - Method in class com.facetmap.simple.MapAdapter
 
setShowEmptySelections(boolean) - Method in interface com.facetmap.Map
If this parameter is set true, FacetMap may provide Selections with which no Resources can be reached.
setShowEmptySelections(boolean) - Method in class com.facetmap.simple.MapAdapter
 
setStringId(String) - Method in class com.facetmap.simple.SimpleTaxonomy
 
setTitle(String) - Method in interface com.facetmap.Facet
 
setTitle(String) - Method in interface com.facetmap.Heading
 
setTitle(String) - Method in class com.facetmap.simple.MapAdapter
 
setTitle(String) - Method in class com.facetmap.simple.SimpleTaxHeading
 
setTitle(String) - Method in class com.facetmap.simple.SimpleTaxonomy
 
setTitleTemplate(String) - Method in interface com.facetmap.Spectrum
Sets the title template for range Headings in this Spectrum.
setTransformer(XmlCache.Transformer) - Method in class com.facetmap.simple.XmlCache
 
showEmptySelections - Variable in class com.facetmap.simple.MapAdapter
 
simpleResourceSpace - Variable in class com.facetmap.servlet.FacetMapServlet
 
simpleResourceSpace - Variable in class com.facetmap.simple.XmlSimpleResourceParser
 
size() - Method in class com.facetmap.simple.SimpleTaxonomy
 
sourceURL - Variable in class com.facetmap.simple.XmlCache
 
stringId - Variable in class com.facetmap.simple.SimpleTaxonomy
 
subsets - Variable in class com.facetmap.simple.SelectionData
List of Vectors of Selections, one Collection per facet
supersets - Variable in class com.facetmap.simple.SelectionData
List of Vectors of Selections, one Collection per facet

T

TITLE - Static variable in interface com.facetmap.Resource
A common attribute key to represent a descriptive title for the resource.
TaxonomicHeading - interface com.facetmap.TaxonomicHeading.
A Heading, specialized for a Taxonomy, that may have a parent Heading and child Headings of its own.
Taxonomy - interface com.facetmap.Taxonomy.
Contains Headings arranged into a tree structure.
TransformerPersister - class com.facetmap.simple.TransformerPersister.
 
TransformerPersister(File) - Constructor for class com.facetmap.simple.TransformerPersister
 
tSpace - Variable in class com.facetmap.simple.DelimitedTaxonomyReader
 
taxCount - Variable in class com.facetmap.simple.DelimitedTaxonomyReader
 
taxCount - Variable in class com.facetmap.simple.DelimitedTextParser
 
taxid - Variable in class com.facetmap.simple.XmlGenerator.HeadingRef
 
title - Variable in class com.facetmap.simple.MapAdapter
 
title - Variable in class com.facetmap.simple.SimpleTaxonomy
 
toString() - Method in class com.facetmap.simple.SimpleResource
 
toString() - Method in class com.facetmap.simple.SimpleTaxHeading
Overrides the automatic null returned by superclass.
transform(Document) - Method in class com.facetmap.simple.XfmlTransformer
 
transform(Document) - Method in interface com.facetmap.simple.XmlCache.Transformer
 
transformer - Variable in class com.facetmap.simple.XmlCache
 

U

UnknownReferenceException - exception com.facetmap.UnknownReferenceException.
Indicates that a reference used to identify something was not recognized by the FacetMap engine.
UnknownReferenceException() - Constructor for class com.facetmap.UnknownReferenceException
 
UnknownReferenceException(String) - Constructor for class com.facetmap.UnknownReferenceException
 
uri - Variable in class com.facetmap.simple.XmlCache
 

V

version - Variable in class com.facetmap.simple.SimpleFacetSpace
 
viewPersister - Variable in class com.facetmap.servlet.FacetMapServlet
 

W

wasRefreshed() - Method in class com.facetmap.simple.XmlCache
 
workDir - Variable in class com.facetmap.servlet.FacetMapServlet
 
workDir - Variable in class com.facetmap.simple.XmlConverter
 
write(File, boolean) - Method in class com.facetmap.simple.DelimitedResourceReader
Writes the ResourceSpace to the given file.
writeProps(String) - Method in class com.facetmap.servlet.FacetMapServlet
 

X

XfmlTransformer - class com.facetmap.simple.XfmlTransformer.
 
XfmlTransformer(URL) - Constructor for class com.facetmap.simple.XfmlTransformer
 
XmlCache - class com.facetmap.simple.XmlCache.
 
XmlCache(File, XmlCache.Transformer) - Constructor for class com.facetmap.simple.XmlCache
 
XmlCache(URL, File) - Constructor for class com.facetmap.simple.XmlCache
 
XmlCache(URL, File, XmlCache.Transformer) - Constructor for class com.facetmap.simple.XmlCache
 
XmlCache.Transformer - interface com.facetmap.simple.XmlCache.Transformer.
 
XmlConverter - class com.facetmap.simple.XmlConverter.
Contains all XML communication with the engine.
XmlConverter() - Constructor for class com.facetmap.simple.XmlConverter
 
XmlConverter(URL, File) - Constructor for class com.facetmap.simple.XmlConverter
 
XmlGenerator - class com.facetmap.simple.XmlGenerator.
Contains XML output functionality.
XmlGenerator() - Constructor for class com.facetmap.simple.XmlGenerator
 
XmlGenerator.HeadingRef - class com.facetmap.simple.XmlGenerator.HeadingRef.
 
XmlGenerator.HeadingRef(String, String) - Constructor for class com.facetmap.simple.XmlGenerator.HeadingRef
 
XmlResourceParser - interface com.facetmap.simple.XmlResourceParser.
 
XmlSimpleResourceParser - class com.facetmap.simple.XmlSimpleResourceParser.
 
XmlSimpleResourceParser(SimpleResourceSpace, Map) - Constructor for class com.facetmap.simple.XmlSimpleResourceParser
 
xfml2facetmapUrl - Variable in class com.facetmap.simple.XfmlTransformer
 
xsltDir - Variable in class com.facetmap.simple.TransformerPersister
 

A B C D E F G H I L M N O P R S T U V W X