org.springframework.extensions.webscripts
Class AbstractStore

java.lang.Object
  org.springframework.extensions.webscripts.AbstractStore

All Implemented Interfaces:

Store

Direct Known Subclasses:

ClassPathStore, JarStore, LocalFileSystemStore, RemoteStore

public abstract class AbstractStore
extends Object
implements Store

Abstract store class provided as a convenience for developers who wish to build their own custom Store implementations for use with the Web Script framework.

Author:

muzquiano

Constructor Summary

AbstractStore()

Method Summary

String[]	getDocumentPaths(String path, String filePathPattern) Gets the paths matching a given file path pattern in this store.
PreviewContext	getPreviewContext() Gets the preview context
void	setPreviewContextProvider(PreviewContextProvider previewContextProvider) Sets the preview context provider

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.extensions.webscripts.Store

createDocument, exists, getAllDocumentPaths, getBasePath, getDescriptionDocumentPaths, getDocument, getDocumentPaths, getScriptDocumentPaths, getScriptLoader, getTemplateLoader, hasDocument, init, isSecure, lastModified, removeDocument, updateDocument

Constructor Detail

AbstractStore

public AbstractStore()

Method Detail

setPreviewContextProvider

public void setPreviewContextProvider(PreviewContextProvider previewContextProvider)

Sets the preview context provider

Parameters:

previewContextProvider -

getPreviewContext

public PreviewContext getPreviewContext()

Gets the preview context

Returns:

preview context

getDocumentPaths

public String[] getDocumentPaths(String path,
                                 String filePathPattern)

Description copied from interface: Store

Gets the paths matching a given file path pattern in this store.

Specified by:

getDocumentPaths in interface Store

Parameters:

path - start path

filePathPattern - file path pattern string, allows wildcards, eg. *.ftl or my*.ftl or *\/a\/*.xml

Returns:

array of document paths