org.springframework.extensions.surf

Class PresetsManager

java.lang.Object

org.springframework.extensions.surf.PresetsManager

public class PresetsManager
extends Object

Spring util bean responsible for preset model object generation.

Presets are defined as XML snippets representing the model objects for a given set. Each file can contain many presets each referenced by a unique ID. The preset definitions can be located in any Store and any number of stores can be searched.

A set of parameterised model objects such as page, template instances and component bindings can be defined for a preset. The XML for each model object definition is effectively identical to that used to define the model object within its own file - but nested within the preset structure as follows:

 <?xml version='1.0' encoding='UTF-8'?>
 <presets>
     <preset id="someid">
         <components>
             ...
         </components>
         <pages>
             ...
         </pages>
         <template-instances>
             ...
         </template-instances>
     </preset>
     <preset id="anotherid">
         ...
     </preset>
 </presets>
 

One important difference to standard model object XML is that the ID for an object is specified as an attribute on the parent element, for instance:

<page id="user/${userid}/dashboard">

See the file slingshot\config\alfresco\site-data\presets\presets.xml for example usage.

Each preset supports parameterisation via "token" name/value pair replacements. For example:

     <preset id="site-dashboard">
         <components>
             <component>
                 <scope>${scope}</scope>
                 <region-id>title</region-id>
                 <source-id>site/${siteid}/dashboard</source-id>
                 <url>/components/title/collaboration-title</url>
             </component>
             ...
 

where the values of "${scope}" and "${siteid}" would be replaced if supplied in the token map during preset construction. See the method constructPreset() below.

Author:

Kevin Roast

Constructor Summary

Constructors

Constructor and Description
PresetsManager()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	constructPreset(String id, Map<String,String> tokens) Construct the model objects for a given preset.
void	setFiles(List<String> files) This setter is provided to allow the Spring application context to set the filename suffices that should be used for presets.
void	setModelObjectService(ModelObjectService modelObjectService)
void	setSearchPath(org.springframework.extensions.webscripts.SearchPath searchPath)

Methods inherited from class java.lang.Object

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

Constructor Detail

PresetsManager

public PresetsManager()

Method Detail

setModelObjectService

public void setModelObjectService(ModelObjectService modelObjectService)

Parameters:

modelObjectService - the model object service

setSearchPath

public void setSearchPath(org.springframework.extensions.webscripts.SearchPath searchPath)

Parameters:

searchPath - The SearchPath to set

setFiles

public void setFiles(List<String> files)

This setter is provided to allow the Spring application context to set the filename suffices that should be used for presets. Originally this was treated as a list of complete filenames but has since been expanded to increase the ability to extend default application presets.

Parameters:

files - A list of filename suffices that can be matched to presets configuration files.

constructPreset

public boolean constructPreset(String id,
                      Map<String,String> tokens)

Construct the model objects for a given preset. Objects persist to the default store for the appropriate object type.

Parameters:

id - Preset ID to use

tokens - Name value pair tokens to replace in preset definition

Returns:

true on successfully created preset, false on failure