org.nodal
Interface RepositoryDriver

All Known Implementing Classes:
Nodal.DriverBase

public interface RepositoryDriver

Author:
Lee Iverson

Method Summary
 boolean accepts(Path path)
          Evaluate a URL and determine whether or not it can possibly be handled by this driver.
 java.lang.String description()
          Return a description of this RepositoryDriver.
 Repository openRepository(Path path)
          Open (or reopen) a Repository that contains the URL given.
 

Method Detail

description

public java.lang.String description()
Return a description of this RepositoryDriver.

Returns:
a String describing this driver

accepts

public boolean accepts(Path path)
Evaluate a URL and determine whether or not it can possibly be handled by this driver.

Parameters:
path - an absolute Path that identifies a Repository
Returns:
true if the given url may be opened by this driver

openRepository

public Repository openRepository(Path path)
Open (or reopen) a Repository that contains the URL given. It is an error (possibly unchecked) to call this method for a URL for which {#acceptsURL} has returned false.

Parameters:
path - a Path for an object contained within a Repository handled by this driver
Returns:
an open Repository containing this URL or null if unable to open