org.meshcms.core
Class CMSDirectoryFinder

java.lang.Object
  extended byjava.lang.Thread
      extended byorg.meshcms.util.DirectoryParser
          extended byorg.meshcms.core.CMSDirectoryFinder
All Implemented Interfaces:
java.lang.Runnable

public class CMSDirectoryFinder
extends DirectoryParser

Finds the CMS directory by searching for a sentinel file.


Field Summary
 
Fields inherited from class org.meshcms.util.DirectoryParser
initialDir, processStartDir, recursive
 
Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
 
Constructor Summary
CMSDirectoryFinder(java.io.File siteRoot, boolean virtualSite)
          Creates a new instance to search for the CMS directory using the given root.
 
Method Summary
 Path getCMSPath()
          Performs the search and returns the result.
protected  boolean preProcessDirectory(java.io.File file, Path path)
           
protected  void processFile(java.io.File file, Path path)
          This method will be called for any file found while parsing the base directory.
 
Methods inherited from class org.meshcms.util.DirectoryParser
getInitialDir, isProcessStartDir, isRecursive, isSorted, postProcess, postProcessDirectory, preProcess, process, run, setInitialDir, setInitialDir, setProcessStartDir, setRecursive, setSorted
 
Methods inherited from class java.lang.Thread
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getContextClassLoader, getName, getPriority, getThreadGroup, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setName, setPriority, sleep, sleep, start, stop, stop, suspend, toString, yield
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CMSDirectoryFinder

public CMSDirectoryFinder(java.io.File siteRoot,
                          boolean virtualSite)
Creates a new instance to search for the CMS directory using the given root.

Parameters:
siteRoot - initial directory to start the processing.
virtualSite - used to determine what file to search (virtual sites do not contain an admin directory, so a different file is searched).
Method Detail

processFile

protected void processFile(java.io.File file,
                           Path path)
Description copied from class: DirectoryParser
This method will be called for any file found while parsing the base directory.

Overrides:
processFile in class DirectoryParser
Parameters:
file - the file to be processed
path - the path of the file (relative to the base directory)

preProcessDirectory

protected boolean preProcessDirectory(java.io.File file,
                                      Path path)
Overrides:
preProcessDirectory in class DirectoryParser

getCMSPath

public Path getCMSPath()
Performs the search and returns the result.

Returns:
the CMS Path