org.omegat.core.team2.impl

Class FileRepository

java.lang.Object

org.omegat.core.team2.impl.FileRepository

All Implemented Interfaces:

IRemoteRepository2

public class FileRepository
extends java.lang.Object
implements IRemoteRepository2

Simple file repository implementation. The "remote" files are read-only, there is no "commit" to avoid clobbering remote files.

Nested Class Summary

Nested classes/interfaces inherited from interface org.omegat.core.team2.IRemoteRepository2

IRemoteRepository2.BadRepositoryException, IRemoteRepository2.NetworkException

Constructor Summary

Constructors

Constructor and Description
FileRepository()

Method Summary

Modifier and Type	Method and Description
void	addForCommit(java.lang.String path) Add the specified file in preparation for commit (e.g.
void	addForDeletion(java.lang.String path) remove the specified file in preparation for commit (e.g.
java.lang.String	commit(java.lang.String[] onVersions, java.lang.String comment) Commit to repository after specified version, or after any version if 'null' specified.
java.lang.String	getFileVersion(java.lang.String file) Get file version.
java.io.File	getLocalDirectory() Return directory where this repo is in.
java.lang.String[]	getRecentlyDeletedFiles() Returns a list of files or directories (empty or not) that have been deleted since the last call to this function, relative to the repository root that has been checked out.
void	init(RepositoryDefinition repo, java.io.File dir, ProjectTeamSettings teamSettings) Initialize repository provider.
void	switchToVersion(java.lang.String version)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileRepository

public FileRepository()

Method Detail

init

public void init(RepositoryDefinition repo,
                 java.io.File dir,
                 ProjectTeamSettings teamSettings)
          throws java.lang.Exception

Description copied from interface: IRemoteRepository2

Initialize repository provider.

Specified by:

init in interface IRemoteRepository2

Parameters:

repo - repository description instance

dir - directory for store files

teamSettings - team settings object for project

Throws:

java.lang.Exception

getFileVersion

public java.lang.String getFileVersion(java.lang.String file)
                                throws java.lang.Exception

Description copied from interface: IRemoteRepository2

Get file version.

Specified by:

getFileVersion in interface IRemoteRepository2

Throws:

java.lang.Exception

switchToVersion

public void switchToVersion(java.lang.String version)
                     throws java.lang.Exception

Specified by:

switchToVersion in interface IRemoteRepository2

Throws:

java.lang.Exception

addForCommit

public void addForCommit(java.lang.String path)
                  throws java.lang.Exception

Description copied from interface: IRemoteRepository2

Add the specified file in preparation for commit (e.g. git add, svn add).

Specified by:

addForCommit in interface IRemoteRepository2

Parameters:

path - The relative path of the item from the root of the repo (should not start with a /)

Throws:

java.lang.Exception

addForDeletion

public void addForDeletion(java.lang.String path)
                    throws java.lang.Exception

Description copied from interface: IRemoteRepository2

remove the specified file in preparation for commit (e.g. git rm, svn delete).

Specified by:

addForDeletion in interface IRemoteRepository2

Parameters:

path - The relative path of the item from the root of the repo (should not start with a /)

Throws:

java.lang.Exception

getLocalDirectory

public java.io.File getLocalDirectory()

Description copied from interface: IRemoteRepository2

Return directory where this repo is in.

Specified by:

getLocalDirectory in interface IRemoteRepository2

Returns:

The directory, e.g. /path/to/omegatdir/.repositories/https_site.com_myproject.git

getRecentlyDeletedFiles

public java.lang.String[] getRecentlyDeletedFiles()
                                           throws java.lang.Exception

Description copied from interface: IRemoteRepository2

Returns a list of files or directories (empty or not) that have been deleted since the last call to this function, relative to the repository root that has been checked out. If this function is called for the first time, it returns the empty list.

Specified by:

getRecentlyDeletedFiles in interface IRemoteRepository2

Returns:

Throws:

java.lang.Exception

commit

public java.lang.String commit(java.lang.String[] onVersions,
                               java.lang.String comment)
                        throws java.lang.Exception

Description copied from interface: IRemoteRepository2

Commit to repository after specified version, or after any version if 'null' specified.

Specified by:

commit in interface IRemoteRepository2

Parameters:

onVersions - if version defined, then commit must be just after this version. Otherwise(if remote repository was updated after rebase), commit shouldn't be processed and should return null. If version is null, then commit can be after any version, i.e. previous version shouldn't be checked. It can be several versions defined since glossary will be committed after project_save.tmx.

comment - comment for commit

Returns:

new version if commit was processed, or null if remote repository was updated by other user

Throws:

java.lang.Exception