net.sourceforge.taverna.publish
Interface Repository

All Known Implementing Classes:

AbstractRepository, JxtaRepository, LocalRepository, SFTPRepository, WebDAVRepository

public interface Repository

This interface defines the methods needed by a Repository implementation. The Repository represents anywhere that workflows, or data files may be stored. A repository can be a network file share, a WebDAV repository, or any other file system. Last edited by $Author: sowen70 $

Version:

$Revision: 1.2 $

Author:

Mark

Method Summary

void	delete(org.apache.commons.vfs.FileObject[] filelist) This method deletes a list of files from the repository.
java.lang.String	getBaseURL() This method sets the base URL for the repository.
java.lang.String	getName() This method gets the name of the Repository.
org.apache.commons.vfs.FileObject	getRoot() This method returns the FileObject corresponding to the baseURL.
void	publish(org.apache.commons.vfs.FileObject[] filelist, org.apache.commons.vfs.FileObject startingDir) This method publishes a list of files, to selected directory.
org.apache.commons.vfs.FileObject[]	searchByFileName(org.apache.commons.vfs.FileObject startingDir, java.lang.String regex, boolean srchRecursively) This method searches the repository for a file whose
org.apache.commons.vfs.FileObject[]	searchByWorkFlowAuthor(org.apache.commons.vfs.FileObject startingDir, java.lang.String authorName, boolean srchRecursively) This method searches for workflows whose author is specified by a
org.apache.commons.vfs.FileObject[]	searchByWorkFlowDescription(org.apache.commons.vfs.FileObject startingDir, java.lang.String regex, boolean srchRecursively)
void	setBaseURL(java.lang.String baseURL) This method sets the base URL for the repository
void	setName(java.lang.String name) This method sets the name of the Repository.

Method Detail

getBaseURL

java.lang.String getBaseURL()

This method sets the base URL for the repository.

Returns:

setBaseURL

void setBaseURL(java.lang.String baseURL)

This method sets the base URL for the repository

Parameters:

baseURL -

getRoot

org.apache.commons.vfs.FileObject getRoot()

This method returns the FileObject corresponding to the baseURL.

Returns:

getName

java.lang.String getName()

This method gets the name of the Repository.

Returns:

setName

void setName(java.lang.String name)

This method sets the name of the Repository. This name will appear in a list box of repository names, so keep it short.

Parameters:

name -

searchByFileName

org.apache.commons.vfs.FileObject[] searchByFileName(org.apache.commons.vfs.FileObject startingDir,
                                                     java.lang.String regex,
                                                     boolean srchRecursively)

This method searches the repository for a file whose

Parameters:

startingDir - The directory from which to start the search. This should default to "/" the root directory.

regex - A regular expression that can be applied to each file.

srchRecursively - Indicates whether subdirectories should also be searched for files that match the regular expression

Returns:

A list of files that match the regular expression

searchByWorkFlowDescription

org.apache.commons.vfs.FileObject[] searchByWorkFlowDescription(org.apache.commons.vfs.FileObject startingDir,
                                                                java.lang.String regex,
                                                                boolean srchRecursively)

Parameters:

startingDir - The directory from which to start the search. This should default to "/" the root directory.

regex - A regular expression that can be applied to each file.

srchRecursively - Indicates whether subdirectories should also be searched for files that match the regular expression

Returns:

A list of files that match the regular expression

searchByWorkFlowAuthor

org.apache.commons.vfs.FileObject[] searchByWorkFlowAuthor(org.apache.commons.vfs.FileObject startingDir,
                                                           java.lang.String authorName,
                                                           boolean srchRecursively)

This method searches for workflows whose author is specified by a

Parameters:

startingDir - The directory from which to start the search. This should default to "/" the root directory.

regex - A regular expression that can be applied to each file.

srchRecursively - Indicates whether subdirectories should also be searched for files that match the regular expression

Returns:

A list of files that match the regular expression

publish

void publish(org.apache.commons.vfs.FileObject[] filelist,
             org.apache.commons.vfs.FileObject startingDir)
             throws PublicationException

This method publishes a list of files, to selected directory. If the directory is null, the filelist will be published to the root of the repository.

Parameters:

filelist - The list of files to be written.

startingDir - The directory in which to deposit the files. This directory is relative to the repository root directory.

Throws:

PublicationException

delete

void delete(org.apache.commons.vfs.FileObject[] filelist)
            throws PublicationException

This method deletes a list of files from the repository.

Parameters:

filelist -

Throws:

PublicationException