agonism.dovetail.site
Class Site

java.lang.Object
  |
  +--agonism.dovetail.site.DovetailInstance
        |
        +--agonism.dovetail.site.Site

All Implemented Interfaces:

ILocation

public class Site

extends DovetailInstance

implements ILocation

Fields inherited from class agonism.dovetail.site.DovetailInstance

m_context

Constructor Summary

protected

Site(IRequestContext context, com.jxml.quick.QDoc doc, IFactory factory)

Method Summary

IFactory	getFactory()
Location	getLocation(java.lang.String name) Get a named location.
java.lang.String	getName() Get the name of the location.
protected java.lang.String	getPackageName()
Page	getPage(java.lang.String name) Get a named page.
protected java.lang.Object	getPageOrLocation(QGBaseIntf peer)
protected java.lang.Object	getPageOrLocation(java.lang.String peerName)
ILocation	getParent() Get the parent location of the current location.
ILocation	getParentLocation(ILocation location)
QSite	getQSite()
static Site	getSite(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.io.Writer writer) Get a site instance for a request and response.
static Site	getSite(IRequestContext context) Get a site instance for a known context.
void	handleException(java.lang.Exception x)

Methods inherited from class agonism.dovetail.site.DovetailInstance

findObject, findPageName, getContext, getName, getPage, getPeer, getSite

Methods inherited from class java.lang.Object

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

Constructor Detail

Site

protected Site(IRequestContext context,
               com.jxml.quick.QDoc doc,
               IFactory factory)

Method Detail

getSite

public static Site getSite(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response,
                           java.io.Writer writer)

Get a site instance for a request and response. If you have a generated app-specific Site subclass, you should use that class's instance method instead.

getSite

public static Site getSite(IRequestContext context)

Get a site instance for a known context. If you have a generated app-specific Site subclass, you should use that class's instance method instead.

getQSite

public QSite getQSite()

getFactory

public final IFactory getFactory()

Overrides:

getFactory in class DovetailInstance

getParent

public final ILocation getParent()

Description copied from interface: ILocation

Get the parent location of the current location.

Specified by:

getParent in interface ILocation

getName

public final java.lang.String getName()

Description copied from interface: ILocation

Get the name of the location.

Specified by:

getName in interface ILocation

handleException

public void handleException(java.lang.Exception x)

getParentLocation

public ILocation getParentLocation(ILocation location)

getPage

public Page getPage(java.lang.String name)

Get a named page. The Page is cached by name so that this method always returns the same Page. Note that this Site object is only valid within a single request.

getLocation

public Location getLocation(java.lang.String name)

Get a named location. The Location is cached by name so that this method always returns the same Location. Note that this Site object is only valid within a single request.

getPageOrLocation

protected java.lang.Object getPageOrLocation(QGBaseIntf peer)

getPageOrLocation

protected java.lang.Object getPageOrLocation(java.lang.String peerName)

getPackageName

protected java.lang.String getPackageName()