org.weborganic.bastille.psml
Class GetFolderOverview

java.lang.Object
  org.weborganic.bastille.psml.GetFolderOverview

All Implemented Interfaces:

Cacheable, ContentGenerator

public final class GetFolderOverview
extends Object
implements ContentGenerator, Cacheable

Returns an overview of the folder by Berlioz path.

The overview is generated from the first header and the first paragraph from each PageSeeder XML.

Configuration

No configuration required for this generator.

Parameters

No parameters necessary.

Returned XML

<overview folder="[folder]">
    <entry file="[filename]">
      <title>[firsttitle]</title>
      <summary>[firstpara]</summary>
    </entry>
    ...
  <overview>
 

Deployment

<generator class="org.weborganic.bastille.xml.GetFolderOverview" name="overview" target="main" />
 

Since:

0.6.33

Constructor Summary

GetFolderOverview()

Method Summary

String	getETag(ContentRequest req)
void	process(ContentRequest req, XMLWriter xml)

Methods inherited from class java.lang.Object

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

Constructor Detail

GetFolderOverview

public GetFolderOverview()

Method Detail

getETag

public String getETag(ContentRequest req)

Specified by:

getETag in interface Cacheable

process

public void process(ContentRequest req,
                    XMLWriter xml)
             throws BerliozException,
                    IOException

Specified by:

process in interface ContentGenerator

Throws:

BerliozException

IOException