org.sourcejammer.project.controller
Class ProjectController

java.lang.Object
  |
  +--org.sourcejammer.project.controller.ProjectController
All Implemented Interfaces:
Archive

public class ProjectController
extends java.lang.Object
implements Archive

Title: $FileName: ProjectController.java$

Version:
$VerNum: 15$ $KeyWordsOff: $

ProjectController is responsible for returning objects from the model implementation, and adding and maintaining objects in the model implementation. This class also maintains a cache of the entire project hierarchy of a particular archive. This object does not handle user-level security except to allow checking out and checking in of files. User names and passwords are verified and controlled by the object that calls this object. A ProjectController is created and (hopefully) cached for a single archive.
Author:
$AuthorName: Rob MacGrogan$

Field Summary
private static long LOCK_TIME_OUT
           
private  ArchiveInfoFlex moArchive
           
private  org.sourcejammer.project.NodeList moLabels
           
private  NodeLibrary moLibrary
           
static long ROOT_PROJECT_ID
           
 
Constructor Summary
ProjectController()
           
 
Method Summary
 long addFile(long projectID, java.lang.String name, java.io.File file, org.sourcejammer.project.view.FileProperties props, java.lang.String userName)
          Adds a new file to this archive, at the specified location.
 long addNewVersion(long fileID, java.io.File newVersion, java.lang.String comment, java.lang.String userName)
          Adds a new version to an existing file.
 long addProject(long parentID, java.lang.String name)
          Adds a new project at the specified location (the NodeName object) to this archive.
protected  Label buildLabel(Label label, long parentProjectID, java.lang.String baseSJPath, long skipFile)
          This method recursively calls itself until it has put all of the latest versions of all the file nodes in parent (and in all ProjectNode children of parent) into label.
 void checkInFile(long fileID)
          Set status of specified file to checked in.
 void checkOutFile(long fileID, java.lang.String userName, java.lang.String checkOutLocation)
          Set status of specified file to checked out.
private  boolean childFileCheckedOut(long projectID)
           
protected  org.sourcejammer.project.view.NodeInfo controllerNodeToNodeInfo(ControllerNode nd)
          Builds new NodeInfo object from ControllerNode.
private  boolean convertTextFileAndManageKeywords(FileNode ndFile, java.lang.String userName, java.io.File file, org.sourcejammer.project.view.NodeInfo ndVer, java.lang.String comment)
          Returns true if keyword expansion will be attempted.
 void copyFile(long fileID, long parentProjectID, long newParentProjectID, java.lang.String userName)
          Copies the specified file from one project to another.
 void copyProject(long projectID, long parentProjectID, long newParentProjectID, java.lang.String userName, java.lang.String newProjectName)
          Copies the specified project and all children from one project to another.
private  void copyProjectsAndFiles(ProjectNode source, ProjectNode target, java.lang.String userName)
          Copy all children of source to target, recursively.
 ArchiveInfoFlex getArchiveInfo()
          Gives subclasses access to archive info object.
 long getChangeList(long labelID, int verNewer, int verOlder, int eolType)
          Generated change list for specified label and saves it as a temp file.
 org.sourcejammer.project.view.File getFile(long fileID)
          Get File object (info about file).
 java.lang.String getFileDescription(long fileID)
          Gets and returns the description of a file.
 long getFileLatestVersion(long fileID, int requestedEOL)
          Get latest version of file source to temp dir and return temp file ID.
 TextLineReader getFileLatestVersionTLR(long fileID)
          Get latest version of text file source as TextLineReader.
 FileNode getFileNode(long fileID)
          Allows "master control" to look at file info to verify check out, check in, file type, etc.
 FileNode getFileNode(long fileID, boolean readOnly)
          Allows "master control" to look at file info to verify check out, check in, file type, etc.
 Delta getFileVersionDelta(long versionID)
          Get specified delta object for file.
 Delta getFileVersionTextDelta(long versionID)
          Get specified delta object for file.
 Label getLabelContentList(long labelID, int versionNumber)
          Returns the Label object (which contains the sourcejammer path and version number for each object in the labeled version) with the specified name.
 org.sourcejammer.project.NodeList getLabelList()
          Deprecated.  
 java.io.File getLatestVersionSourceFilePointer(long fileID)
          Returns java.io.File object for latest version's source.
 org.sourcejammer.project.view.Project getProject(long projectID)
          Get Project object (info about project).
 java.util.Vector getRemovedNodes(long projectID)
          Returns a Vector of NodeInfo objects, one for each node that has been removed (but not permanently deleted) from the parent project.
 org.sourcejammer.project.view.Project getRootProject()
          Returns the view Project for the root node of the archive for this ProjectController.
 long getUniqueIDFromPath(long parentID, java.lang.String path)
          Returns unique id based on a path.
 java.lang.String getVersionComment(long versionID)
          Get the comment for the specified version.
 long getVersionFileSizeInBytes(long fileID, int versionNumber)
          Gets the size of the version file in bytes.
private  boolean isChildOfProject(long parentProjectID, long childProjectID)
           
 void makeLabeledVersion(java.lang.String name, java.lang.String description, long parentProjectID, java.lang.String userName)
          Create and save a new labeled version with the passed-in name and description and containing all of the latest versions that are children of parent.
private  java.io.File makeLabelInFile(java.lang.String name, java.lang.String description, java.util.Date createDate, long parentProjectID, long existingLabelID)
           
 void moveFile(long fileID, long parentProjectID, long newParentProjectID)
          Moves the specified file from one project to another.
 void moveProject(long projectID, long parentProjectID, long newParentProjectID, java.lang.String newProjectName)
          Moves the specified project from one project to another.
 void permanentlyDeleteRemovedNode(long projectID, int index)
          Permanently delete specified removed node.
protected  org.sourcejammer.project.view.Project projectNodeToProject(ProjectNode ndProject)
           
 void rebuildLabel(long labelID, java.lang.String description, long parentProjectID, java.lang.String userName)
           
 void releaseFileNode(FileNode nd)
          Release a file node.
 void removeFile(long parentID, long fileID)
          Remove specified file from specified project.
 void removeProject(long parentID, long projectID)
          Remove specified project from the project hierarchy.
 void renameFile(long parentID, long fileID, java.lang.String newName)
           
 void renameProject(long parentID, long projectID, java.lang.String newName)
           
 void restoreRemovedNode(long parentID, int index)
          Restores a project or file node that was previously removed from the archive.
 void restoreRemovedNode(long parentID, java.lang.String newName, int index)
          Restores a project or file node that was previously removed from the archive.
 java.io.File retrieveVersionDeltaFile(org.sourcejammer.project.view.NodeInfo versionNode)
           
 void rollbackToVersion(long fileID, long versionID, java.io.File newLatestVersion)
          Rollback specified file to specified version number.
 void setArchiveInfo(ArchiveInfoFlex info)
          Sets the ArchiveInfo object for this ProjectController.
 void setFileDescription(long fileID, java.lang.String description)
          Changes description of a file.
 void setNodeLibrary(NodeLibrary lib)
          Set the NodeLibrary object for this archive.
 void setVersionComment(long fileID, int version, java.lang.String comment)
          Set the comment of the specified version.
private  java.lang.String[] versionListToStringArray(FileNode file)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ROOT_PROJECT_ID

public static final long ROOT_PROJECT_ID
See Also:
Constant Field Values

moArchive

private ArchiveInfoFlex moArchive

moLabels

private org.sourcejammer.project.NodeList moLabels

moLibrary

private NodeLibrary moLibrary

LOCK_TIME_OUT

private static final long LOCK_TIME_OUT
See Also:
Constant Field Values
Constructor Detail

ProjectController

public ProjectController()
Method Detail

setArchiveInfo

public void setArchiveInfo(ArchiveInfoFlex info)
                    throws FileAccessException
Sets the ArchiveInfo object for this ProjectController.

Specified by:
setArchiveInfo in interface Archive
FileAccessException

setNodeLibrary

public void setNodeLibrary(NodeLibrary lib)
Set the NodeLibrary object for this archive.


getArchiveInfo

public ArchiveInfoFlex getArchiveInfo()
Gives subclasses access to archive info object.

Specified by:
getArchiveInfo in interface Archive

copyFile

public void copyFile(long fileID,
                     long parentProjectID,
                     long newParentProjectID,
                     java.lang.String userName)
              throws org.sourcejammer.project.NodeExistsException,
                     org.sourcejammer.project.NodeDoesNotExistException,
                     SecurityException,
                     FileAccessException,
                     FileDoesNotExistException,
                     NoSuchVersionException
Copies the specified file from one project to another. No file history is copied. A new source file is created.

Specified by:
copyFile in interface Archive
org.sourcejammer.project.NodeExistsException
org.sourcejammer.project.NodeDoesNotExistException
SecurityException
FileAccessException
FileDoesNotExistException
NoSuchVersionException

moveFile

public void moveFile(long fileID,
                     long parentProjectID,
                     long newParentProjectID)
              throws org.sourcejammer.project.NodeExistsException,
                     FileAccessException,
                     SecurityException,
                     NoSuchVersionException,
                     org.sourcejammer.project.NodeDoesNotExistException,
                     FileDoesNotExistException
Moves the specified file from one project to another.

Specified by:
moveFile in interface Archive
org.sourcejammer.project.NodeExistsException
FileAccessException
SecurityException
NoSuchVersionException
org.sourcejammer.project.NodeDoesNotExistException
FileDoesNotExistException

moveProject

public void moveProject(long projectID,
                        long parentProjectID,
                        long newParentProjectID,
                        java.lang.String newProjectName)
                 throws org.sourcejammer.project.NodeExistsException,
                        FileAccessException,
                        SecurityException,
                        NoSuchVersionException,
                        org.sourcejammer.project.NodeDoesNotExistException,
                        ProjectDoesNotExistException
Moves the specified project from one project to another.

Specified by:
moveProject in interface Archive
org.sourcejammer.project.NodeExistsException
FileAccessException
SecurityException
NoSuchVersionException
org.sourcejammer.project.NodeDoesNotExistException
ProjectDoesNotExistException

copyProject

public void copyProject(long projectID,
                        long parentProjectID,
                        long newParentProjectID,
                        java.lang.String userName,
                        java.lang.String newProjectName)
                 throws org.sourcejammer.project.NodeExistsException,
                        org.sourcejammer.project.NodeDoesNotExistException,
                        SecurityException,
                        FileAccessException,
                        FileDoesNotExistException,
                        NoSuchVersionException,
                        ProjectDoesNotExistException
Description copied from interface: Archive
Copies the specified project and all children from one project to another. No file history is copied. A new source for each file is created.

Specified by:
copyProject in interface Archive
org.sourcejammer.project.NodeExistsException
org.sourcejammer.project.NodeDoesNotExistException
SecurityException
FileAccessException
FileDoesNotExistException
NoSuchVersionException
ProjectDoesNotExistException

copyProjectsAndFiles

private void copyProjectsAndFiles(ProjectNode source,
                                  ProjectNode target,
                                  java.lang.String userName)
                           throws NoSuchVersionException,
                                  FileDoesNotExistException,
                                  FileAccessException,
                                  SecurityException,
                                  org.sourcejammer.project.NodeDoesNotExistException,
                                  org.sourcejammer.project.NodeExistsException,
                                  ProjectDoesNotExistException
Copy all children of source to target, recursively.

NoSuchVersionException
FileDoesNotExistException
FileAccessException
SecurityException
org.sourcejammer.project.NodeDoesNotExistException
org.sourcejammer.project.NodeExistsException
ProjectDoesNotExistException

getRootProject

public org.sourcejammer.project.view.Project getRootProject()
                                                     throws FileAccessException,
                                                            SecurityException
Returns the view Project for the root node of the archive for this ProjectController.

Specified by:
getRootProject in interface Archive
FileAccessException
SecurityException

addProject

public long addProject(long parentID,
                       java.lang.String name)
                throws FileAccessException,
                       ProjectDoesNotExistException,
                       org.sourcejammer.project.NodeExistsException,
                       SecurityException
Adds a new project at the specified location (the NodeName object) to this archive.

Specified by:
addProject in interface Archive
Returns:
unique ID of new project.
FileAccessException
ProjectDoesNotExistException
org.sourcejammer.project.NodeExistsException
SecurityException

addFile

public long addFile(long projectID,
                    java.lang.String name,
                    java.io.File file,
                    org.sourcejammer.project.view.FileProperties props,
                    java.lang.String userName)
             throws FileAccessException,
                    ProjectDoesNotExistException,
                    FileAlreadyExistsException,
                    SecurityException,
                    TextFileException
Adds a new file to this archive, at the specified location. Note: fileType means binary or text. Returns new version unique ID.

Specified by:
addFile in interface Archive
FileAccessException
ProjectDoesNotExistException
FileAlreadyExistsException
SecurityException
TextFileException

getFileDescription

public java.lang.String getFileDescription(long fileID)
                                    throws FileAccessException,
                                           FileDoesNotExistException,
                                           SecurityException
Gets and returns the description of a file.

Specified by:
getFileDescription in interface Archive
FileAccessException
FileDoesNotExistException
SecurityException

setFileDescription

public void setFileDescription(long fileID,
                               java.lang.String description)
                        throws FileAccessException,
                               FileDoesNotExistException,
                               SecurityException
Changes description of a file.

Specified by:
setFileDescription in interface Archive
FileAccessException
FileDoesNotExistException
SecurityException

addNewVersion

public long addNewVersion(long fileID,
                          java.io.File newVersion,
                          java.lang.String comment,
                          java.lang.String userName)
                   throws FileAccessException,
                          FileDoesNotExistException,
                          TextFileException,
                          SecurityException,
                          EndOfSourceException,
                          InvalidSourceException,
                          WrongFileTypeException
Adds a new version to an existing file. Returns newest version id.

Specified by:
addNewVersion in interface Archive
FileAccessException
FileDoesNotExistException
TextFileException
SecurityException
EndOfSourceException
InvalidSourceException
WrongFileTypeException

getProject

public org.sourcejammer.project.view.Project getProject(long projectID)
                                                 throws FileAccessException,
                                                        ProjectDoesNotExistException,
                                                        SecurityException
Get Project object (info about project).

Specified by:
getProject in interface Archive
FileAccessException
ProjectDoesNotExistException
SecurityException

convertTextFileAndManageKeywords

private boolean convertTextFileAndManageKeywords(FileNode ndFile,
                                                 java.lang.String userName,
                                                 java.io.File file,
                                                 org.sourcejammer.project.view.NodeInfo ndVer,
                                                 java.lang.String comment)
                                          throws UserDoesNotExistException,
                                                 TextFileException,
                                                 FileAccessException
Returns true if keyword expansion will be attempted.

UserDoesNotExistException
TextFileException
FileAccessException

getFile

public org.sourcejammer.project.view.File getFile(long fileID)
                                           throws FileAccessException,
                                                  FileDoesNotExistException,
                                                  SecurityException
Get File object (info about file).

Specified by:
getFile in interface Archive
FileAccessException
FileDoesNotExistException
SecurityException

versionListToStringArray

private java.lang.String[] versionListToStringArray(FileNode file)

getLatestVersionSourceFilePointer

public java.io.File getLatestVersionSourceFilePointer(long fileID)
                                               throws FileAccessException,
                                                      FileDoesNotExistException,
                                                      SecurityException
Returns java.io.File object for latest version's source.

Specified by:
getLatestVersionSourceFilePointer in interface Archive
FileAccessException
FileDoesNotExistException
SecurityException

getFileLatestVersion

public long getFileLatestVersion(long fileID,
                                 int requestedEOL)
                          throws FileAccessException,
                                 FileDoesNotExistException,
                                 TextFileException,
                                 SecurityException
Get latest version of file source to temp dir and return temp file ID.

Specified by:
getFileLatestVersion in interface Archive
FileAccessException
FileDoesNotExistException
TextFileException
SecurityException

getFileLatestVersionTLR

public TextLineReader getFileLatestVersionTLR(long fileID)
                                       throws FileAccessException,
                                              FileDoesNotExistException,
                                              TextFileException,
                                              SecurityException
Get latest version of text file source as TextLineReader.

Specified by:
getFileLatestVersionTLR in interface Archive
FileAccessException
FileDoesNotExistException
TextFileException
SecurityException

getFileVersionDelta

public Delta getFileVersionDelta(long versionID)
                          throws FileAccessException,
                                 NoSuchVersionException,
                                 WrongFileTypeException
Get specified delta object for file.

Specified by:
getFileVersionDelta in interface Archive
FileAccessException
NoSuchVersionException
WrongFileTypeException

getFileVersionTextDelta

public Delta getFileVersionTextDelta(long versionID)
                              throws FileAccessException,
                                     NoSuchVersionException,
                                     WrongFileTypeException
Get specified delta object for file.

Specified by:
getFileVersionTextDelta in interface Archive
FileAccessException
NoSuchVersionException
WrongFileTypeException

removeProject

public void removeProject(long parentID,
                          long projectID)
                   throws FileAccessException,
                          ProjectDoesNotExistException,
                          SecurityException
Remove specified project from the project hierarchy.

Specified by:
removeProject in interface Archive
FileAccessException
ProjectDoesNotExistException
SecurityException

removeFile

public void removeFile(long parentID,
                       long fileID)
                throws FileAccessException,
                       ProjectDoesNotExistException,
                       FileDoesNotExistException,
                       SecurityException
Remove specified file from specified project.

Specified by:
removeFile in interface Archive
FileAccessException
ProjectDoesNotExistException
FileDoesNotExistException
SecurityException

rollbackToVersion

public void rollbackToVersion(long fileID,
                              long versionID,
                              java.io.File newLatestVersion)
                       throws FileAccessException,
                              FileDoesNotExistException,
                              NoSuchVersionException,
                              SecurityException,
                              TextFileException
Rollback specified file to specified version number. This method just removes the versions from the cache.

Specified by:
rollbackToVersion in interface Archive
FileAccessException
FileDoesNotExistException
NoSuchVersionException
SecurityException
TextFileException

retrieveVersionDeltaFile

public java.io.File retrieveVersionDeltaFile(org.sourcejammer.project.view.NodeInfo versionNode)
                                      throws FileAccessException,
                                             WrongFileTypeException
Specified by:
retrieveVersionDeltaFile in interface Archive
FileAccessException
WrongFileTypeException

setVersionComment

public void setVersionComment(long fileID,
                              int version,
                              java.lang.String comment)
                       throws FileAccessException,
                              FileDoesNotExistException,
                              NoSuchVersionException,
                              SecurityException
Set the comment of the specified version.

Specified by:
setVersionComment in interface Archive
FileAccessException
FileDoesNotExistException
NoSuchVersionException
SecurityException

getVersionFileSizeInBytes

public long getVersionFileSizeInBytes(long fileID,
                                      int versionNumber)
                               throws FileAccessException,
                                      FileDoesNotExistException,
                                      NoSuchVersionException,
                                      SecurityException
Gets the size of the version file in bytes.

Specified by:
getVersionFileSizeInBytes in interface Archive
FileAccessException
FileDoesNotExistException
NoSuchVersionException
SecurityException

getVersionComment

public java.lang.String getVersionComment(long versionID)
                                   throws FileAccessException,
                                          ProjectDoesNotExistException,
                                          FileDoesNotExistException,
                                          NoSuchVersionException
Get the comment for the specified version.

Specified by:
getVersionComment in interface Archive
FileAccessException
ProjectDoesNotExistException
FileDoesNotExistException
NoSuchVersionException

checkOutFile

public void checkOutFile(long fileID,
                         java.lang.String userName,
                         java.lang.String checkOutLocation)
                  throws FileAccessException,
                         FileDoesNotExistException,
                         CheckOutException,
                         SecurityException
Set status of specified file to checked out. Does not return the file. Does guarantee that no other method will check out the file until it is checked in.

Specified by:
checkOutFile in interface Archive
FileAccessException
FileDoesNotExistException
CheckOutException
SecurityException

checkInFile

public void checkInFile(long fileID)
                 throws FileAccessException,
                        FileDoesNotExistException,
                        CheckInException,
                        SecurityException
Set status of specified file to checked in. Does not add the new file version to model implementation. Does not guarantee that user checking in file is the same user who checked it out. Does guaranted that file will not be checked in if it has already been checked it.

Specified by:
checkInFile in interface Archive
FileAccessException
FileDoesNotExistException
CheckInException
SecurityException

getUniqueIDFromPath

public long getUniqueIDFromPath(long parentID,
                                java.lang.String path)
                         throws FileAccessException,
                                ProjectDoesNotExistException,
                                org.sourcejammer.project.NodeDoesNotExistException,
                                SecurityException
Description copied from interface: Archive
Returns unique id based on a path.

Specified by:
getUniqueIDFromPath in interface Archive
FileAccessException
ProjectDoesNotExistException
org.sourcejammer.project.NodeDoesNotExistException
SecurityException

getFileNode

public FileNode getFileNode(long fileID)
                     throws FileDoesNotExistException,
                            FileAccessException,
                            SecurityException
Allows "master control" to look at file info to verify check out, check in, file type, etc. MCP MUST release the file when done with it.

Specified by:
getFileNode in interface Archive
FileDoesNotExistException
FileAccessException
SecurityException

getFileNode

public FileNode getFileNode(long fileID,
                            boolean readOnly)
                     throws FileDoesNotExistException,
                            FileAccessException,
                            SecurityException
Allows "master control" to look at file info to verify check out, check in, file type, etc. MCP MUST release the file when done with it.

Specified by:
getFileNode in interface Archive
FileDoesNotExistException
FileAccessException
SecurityException

releaseFileNode

public void releaseFileNode(FileNode nd)
                     throws FileAccessException
Release a file node.

Specified by:
releaseFileNode in interface Archive
FileAccessException

childFileCheckedOut

private boolean childFileCheckedOut(long projectID)
                             throws FileAccessException,
                                    ProjectDoesNotExistException,
                                    SecurityException
FileAccessException
ProjectDoesNotExistException
SecurityException

isChildOfProject

private boolean isChildOfProject(long parentProjectID,
                                 long childProjectID)
                          throws FileAccessException,
                                 ProjectDoesNotExistException,
                                 SecurityException
FileAccessException
ProjectDoesNotExistException
SecurityException

restoreRemovedNode

public void restoreRemovedNode(long parentID,
                               int index)
                        throws FileAccessException,
                               ProjectDoesNotExistException,
                               FileDoesNotExistException,
                               org.sourcejammer.project.NodeDoesNotExistException,
                               org.sourcejammer.project.NodeExistsException,
                               SecurityException
Description copied from interface: Archive
Restores a project or file node that was previously removed from the archive.

Specified by:
restoreRemovedNode in interface Archive
Parameters:
index - -- Index value of the removed node in the removed nodes list (see getRemovedNodes()).
FileAccessException
ProjectDoesNotExistException
FileDoesNotExistException
org.sourcejammer.project.NodeDoesNotExistException
org.sourcejammer.project.NodeExistsException
SecurityException

restoreRemovedNode

public void restoreRemovedNode(long parentID,
                               java.lang.String newName,
                               int index)
                        throws FileAccessException,
                               ProjectDoesNotExistException,
                               FileDoesNotExistException,
                               org.sourcejammer.project.NodeDoesNotExistException,
                               org.sourcejammer.project.NodeExistsException,
                               SecurityException
Restores a project or file node that was previously removed from the archive.

Specified by:
restoreRemovedNode in interface Archive
Parameters:
parentID - -- ID of the project from which the node was removed.
newName - -- a new name for the removed node.
index - -- Index value of the removed node in the removed nodes list (see getRemovedNodes()).
FileAccessException
ProjectDoesNotExistException
FileDoesNotExistException
org.sourcejammer.project.NodeDoesNotExistException
org.sourcejammer.project.NodeExistsException
SecurityException

renameFile

public void renameFile(long parentID,
                       long fileID,
                       java.lang.String newName)
                throws FileAccessException,
                       ProjectDoesNotExistException,
                       FileDoesNotExistException,
                       org.sourcejammer.project.NodeExistsException,
                       SecurityException
Specified by:
renameFile in interface Archive
FileAccessException
ProjectDoesNotExistException
FileDoesNotExistException
org.sourcejammer.project.NodeExistsException
SecurityException

renameProject

public void renameProject(long parentID,
                          long projectID,
                          java.lang.String newName)
                   throws FileAccessException,
                          ProjectDoesNotExistException,
                          org.sourcejammer.project.NodeExistsException,
                          SecurityException
Specified by:
renameProject in interface Archive
FileAccessException
ProjectDoesNotExistException
org.sourcejammer.project.NodeExistsException
SecurityException

permanentlyDeleteRemovedNode

public void permanentlyDeleteRemovedNode(long projectID,
                                         int index)
                                  throws FileAccessException,
                                         ProjectDoesNotExistException,
                                         org.sourcejammer.project.NodeDoesNotExistException,
                                         SecurityException
Permanently delete specified removed node.

Specified by:
permanentlyDeleteRemovedNode in interface Archive
FileAccessException
ProjectDoesNotExistException
org.sourcejammer.project.NodeDoesNotExistException
SecurityException

getRemovedNodes

public java.util.Vector getRemovedNodes(long projectID)
                                 throws FileAccessException,
                                        ProjectDoesNotExistException,
                                        SecurityException
Returns a Vector of NodeInfo objects, one for each node that has been removed (but not permanently deleted) from the parent project.

Specified by:
getRemovedNodes in interface Archive
FileAccessException
ProjectDoesNotExistException
SecurityException

makeLabeledVersion

public void makeLabeledVersion(java.lang.String name,
                               java.lang.String description,
                               long parentProjectID,
                               java.lang.String userName)
                        throws org.sourcejammer.project.NodeExistsException,
                               FileAccessException,
                               ProjectDoesNotExistException,
                               NoSuchVersionException,
                               FileDoesNotExistException,
                               FileAlreadyExistsException,
                               TextFileException,
                               SecurityException
Create and save a new labeled version with the passed-in name and description and containing all of the latest versions that are children of parent.

Specified by:
makeLabeledVersion in interface Archive
org.sourcejammer.project.NodeExistsException
FileAccessException
ProjectDoesNotExistException
NoSuchVersionException
FileDoesNotExistException
FileAlreadyExistsException
TextFileException
SecurityException

makeLabelInFile

private java.io.File makeLabelInFile(java.lang.String name,
                                     java.lang.String description,
                                     java.util.Date createDate,
                                     long parentProjectID,
                                     long existingLabelID)
                              throws FileDoesNotExistException,
                                     ProjectDoesNotExistException,
                                     FileAccessException,
                                     SecurityException,
                                     NoSuchVersionException
FileDoesNotExistException
ProjectDoesNotExistException
FileAccessException
SecurityException
NoSuchVersionException

rebuildLabel

public void rebuildLabel(long labelID,
                         java.lang.String description,
                         long parentProjectID,
                         java.lang.String userName)
                  throws org.sourcejammer.project.NodeExistsException,
                         FileAccessException,
                         org.sourcejammer.project.NodeDoesNotExistException,
                         ProjectDoesNotExistException,
                         NoSuchVersionException,
                         FileDoesNotExistException,
                         FileAlreadyExistsException,
                         TextFileException,
                         SecurityException,
                         WrongFileTypeException,
                         EndOfSourceException,
                         InvalidSourceException
Specified by:
rebuildLabel in interface Archive
org.sourcejammer.project.NodeExistsException
FileAccessException
org.sourcejammer.project.NodeDoesNotExistException
ProjectDoesNotExistException
NoSuchVersionException
FileDoesNotExistException
FileAlreadyExistsException
TextFileException
SecurityException
WrongFileTypeException
EndOfSourceException
InvalidSourceException

getLabelList

public org.sourcejammer.project.NodeList getLabelList()
Deprecated.  

Returns NodeList of all LabelInfo objects in this archive.

Specified by:
getLabelList in interface Archive

getChangeList

public long getChangeList(long labelID,
                          int verNewer,
                          int verOlder,
                          int eolType)
                   throws org.sourcejammer.project.NodeDoesNotExistException,
                          FileAccessException,
                          FileDoesNotExistException,
                          SecurityException,
                          EndOfSourceException,
                          InvalidSourceException,
                          WrongFileTypeException,
                          NoSuchVersionException,
                          TextFileException,
                          ProjectDoesNotExistException
Generated change list for specified label and saves it as a temp file. Returns id of temp file.

Specified by:
getChangeList in interface Archive
org.sourcejammer.project.NodeDoesNotExistException
FileAccessException
FileDoesNotExistException
SecurityException
EndOfSourceException
InvalidSourceException
WrongFileTypeException
NoSuchVersionException
TextFileException
ProjectDoesNotExistException

getLabelContentList

public Label getLabelContentList(long labelID,
                                 int versionNumber)
                          throws org.sourcejammer.project.NodeDoesNotExistException,
                                 FileAccessException,
                                 FileDoesNotExistException,
                                 SecurityException,
                                 EndOfSourceException,
                                 InvalidSourceException,
                                 WrongFileTypeException,
                                 NoSuchVersionException,
                                 TextFileException,
                                 ProjectDoesNotExistException
Returns the Label object (which contains the sourcejammer path and version number for each object in the labeled version) with the specified name.

Specified by:
getLabelContentList in interface Archive
org.sourcejammer.project.NodeDoesNotExistException
FileAccessException
FileDoesNotExistException
SecurityException
EndOfSourceException
InvalidSourceException
WrongFileTypeException
NoSuchVersionException
TextFileException
ProjectDoesNotExistException

projectNodeToProject

protected org.sourcejammer.project.view.Project projectNodeToProject(ProjectNode ndProject)
                                                              throws SecurityException,
                                                                     ProjectDoesNotExistException,
                                                                     FileAccessException,
                                                                     FileDoesNotExistException,
                                                                     org.sourcejammer.project.NodeExistsException
SecurityException
ProjectDoesNotExistException
FileAccessException
FileDoesNotExistException
org.sourcejammer.project.NodeExistsException

buildLabel

protected Label buildLabel(Label label,
                           long parentProjectID,
                           java.lang.String baseSJPath,
                           long skipFile)
                    throws NoSuchVersionException,
                           SecurityException,
                           FileAccessException,
                           ProjectDoesNotExistException,
                           FileDoesNotExistException
This method recursively calls itself until it has put all of the latest versions of all the file nodes in parent (and in all ProjectNode children of parent) into label.

NoSuchVersionException
SecurityException
FileAccessException
ProjectDoesNotExistException
FileDoesNotExistException

controllerNodeToNodeInfo

protected org.sourcejammer.project.view.NodeInfo controllerNodeToNodeInfo(ControllerNode nd)
                                                                   throws NoSuchVersionException
Builds new NodeInfo object from ControllerNode.

NoSuchVersionException


Copyright 2003 Soucejammer project.