org.weborganic.bastille.psml
Class PSMLOverviews

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

public final class PSMLOverviews
extends Object

A utility class to generate the overview data.

Since:

0.6.33

Field Summary

static String

CACHE_NAME Name of the cache.

Method Summary

static List<File>	getContents(File dir) Returns the list of XML files in the specified directory.
static String	getOverview(PSMLFile folder) Generate the overview documents for the files for the specified folder.
static long	lastModified(List<File> files)

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

getOverview

public static String getOverview(PSMLFile folder)
                          throws BerliozException,
                                 IOException

Generate the overview documents for the files for the specified folder.

Parameters:

folder - The directory to scan.

Returns:

the XML content as a string.

Throws:

BerliozException - If an error occurs during parsing.

IOException - Should any error occur.

getContents

public static List<File> getContents(File dir)

Returns the list of XML files in the specified directory.

Parameters:

dir - the directory

Returns:

the list of XML files in the directory.

lastModified

public static long lastModified(List<File> files)

Parameters:

files - the list of files to check

Returns:

the date of the last modified file in the list.