Generator: GetFolderOverview

Description

Returns an overview of all the PSML files within a folder using the specified path parameter.

An overview is created by parsing every PSML file and extracting the following information from its content:

• Title, using the first <heading/> element.
• Summary, using the first <para/> element.
• Properties, using all the <property/> elements.

This generator is useful to provide some of the PSML information and properties from a set of PSML files rather than only use their file names.

Configuration

No configuration is required.

The root of the PSML folder can be configured using the global property bastille.psml.root which can be either an absolute path or a relative path from the global repository.

By default, the PSML root is set to psml which usually corresponds to the /WEB-INF/psml folder of your Web app.

Parameters

This generator requires a path parameter. The path parameter must be a relative path from within the PSML root folder to a PSML file without the extension.

Returned XML

The top level element is always the requested folder. Its child elements are either sub folders or files within that folder.

<overview folder="[folder name]" base="[folder path]">
  <!-- for each PSML file ... -->
  <entry name="[file name]">
    <title>[title]</title>
    <summary>[summary]</summary>
    <!-- for each property ... -->
    <property name="[name]" value="[value]" />
  </entry>
</file>

Error handling

Folder does not exist

If the folder cannot be found, this generator sets the status to NOT_FOUND and no content.

Missing path parameter

If the path parameter is not specified, this generator sets the status to BAD_REQUEST and returns the following:

<error type="client" message="The parameter 'path' was not specified"/>

Usage

<generator class="com.weborganic.bastille.psml.GetFolderOverview" ... >
  <parameter name="path" value="[path]"/>
</generator>