org.weborganic.bastille.psml
Class PSMLLinkProcessor

java.lang.Object
  extended by org.weborganic.bastille.psml.PSMLLinkProcessor

public final class PSMLLinkProcessor
extends Object

A utility class to process links in PSML data.


Field Summary
static String CACHE_NAME
          Name of the cache.
 
Method Summary
static String getEtag(PSMLFile psml)
          Returns the etag for the PSML file based on the last modified date of the file and all transcluded documents.
static String process(PSMLFile psml)
          Generate the overview documents for the files for the specified folder.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CACHE_NAME

public static final String CACHE_NAME
Name of the cache.

See Also:
Constant Field Values
Method Detail

process

public static String process(PSMLFile psml)
                      throws BerliozException,
                             IOException
Generate the overview documents for the files for the specified folder.

Parameters:
psml - The PSML file to process.
Returns:
the XML content as a string.
Throws:
BerliozException - If an error occurs during parsing.
IOException - Should any error occur.

getEtag

public static String getEtag(PSMLFile psml)
Returns the etag for the PSML file based on the last modified date of the file and all transcluded documents.

Parameters:
psml - the PSML file.
Returns:
The corresponding etag or null if the file does not exist.
Throws:
NullPointerException - if the file is null.