Package com.opensymphony.module.sitemesh.mapper

Class RobotDecoratorMapper

java.lang.Object

com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

com.opensymphony.module.sitemesh.mapper.RobotDecoratorMapper

All Implemented Interfaces:

DecoratorMapper

public class RobotDecoratorMapper
extends AbstractDecoratorMapper

The RobotDecoratorMapper will use the specified decorator when the requester is identified as a robot (also known as spider, crawler, ferret) of a search engine.

The name of this decorator should be supplied in the decorator property.

Author:

Mathias Bogaert

See Also:

• DecoratorMapper

Field Summary

Fields inherited from class com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

config, parent

Constructor Summary

Constructors

Constructor	Description
RobotDecoratorMapper()

Method Summary

Modifier and Type	Method	Description
Decorator	getDecorator(javax.servlet.http.HttpServletRequest request, Page page)	Return appropriate Decorator for a certain Page.
void	init(Config config, Properties properties, DecoratorMapper parent)	Initialize the mapper.

Methods inherited from class com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

getNamedDecorator

Methods inherited from class java.lang.Object

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

Constructor Details

RobotDecoratorMapper

public RobotDecoratorMapper()

Method Details

init

public void init(Config config,
 Properties properties,
 DecoratorMapper parent)
          throws InstantiationException

Description copied from interface: DecoratorMapper

Initialize the mapper. This is always called before the other methods.

Specified by:

init in interface DecoratorMapper

Overrides:

init in class AbstractDecoratorMapper

Parameters:

config - Config supplied by Servlet or Filter.

properties - Any initialization properties (specific to implementation).

parent - the parent

Throws:

InstantiationException - the instantiation exception

getDecorator

public Decorator getDecorator(javax.servlet.http.HttpServletRequest request,
 Page page)

Description copied from interface: DecoratorMapper

Return appropriate Decorator for a certain Page.

The implementation can determine the result based on the actual request or the data of the parsed page. Typically this would call getNamedDecorator() which would delegate to a parent DecoratorMapper.

Specified by:

getDecorator in interface DecoratorMapper

Overrides:

getDecorator in class AbstractDecoratorMapper

Parameters:

request - the request

page - the page

Returns:

the decorator