FacetMapServlet

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.facetmap.servlet
Class FacetMapServlet

java.lang.Object
  HttpServlet
      com.facetmap.servlet.FacetMapServlet

Direct Known Subclasses:: SimpleFacetmapServlet

public abstract class FacetMapServlet
extends HttpServlet

You will probably have to extend this class to customize FacetMap to your own site. By default, FacetMapServlet creates a Map object that uses a SimpleResourceSpace for its resources. To populate the Map data, it creates a parser that expects to parse SimpleResource objects. If you are going to use a different type of Resource, you will have to change this behavior by overriding both the createNewMap() and populateMap() routines.

If you want to change the parser, but not the Resource type -- for example, you're parsing a binary data file -- then you just need to override the populateMap() method. This also applies if your input mechanism is not a parser at all but something else entirely.

By default, the Map is an instance of FilesystemMap. Override createNewMap() if you have a different FacetMap engine you'd like to use.

See Also:: Serialized Form

Field Summary
`protected java.lang.Exception`	`configException`
`protected java.util.Properties`	`configProps` Contains properties set in the properties file.
`protected boolean`	`configured`
`protected ServletContext`	`context`
`protected java.io.File`	`docsDir`
`protected java.net.URL`	`docsUrl`
`static java.lang.String`	`FACETMAP_ATTR`
`protected SimpleResourceSpace`	`simpleResourceSpace`
`protected TransformerPersister`	`viewPersister`
`protected java.io.File`	`workDir`

Constructor Summary
`FacetMapServlet()`

Method Summary
`static Map`	`build(java.io.BufferedReader r, Parser parser, boolean update)` Deprecated. see above
`Map`	`build(Parser parser, boolean mapIsXml)` Deprecated. only used in FilesystemMapServlet, I believe, which is slated for destruction also.
`void`	`configure()`
`com.facetmap.simple.logging.LogService`	`createLogService(ServletContext context)`
`abstract Map`	`createNewMap(ServletContext context)` Creates (by default) a parser that will parse a map containing SimpleResource-style resources.
`void`	`doInit(ServletContext c)`
`boolean`	`getBooleanParameter(java.lang.String paramName)`
`java.lang.Exception`	`getConfigurationException()`
`int`	`getIntParameter(java.lang.String paramName)`
`java.lang.String`	`getParameter(java.lang.String paramName)`
`java.util.Enumeration`	`getParameterNames()`
`java.net.URL`	`getUrlForDocs(java.lang.String path)`
`TransformerPersister`	`getViewPersister()`
`void`	`init()` Wraps the initialization process so that the servlet container can call it on startup.
`boolean`	`isConfigured()`
`static void`	`preprocess(Map map)` Does any calculation that needs to be done before the map can be browsed.
`void`	`readProps()` Populate configProps from file.
`void`	`setParameter(java.lang.String paramName, java.lang.String value)`
`void`	`writeProps(java.lang.String info)`

Methods inherited from class java.lang.Object

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

Field Detail

FACETMAP_ATTR

public static final java.lang.String FACETMAP_ATTR

See Also:: Constant Field Values

context

protected ServletContext context

configProps

protected java.util.Properties configProps

Contains properties set in the properties file.

simpleResourceSpace

protected SimpleResourceSpace simpleResourceSpace

workDir

protected java.io.File workDir

docsDir

protected java.io.File docsDir

docsUrl

protected java.net.URL docsUrl

viewPersister

protected TransformerPersister viewPersister

configured

protected boolean configured

configException

protected java.lang.Exception configException

Constructor Detail