Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> opensymphony >> module >> [ sitemesh overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.opensymphony.module.sitemesh
Class Factory  

java.lang.Object
  com.opensymphony.module.sitemesh.Factory

---

public abstract class Factory

extends java.lang.Object

Factory responsible for creating appropriate instances of implementations. This is specific to a web context and is obtained through getInstance(com.opensymphony.module.sitemesh.Config) 55 .

The actual Factory method used is determined by the enviroment entry sitemesh.factory. If this doesn't exist, it defaults to com.opensymphony.module.sitemesh.factory.DefaultFactory .

Version:

$Revision: 1.5 $

---

Field Summary
private static java.lang.String	SITEMESH_FACTORY           Web context lookup key

 

Constructor Summary

Factory()

 

Method Summary
abstract  DecoratorMapper	getDecoratorMapper()           Return instance of DecoratorMapper.
private static java.lang.String	getEnvEntry(java.lang.String envEntry, java.lang.String defaultValue)           Find String environment entry, or return default if not found.
static Factory	getInstance(Config config)           Entry-point for obtaining singleton instance of Factory.
abstract  PageParser	getPageParser(java.lang.String contentType)           Create a PageParser suitable for the given content-type.
abstract  boolean	isPathExcluded(java.lang.String path)           Determine whether the given path should be excluded from decoration or not.
protected static void	report(java.lang.String msg, java.lang.Exception e)           Report a problem.
abstract  boolean	shouldParsePage(java.lang.String contentType)           Determine whether a Page of given content-type should be parsed or not.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

SITEMESH_FACTORY

private static final java.lang.String SITEMESH_FACTORY

Web context lookup key

See Also:

Constant Field Values

Constructor Detail

Factory

public Factory()

Method Detail

getInstance

public static Factory getInstance(Config config)

Entry-point for obtaining singleton instance of Factory. The default factory class that will be instantiated can be overridden with the environment entry sitemesh.factory.

---

getDecoratorMapper

public abstract DecoratorMapper getDecoratorMapper()

Return instance of DecoratorMapper.

---

getPageParser

public abstract PageParser getPageParser(java.lang.String contentType)

Create a PageParser suitable for the given content-type.

For example, if the supplied parameter is text/html a parser shall be returned that can parse HTML accordingly.

Never returns null.

---

shouldParsePage

public abstract boolean shouldParsePage(java.lang.String contentType)

Determine whether a Page of given content-type should be parsed or not.

---

isPathExcluded

public abstract boolean isPathExcluded(java.lang.String path)

Determine whether the given path should be excluded from decoration or not.

---

report

protected static void report(java.lang.String msg,
                             java.lang.Exception e)

Report a problem.

---

getEnvEntry

private static java.lang.String getEnvEntry(java.lang.String envEntry,
                                            java.lang.String defaultValue)

Find String environment entry, or return default if not found.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> opensymphony >> module >> [ sitemesh overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---