org.omegat.core.data

Class RealProject

java.lang.Object

org.omegat.core.data.RealProject

All Implemented Interfaces:

IProject

public class RealProject
extends java.lang.Object
implements IProject

Loaded project implementation. Only translation could be changed after project will be loaded and set by Core.setProject. All components can read all data directly without synchronization. All synchronization implemented inside RealProject. Since team sync is long operation, auto-saving was split into 3 phrases: get remote data in background, then rebase during segment deactivation, then commit in background.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	RealProject.LoadFilesCallback

Nested classes/interfaces inherited from interface org.omegat.core.data.IProject

IProject.AllTranslations, IProject.DefaultTranslationsIterator, IProject.FileInfo, IProject.MultipleTranslationsIterator, IProject.OptimisticLockingFail

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<SourceTextEntry>	allProjectEntries List of all segments in project.
protected ProjectProperties	config
protected ImportFromAutoTMX	importHandler
protected java.util.List<IProject.FileInfo>	projectFilesList Segments count in project files.
protected ProjectTMX	projectTMX
protected RemoteRepositoryProvider	remoteRepositoryProvider

Constructor Summary

Constructors

Constructor and Description
RealProject(ProjectProperties props) Create new project instance.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,TMXEntry>	align(ProjectProperties props, java.io.File translatedDir) Align project.
void	closeProject() Signals to the core thread that a project is being closed now, and if it's still being loaded, core thread shouldn't throw any error.
void	commitSourceFiles() Commit source files in a team project.
void	compileProject(java.lang.String sourcePattern) Builds translated files corresponding to sourcePattern and creates fresh TM files.
void	compileProject(java.lang.String sourcePattern, boolean doPostProcessing) Builds translated files corresponding to sourcePattern and creates fresh TM files.
void	compileProjectAndCommit(java.lang.String sourcePattern, boolean doPostProcessing, boolean commitTargetFiles) Builds translated files corresponding to sourcePattern and creates fresh TM files.
void	createProject() Create new project.
protected ITokenizer	createTokenizer(java.lang.String cmdLine, java.lang.Class<?> projectPref) Create tokenizer class.
protected void	findNonUniqueSegments()
java.util.List<SourceTextEntry>	getAllEntries() Get all source segments.
IProject.AllTranslations	getAllTranslations(SourceTextEntry ste) Get default and alternative translations for optimistic locking.
java.util.Map<Language,ProjectTMX>	getOtherTargetLanguageTMs() Get all translation memories from /other_lang/ folder.
java.util.List<IProject.FileInfo>	getProjectFiles() Get info about each source file in project.
ProjectProperties	getProjectProperties() Returns the active Project's Properties.
java.util.List<java.lang.String>	getSourceFilesOrder() Get ordered list of source file names.
ITokenizer	getSourceTokenizer() Returns tokenizer for source language.
StatisticsInfo	getStatistics() Get statistics for project.
java.lang.String	getTargetPathForSourceFile(java.lang.String currentSource) For a given source file, calculate the path of the target file that would be created by running Create Translated Documents (the file may not exist yet).
ITokenizer	getTargetTokenizer() Returns tokenizer for target language.
TMXEntry	getTranslationInfo(SourceTextEntry ste) Get translation info for specified entry.
java.util.Map<java.lang.String,ExternalTMX>	getTransMemories() Get all translation memories from /tm/ folder.
boolean	isOrphaned(EntryKey entry) Check if orphaned.
boolean	isOrphaned(java.lang.String source) Check if orphaned.
boolean	isProjectLoaded() Get project loaded status.
boolean	isProjectModified() Returns whether the project was modified.
boolean	isRemoteProject() Tells whether a project is a team project
boolean	isTeamSyncPrepared() Check if team synchronization prepared.
void	iterateByDefaultTranslations(IProject.DefaultTranslationsIterator it) Iterate by all default translations in project.
void	iterateByMultipleTranslations(IProject.MultipleTranslationsIterator it) Iterate by all multiple translations in project.
void	loadProject(boolean onlineMode) Load exist project in a "big" sense -- loads project's properties, glossaries, tms, source files etc.
protected boolean	lockProject() Lock omegat.project file against rename or move project.
protected void	mergeTMX(ProjectTMX baseTMX, ProjectTMX headTMX, java.lang.StringBuilder commitDetails) Do 3-way merge of: Base: baseTMX File 1: projectTMX (mine) File 2: headTMX (theirs)
protected java.lang.String	patchFileNameForEntryKey(java.lang.String filename) This method converts directory separators into Unix-style.
void	saveProject(boolean doTeamSync) Saves the translation memory and preferences.
void	saveProjectProperties() Save project properties only.
void	setNote(SourceTextEntry entry, TMXEntry oldTE, java.lang.String note) Change note only for translation.
void	setSourceFilesOrder(java.util.List<java.lang.String> filesList) Set ordered list of source file names.
void	setTranslation(SourceTextEntry entry, PrepareTMXEntry trans, boolean defaultTranslation, TMXEntry.ExternalLinked externalLinked) Set translation for entry.
void	setTranslation(SourceTextEntry entry, PrepareTMXEntry trans, boolean defaultTranslation, TMXEntry.ExternalLinked externalLinked, IProject.AllTranslations previous) Set translation for entry with optimistic lock checking: if previous translation is not the same like in storage, OptimisticLockingFail exception will be generated.
void	teamSync() Fast team sync for execute from SaveThread.
void	teamSyncPrepare() Prepare for future team sync.
protected void	unlockProject() Unlock omegat.project file against rename or move project.

Methods inherited from class java.lang.Object

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

Field Detail

config

protected final ProjectProperties config

remoteRepositoryProvider

protected final RemoteRepositoryProvider remoteRepositoryProvider

allProjectEntries

protected java.util.List<SourceTextEntry> allProjectEntries

List of all segments in project.

importHandler

protected ImportFromAutoTMX importHandler

projectTMX

protected ProjectTMX projectTMX

projectFilesList

protected java.util.List<IProject.FileInfo> projectFilesList

Segments count in project files.

Constructor Detail

RealProject

public RealProject(ProjectProperties props)

Create new project instance. It required to call createProject() or loadProject(boolean) methods just after constructor before use project.

Parameters:

props - project properties

Method Detail

saveProjectProperties

public void saveProjectProperties()
                           throws java.lang.Exception

Description copied from interface: IProject

Save project properties only.

Specified by:

saveProjectProperties in interface IProject

Throws:

java.lang.Exception

createProject

public void createProject()

Create new project.

loadProject

public void loadProject(boolean onlineMode)

Load exist project in a "big" sense -- loads project's properties, glossaries, tms, source files etc.

align

public java.util.Map<java.lang.String,TMXEntry> align(ProjectProperties props,
                                                      java.io.File translatedDir)
                                               throws java.lang.Exception

Align project.

Throws:

java.lang.Exception

isProjectLoaded

public boolean isProjectLoaded()

Get project loaded status.

Specified by:

isProjectLoaded in interface IProject

Returns:

true if project loaded

getStatistics

public StatisticsInfo getStatistics()

Get statistics for project.

Specified by:

getStatistics in interface IProject

Returns:

closeProject

public void closeProject()

Signals to the core thread that a project is being closed now, and if it's still being loaded, core thread shouldn't throw any error.

Specified by:

closeProject in interface IProject

lockProject

protected boolean lockProject()

Lock omegat.project file against rename or move project.

unlockProject

protected void unlockProject()

Unlock omegat.project file against rename or move project.

compileProject

public void compileProject(java.lang.String sourcePattern)
                    throws java.lang.Exception

Builds translated files corresponding to sourcePattern and creates fresh TM files. Convenience method. Assumes we want to run external post-processing commands.

Specified by:

compileProject in interface IProject

Parameters:

sourcePattern - The regexp of files to create

Throws:

java.lang.Exception

compileProject

public void compileProject(java.lang.String sourcePattern,
                           boolean doPostProcessing)
                    throws java.lang.Exception

Builds translated files corresponding to sourcePattern and creates fresh TM files. Calls the actual compile project method, assumes we don't want to commit target files.

Parameters:

sourcePattern - The regexp of files to create

doPostProcessing - Whether or not we should perform external post-processing.

Throws:

java.lang.Exception

compileProjectAndCommit

public void compileProjectAndCommit(java.lang.String sourcePattern,
                                    boolean doPostProcessing,
                                    boolean commitTargetFiles)
                             throws java.lang.Exception

Builds translated files corresponding to sourcePattern and creates fresh TM files.

Specified by:

compileProjectAndCommit in interface IProject

Parameters:

sourcePattern - The regexp of files to create

doPostProcessing - Whether or not we should perform external post-processing.

commitTargetFiles - Whether or not we should commit target files

Throws:

java.lang.Exception

saveProject

public void saveProject(boolean doTeamSync)

Saves the translation memory and preferences. This method must be executed in the Core.executeExclusively.

Specified by:

saveProject in interface IProject

teamSyncPrepare

public void teamSyncPrepare()
                     throws java.lang.Exception

Prepare for future team sync. This method must be executed in the Core.executeExclusively.

Specified by:

teamSyncPrepare in interface IProject

Throws:

java.lang.Exception

isTeamSyncPrepared

public boolean isTeamSyncPrepared()

Description copied from interface: IProject

Check if team synchronization prepared.

Specified by:

isTeamSyncPrepared in interface IProject

teamSync

public void teamSync()

Fast team sync for execute from SaveThread. This method must be executed in the Core.executeExclusively.

Specified by:

teamSync in interface IProject

mergeTMX

protected void mergeTMX(ProjectTMX baseTMX,
                        ProjectTMX headTMX,
                        java.lang.StringBuilder commitDetails)

Do 3-way merge of: Base: baseTMX File 1: projectTMX (mine) File 2: headTMX (theirs)

findNonUniqueSegments

protected void findNonUniqueSegments()

getAllEntries

public java.util.List<SourceTextEntry> getAllEntries()

Get all source segments. It's unmodifiable list, so, there is no need synchronization to read it.

Specified by:

getAllEntries in interface IProject

getTranslationInfo

public TMXEntry getTranslationInfo(SourceTextEntry ste)

Description copied from interface: IProject

Get translation info for specified entry. It looks first for multiple, then for default. This method ALWAYS returns TMXEntry, because note can exist even for non-translated segment. Use TMXEntry.isTranslated() for check if translation text really exist. Translation can be checked for default/alternative by the TMXEntry.defaultTranslation.

Specified by:

getTranslationInfo in interface IProject

Parameters:

ste - source entry

Returns:

translation

getAllTranslations

public IProject.AllTranslations getAllTranslations(SourceTextEntry ste)

Description copied from interface: IProject

Get default and alternative translations for optimistic locking.

Specified by:

getAllTranslations in interface IProject

getProjectProperties

public ProjectProperties getProjectProperties()

Returns the active Project's Properties.

Specified by:

getProjectProperties in interface IProject

Returns:

project properties

isProjectModified

public boolean isProjectModified()

Returns whether the project was modified. I.e. translations were changed since last save.

Specified by:

isProjectModified in interface IProject

setTranslation

public void setTranslation(SourceTextEntry entry,
                           PrepareTMXEntry trans,
                           boolean defaultTranslation,
                           TMXEntry.ExternalLinked externalLinked,
                           IProject.AllTranslations previous)
                    throws IProject.OptimisticLockingFail

Description copied from interface: IProject

Set translation for entry with optimistic lock checking: if previous translation is not the same like in storage, OptimisticLockingFail exception will be generated. Use when user has typed a new translation.

Specified by:

setTranslation in interface IProject

Parameters:

entry - entry

trans - translation. It can't be null

Throws:

IProject.OptimisticLockingFail

setTranslation

public void setTranslation(SourceTextEntry entry,
                           PrepareTMXEntry trans,
                           boolean defaultTranslation,
                           TMXEntry.ExternalLinked externalLinked)

Description copied from interface: IProject

Set translation for entry. Optimistic locking will not be checked.

Specified by:

setTranslation in interface IProject

Parameters:

entry - entry

trans - translation. It can't be null

setNote

public void setNote(SourceTextEntry entry,
                    TMXEntry oldTE,
                    java.lang.String note)

Description copied from interface: IProject

Change note only for translation.

Specified by:

setNote in interface IProject

Parameters:

entry - entry

oldTE - old translation

note - note text

iterateByDefaultTranslations

public void iterateByDefaultTranslations(IProject.DefaultTranslationsIterator it)

Description copied from interface: IProject

Iterate by all default translations in project.

Specified by:

iterateByDefaultTranslations in interface IProject

iterateByMultipleTranslations

public void iterateByMultipleTranslations(IProject.MultipleTranslationsIterator it)

Description copied from interface: IProject

Iterate by all multiple translations in project.

Specified by:

iterateByMultipleTranslations in interface IProject

isOrphaned

public boolean isOrphaned(java.lang.String source)

Description copied from interface: IProject

Check if orphaned.

Specified by:

isOrphaned in interface IProject

isOrphaned

public boolean isOrphaned(EntryKey entry)

Description copied from interface: IProject

Check if orphaned.

Specified by:

isOrphaned in interface IProject

getTransMemories

public java.util.Map<java.lang.String,ExternalTMX> getTransMemories()

Description copied from interface: IProject

Get all translation memories from /tm/ folder.

Specified by:

getTransMemories in interface IProject

Returns:

translation memories

getOtherTargetLanguageTMs

public java.util.Map<Language,ProjectTMX> getOtherTargetLanguageTMs()

Description copied from interface: IProject

Get all translation memories from /other_lang/ folder.

Specified by:

getOtherTargetLanguageTMs in interface IProject

Returns:

translation memories

getSourceTokenizer

public ITokenizer getSourceTokenizer()

Returns tokenizer for source language.

Specified by:

getSourceTokenizer in interface IProject

getTargetTokenizer

public ITokenizer getTargetTokenizer()

Returns tokenizer for target language.

Specified by:

getTargetTokenizer in interface IProject

createTokenizer

protected ITokenizer createTokenizer(java.lang.String cmdLine,
                                     java.lang.Class<?> projectPref)

Create tokenizer class. Classes are prioritized:

1. Class specified on command line via --ITokenizer and --ITokenizerTarget
2. Class specified in project settings
3. DefaultTokenizer

Parameters:

cmdLine - Tokenizer class specified on command line

Returns:

Tokenizer implementation

getProjectFiles

public java.util.List<IProject.FileInfo> getProjectFiles()

Get info about each source file in project. It's unmodifiable list, so, there is no need synchronization to read it.

Specified by:

getProjectFiles in interface IProject

getTargetPathForSourceFile

public java.lang.String getTargetPathForSourceFile(java.lang.String currentSource)

Description copied from interface: IProject

For a given source file, calculate the path of the target file that would be created by running Create Translated Documents (the file may not exist yet).

The target path must be calculated because it can depend on project properties such as the target language, etc.

Specified by:

getTargetPathForSourceFile in interface IProject

Parameters:

currentSource - The relative path (under the source directory) of the source file, e.g. Bundle.properties

Returns:

The relative path (under the target directory) of the corresponding target file, e.g. Bundle_fr_FR.properties

getSourceFilesOrder

public java.util.List<java.lang.String> getSourceFilesOrder()

Description copied from interface: IProject

Get ordered list of source file names.

Specified by:

getSourceFilesOrder in interface IProject

setSourceFilesOrder

public void setSourceFilesOrder(java.util.List<java.lang.String> filesList)

Description copied from interface: IProject

Set ordered list of source file names.

Specified by:

setSourceFilesOrder in interface IProject

patchFileNameForEntryKey

protected java.lang.String patchFileNameForEntryKey(java.lang.String filename)

This method converts directory separators into Unix-style. It required to have the same filenames in the alternative translation in Windows and Unix boxes.

Also it can use --alternate-filename-from and --alternate-filename-to command line parameters for change filename in entry key. It allows to have many versions of one file in one project.

Because the filename can be stored in the project TMX, it also removes any XML-unsafe chars.

Parameters:

filename - filesystem's filename

Returns:

normalized filename

isRemoteProject

public boolean isRemoteProject()

Description copied from interface: IProject

Tells whether a project is a team project

Specified by:

isRemoteProject in interface IProject

Returns:

whether the project is a team project

commitSourceFiles

public void commitSourceFiles()
                       throws java.lang.Exception

Description copied from interface: IProject

Commit source files in a team project.

Specified by:

commitSourceFiles in interface IProject

Throws:

java.lang.Exception