com.segue.scc.published.api.vcs

Interface BrowseableProfile

All Known Subinterfaces:

SourceControlProfile, VersionControlProfile

public interface BrowseableProfile

A BrowseableProfile is used to browse file/folder structures.

See Also:

SourceControlDialog

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_FILE
static int	TYPE_PROJECT TODO rename to TYPE_DIRECTORY
static int	TYPE_RETRIEVE

Method Summary

Modifier and Type	Method and Description
void	addDirectory(java.lang.String filePath, java.lang.String projectName, java.lang.String comment) Create a subDirectory, also known as subProject.
java.lang.String	buildPath(java.lang.String parentPath, java.lang.String childName) Just create a path with parentPath, separator and childName.
java.lang.String	getRootPath() Get the rootPath of the current source control profile.
java.lang.String	getSeparator() The separator (character) the browsable system uses to separate pathnames.
boolean	isValidProjectName(java.lang.String name) Check, if the given name is a valid projectname, which means not containing illegal characters.
java.lang.String[]	list(java.lang.String filePath, java.lang.String pattern, int elementType) Get a list of elements inside the specified filePath.

Field Detail

TYPE_PROJECT

static final int TYPE_PROJECT

TODO rename to TYPE_DIRECTORY

See Also:

Constant Field Values

TYPE_FILE

static final int TYPE_FILE

See Also:

Constant Field Values

TYPE_RETRIEVE

static final int TYPE_RETRIEVE

See Also:

Constant Field Values

Method Detail

list

java.lang.String[] list(java.lang.String filePath,
                        java.lang.String pattern,
                        int elementType)
                 throws SourceControlException

Get a list of elements inside the specified filePath. You have to specify the elementType, so this means that all elements returned by this method are of the same type. The pattern can contain a wildcard string so only specific files are returned. This is usually used for finding files with specific extensions (e.g. "*.txt").

Parameters:

filePath - file or path to get from the Source control system, has to be relative to the Profileroot

pattern - optional pattern. e.g. "*.txt"

elementType - TYPE_PROJECT or TYPE_FILE

Throws:

SourceControlException

See Also:

TYPE_PROJECT, TYPE_FILE

addDirectory

void addDirectory(java.lang.String filePath,
                  java.lang.String projectName,
                  java.lang.String comment)
           throws SourceControlException

Create a subDirectory, also known as subProject. This needs to work recursively, if the projectName contains the separator.

Parameters:

filePath -

projectName - the name of the folder to be created

comment -

Throws:

SourceControlException

getRootPath

java.lang.String getRootPath()

Get the rootPath of the current source control profile. The rootPath contains the SourceControl's specific root directory followed by the "project-path" the user provided in the gui.

buildPath

java.lang.String buildPath(java.lang.String parentPath,
                           java.lang.String childName)

Just create a path with parentPath, separator and childName.

Parameters:

parentPath -

childName -

Returns:

path with parentPath, separator and childName

isValidProjectName

boolean isValidProjectName(java.lang.String name)

Check, if the given name is a valid projectname, which means not containing illegal characters.

Parameters:

name -

Returns:

true if the given name is a valid projectname

getSeparator

java.lang.String getSeparator()

The separator (character) the browsable system uses to separate pathnames. Usually this is a "/" (slash)