org.springframework.extensions.surf.support

Class AbstractLinkBuilder

java.lang.Object

org.springframework.extensions.surf.support.BaseFactoryBean

org.springframework.extensions.surf.support.AbstractLinkBuilder

All Implemented Interfaces:

LinkBuilder

Direct Known Subclasses:

RequestParameterLinkBuilder

public abstract class AbstractLinkBuilder
extends BaseFactoryBean
implements LinkBuilder

Abstract base class for LinkBuilder implementations. This is provided as a convenience to developers who wish to build their own custom LinkBuilder variations.

The Link Builder defines methods that are used generically to construct links to other pages, page types or objects within the system.

In general, links are either to specific "known" pages or to page placeholders that must be resolved when the link is clicked.

Example - a link to a page:

• String link = builder.page(context, "homepageInstance");

Author:

muzquiano, David Draper

Constructor Summary

Constructors

Constructor and Description
AbstractLinkBuilder(WebFrameworkConfigElement webFrameworkConfigElement, ModelObjectService modelObjectService, ResourceService resourceService) This is the preferred constructor to use when instantiating an AbstractLinkBuilder.
AbstractLinkBuilder(WebFrameworkServiceRegistry serviceRegistry) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
String	object(RequestContext context, String objectId) Constructs a link to a given object.
String	object(RequestContext context, String objectId, String formatId) Constructs a link to a given object.
abstract String	object(RequestContext context, String objectId, String formatId, Map<String,String> params) Constructs a link to a given object.
String	page(RequestContext context, String pageId) Constructs a link to a given page instance.
String	page(RequestContext context, String pageId, String formatId) Constructs a link to a given page for a given format.
String	page(RequestContext context, String pageId, String formatId, String objectId) Constructs a link to a given page for a given format.
abstract String	page(RequestContext context, String pageId, String formatId, String objectId, Map<String,String> params) Constructs a link to a given page for a given format.
String	pageType(RequestContext context, String pageTypeId) Constructs a link to a given page type.
String	pageType(RequestContext context, String pageTypeId, String formatId) Constructs a link to a given page type for a given format.
String	pageType(RequestContext context, String pageTypeId, String formatId, String objectId) Constructs a link to a given page type for a given format.
abstract String	pageType(RequestContext context, String pageTypeId, String formatId, String objectId, Map<String,String> params) Constructs a link to a given page type for a given format.
abstract String	resource(RequestContext context, String uri) Constructs a link to a resources at a given relative uri.

Methods inherited from class org.springframework.extensions.surf.support.BaseFactoryBean

getObjectService, getResourceService, getServiceRegistry, getWebFrameworkConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLinkBuilder

public AbstractLinkBuilder(WebFrameworkServiceRegistry serviceRegistry)

Deprecated.

This constructor has been deprecated because it uses the deprecated WebFrameworkServiceRegistry to obtain the actual Spring bean elements needed by the AbstractLinkBuilder.

Parameters:

serviceRegistry - WebFrameworkServiceRegistry

AbstractLinkBuilder

public AbstractLinkBuilder(WebFrameworkConfigElement webFrameworkConfigElement,
                   ModelObjectService modelObjectService,
                   ResourceService resourceService)

This is the preferred constructor to use when instantiating an AbstractLinkBuilder. By supplying the WebFrameworkConfigElement, ModelObjectService and ResourceService arguments directly (rather than obtaining them from the WebFrameworkServiceRegistry) you can have link builders using different services.

Parameters:

webFrameworkConfigElement - WebFrameworkConfigElement

modelObjectService - ModelObjectService

resourceService - ResourceService

Method Detail

page

public String page(RequestContext context,
          String pageId)

Description copied from interface: LinkBuilder

Constructs a link to a given page instance. This will automatically use the default format.

Specified by:

page in interface LinkBuilder

Parameters:

context - The Request Context instance

pageId - The id of the page instance

page

public String page(RequestContext context,
          String pageId,
          String formatId)

Description copied from interface: LinkBuilder

Constructs a link to a given page for a given format.

Specified by:

page in interface LinkBuilder

Parameters:

context - The Request Context instance

pageId - The id of the page instance

formatId - The id of the format to render

page

public String page(RequestContext context,
          String pageId,
          String formatId,
          String objectId)

Description copied from interface: LinkBuilder

Constructs a link to a given page for a given format. The provided object is passed in as context.

Specified by:

page in interface LinkBuilder

Parameters:

context - The Request Context instance

pageId - The id of the page instance

formatId - The id of the format to render

objectId - The id of the object

page

public abstract String page(RequestContext context,
          String pageId,
          String formatId,
          String objectId,
          Map<String,String> params)

Description copied from interface: LinkBuilder

Constructs a link to a given page for a given format. The provided object is passed in as context. The provided parameters are appended to the URL.

Specified by:

page in interface LinkBuilder

Parameters:

context - The Request Context instance

pageId - The id of the page instance

formatId - The id of the format to render

objectId - The id of the object

params - A map of name/value pairs to be appended to the URL

pageType

public String pageType(RequestContext context,
              String pageTypeId)

Description copied from interface: LinkBuilder

Constructs a link to a given page type. This will automatically use the default format.

Specified by:

pageType in interface LinkBuilder

Parameters:

context - The Request Context instance

pageTypeId - The type of the page

pageType

public String pageType(RequestContext context,
              String pageTypeId,
              String formatId)

Description copied from interface: LinkBuilder

Constructs a link to a given page type for a given format.

Specified by:

pageType in interface LinkBuilder

Parameters:

context - The Request Context instance

pageTypeId - The type of the page

formatId - The id of the format to render

pageType

public String pageType(RequestContext context,
              String pageTypeId,
              String formatId,
              String objectId)

Description copied from interface: LinkBuilder

Constructs a link to a given page type for a given format. The provided object is passed in as context.

Specified by:

pageType in interface LinkBuilder

Parameters:

context - The Request Context instance

pageTypeId - The type of the page

formatId - The id of the format to render

objectId - The id of the object

pageType

public abstract String pageType(RequestContext context,
              String pageTypeId,
              String formatId,
              String objectId,
              Map<String,String> params)

Description copied from interface: LinkBuilder

Constructs a link to a given page type for a given format. The provided object is passed in as context. The provided parameters are appended to the URL.

Specified by:

pageType in interface LinkBuilder

Parameters:

context - The Request Context instance

pageTypeId - The type of the page

formatId - The id of the format to render

objectId - The id of the object

params - A map of name/value pairs to be appended to the URL

object

public String object(RequestContext context,
            String objectId)

Description copied from interface: LinkBuilder

Constructs a link to a given object. This will automatically use the default format.

Specified by:

object in interface LinkBuilder

Parameters:

context - The Request Context instance

objectId - The id of the object

object

public String object(RequestContext context,
            String objectId,
            String formatId)

Description copied from interface: LinkBuilder

Constructs a link to a given object. This will automatically use the default format.

Specified by:

object in interface LinkBuilder

Parameters:

context - The Request Context instance

objectId - The id of the object

formatId - The id of the format to render

object

public abstract String object(RequestContext context,
            String objectId,
            String formatId,
            Map<String,String> params)

Description copied from interface: LinkBuilder

Constructs a link to a given object. The provided object is passed in as context. The provided parameters are appended to the URL.

Specified by:

object in interface LinkBuilder

Parameters:

context - The Request Context instance

objectId - The id of the object

formatId - The id of the format to render

params - A map of name/value pairs to be appended to the URL

resource

public abstract String resource(RequestContext context,
              String uri)

Description copied from interface: LinkBuilder

Constructs a link to a resources at a given relative uri.

Specified by:

resource in interface LinkBuilder

Parameters:

context - RequestContext

uri - String

Returns:

the