org.craftercms.core.store.impl

Class AbstractFileBasedContentStoreAdapter

java.lang.Object

org.craftercms.core.store.impl.AbstractCachedContentStoreAdapter

org.craftercms.core.store.impl.AbstractFileBasedContentStoreAdapter

All Implemented Interfaces:

ContentStoreAdapter

Direct Known Subclasses:

FileSystemContentStoreAdapter

public abstract class AbstractFileBasedContentStoreAdapter
extends AbstractCachedContentStoreAdapter

File-based content store adapter. Takes away common stuff from actual implementations, like handling metadata files and loading descriptor DOMs.

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field and Description
protected String	charset
static String	DEFAULT_CHARSET
protected String	descriptorFileExtension
protected String	metadataFileExtension

Fields inherited from class org.craftercms.core.store.impl.AbstractCachedContentStoreAdapter

cacheTemplate, CONST_KEY_ELEM_CONTENT, CONST_KEY_ELEM_ITEM, CONST_KEY_ELEM_ITEMS, defaultCachingOptions

Constructor Summary

Constructors

Constructor and Description
AbstractFileBasedContentStoreAdapter()

Method Summary

Modifier and Type	Method and Description
protected org.dom4j.io.SAXReader	createXmlReader() Creates and configures an XML SAX reader.
protected Content	doFindContent(Context context, CachingOptions cachingOptions, String path)
protected Item	doFindItem(Context context, CachingOptions cachingOptions, String path, boolean withDescriptor)
protected List<Item>	doFindItems(Context context, CachingOptions cachingOptions, String path, boolean withDescriptor)
boolean	exists(Context context, String path)
protected abstract File	findFile(Context context, String path) Returns the File at the given path, returning null if not found.
protected abstract List<File>	getChildren(Context context, File dir) Returns the list of children of the given directory.
protected String	normalizePath(String path) Normalize the path: this means, append a leading '/' at the beginning and remove any trailing '/' (unless the path is root).
void	setCharset(String charset)
void	setDescriptorFileExtension(String descriptorFileExtension)
void	setMetadataFileExtension(String metadataFileExtension)

Methods inherited from class org.craftercms.core.store.impl.AbstractCachedContentStoreAdapter

findContent, findItem, findItems, setCacheTemplate, setDefaultCachingOptions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.craftercms.core.store.ContentStoreAdapter

createContext, destroyContext, validate

Field Detail

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

See Also:

Constant Field Values

charset

protected String charset

descriptorFileExtension

protected String descriptorFileExtension

metadataFileExtension

protected String metadataFileExtension

Constructor Detail

AbstractFileBasedContentStoreAdapter

public AbstractFileBasedContentStoreAdapter()

Method Detail

setCharset

public void setCharset(String charset)

setDescriptorFileExtension

public void setDescriptorFileExtension(String descriptorFileExtension)

setMetadataFileExtension

public void setMetadataFileExtension(String metadataFileExtension)

exists

public boolean exists(Context context,
                      String path)
               throws InvalidScopeException,
                      StoreException

Throws:

InvalidScopeException

StoreException

doFindContent

protected Content doFindContent(Context context,
                                CachingOptions cachingOptions,
                                String path)
                         throws InvalidContextException,
                                StoreException

Specified by:

doFindContent in class AbstractCachedContentStoreAdapter

Throws:

InvalidContextException

StoreException

doFindItem

protected Item doFindItem(Context context,
                          CachingOptions cachingOptions,
                          String path,
                          boolean withDescriptor)
                   throws InvalidContextException,
                          PathNotFoundException,
                          XmlFileParseException,
                          StoreException

Specified by:

doFindItem in class AbstractCachedContentStoreAdapter

Throws:

InvalidContextException

PathNotFoundException

XmlFileParseException

StoreException

doFindItems

protected List<Item> doFindItems(Context context,
                                 CachingOptions cachingOptions,
                                 String path,
                                 boolean withDescriptor)
                          throws InvalidContextException,
                                 PathNotFoundException,
                                 XmlFileParseException,
                                 StoreException

Specified by:

doFindItems in class AbstractCachedContentStoreAdapter

Throws:

InvalidContextException

PathNotFoundException

XmlFileParseException

StoreException

normalizePath

protected String normalizePath(String path)

Normalize the path: this means, append a leading '/' at the beginning and remove any trailing '/' (unless the path is root). This is done for consistency in handling paths.

Parameters:

path -

Returns:

the normalized path (with a leading '/' and without a trailing '/')

createXmlReader

protected org.dom4j.io.SAXReader createXmlReader()

Creates and configures an XML SAX reader.

findFile

protected abstract File findFile(Context context,
                                 String path)
                          throws InvalidContextException,
                                 StoreException

Returns the File at the given path, returning null if not found.

Throws:

InvalidContextException

StoreException

getChildren

protected abstract List<File> getChildren(Context context,
                                          File dir)
                                   throws InvalidContextException,
                                          StoreException

Returns the list of children of the given directory.

Throws:

InvalidContextException

StoreException