Package org.omegat.core.data

Interface IProject

  • All Known Implementing Classes:
    NotLoadedProject, RealProject
    public interface IProject
    Interface for access to loaded project. Each loaded project will be new instance of IProject.

    • Method Detail

      • saveProjectProperties

        void saveProjectProperties()
                    throws java.lang.Exception
        Save project properties only.
        Throws:
        java.lang.Exception

      • saveProject

        void saveProject​(boolean doTeamSync)
        Save project.

      • teamSyncPrepare

        void teamSyncPrepare()
              throws java.lang.Exception
        Prepare for team synchronization from save thread.
        Throws:
        java.lang.Exception

      • isTeamSyncPrepared

        boolean isTeamSyncPrepared()
        Check if team synchronization prepared.

      • teamSync

        void teamSync()
        Execute synchronization.

      • closeProject

        void closeProject()
        Close project.

      • compileProject

        void compileProject​(java.lang.String sourcePattern)
             throws java.lang.Exception
        Create translated documents.
        Throws:
        java.lang.Exception

      • compileProjectAndCommit

        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.
        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

      • isRemoteProject

        boolean isRemoteProject()
        Tells whether a project is a team project
        Returns:
        whether the project is a team project

      • commitSourceFiles

        void commitSourceFiles()
                throws java.lang.Exception
        Commit source files in a team project.
        Throws:
        java.lang.Exception

      • getProjectProperties

        ProjectProperties getProjectProperties()
        Get project properties.
        Returns:
        project properties

      • isProjectLoaded

        boolean isProjectLoaded()
        Get project loaded status.
        Returns:
        true if project loaded

      • isProjectModified

        boolean isProjectModified()
        Is project modified ?

      • getSourceTokenizer

        ITokenizer getSourceTokenizer()
        Returns tokenizer for source language.

      • getTargetTokenizer

        ITokenizer getTargetTokenizer()
        Returns tokenizer for target language.

      • getAllEntries

        java.util.List<SourceTextEntry> getAllEntries()
        Get all source segments. It's unmodifiable list, so, there is no need synchronization to read it.

      • setTranslation

        void setTranslation​(SourceTextEntry entry,
                    PrepareTMXEntry trans,
                    boolean defaultTranslation,
                    TMXEntry.ExternalLinked externalLinked)
        Set translation for entry. Optimistic locking will not be checked.
        Parameters:
        entry - entry
        trans - translation. It can't be null

      • setNote

        void setNote​(SourceTextEntry entry,
             TMXEntry oldTrans,
             java.lang.String note)
        Change note only for translation.
        Parameters:
        entry - entry
        oldTrans - old translation
        note - note text

      • getStatistics

        StatisticsInfo getStatistics()
        Get statistics for project.
        Returns:

      • getTranslationInfo

        TMXEntry getTranslationInfo​(SourceTextEntry ste)
        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.
        Parameters:
        ste - source entry
        Returns:
        translation

      • isOrphaned

        boolean isOrphaned​(java.lang.String source)
        Check if orphaned.

      • isOrphaned

        boolean isOrphaned​(EntryKey entry)
        Check if orphaned.

      • getTransMemories

        java.util.Map<java.lang.String,​ExternalTMX> getTransMemories()
        Get all translation memories from /tm/ folder.
        Returns:
        translation memories

      • getOtherTargetLanguageTMs

        java.util.Map<Language,​ProjectTMX> getOtherTargetLanguageTMs()
        Get all translation memories from /other_lang/ folder.
        Returns:
        translation memories

      • getProjectFiles

        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.

      • getTargetPathForSourceFile

        java.lang.String getTargetPathForSourceFile​(java.lang.String sourceFile)
        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.

        Parameters:
        sourceFile - 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

        java.util.List<java.lang.String> getSourceFilesOrder()
        Get ordered list of source file names.

      • setSourceFilesOrder

        void setSourceFilesOrder​(java.util.List<java.lang.String> filesList)
        Set ordered list of source file names.