Package com.e1c.langtool.generatestring

Class ProjectGenerateTranslationStrings

java.lang.Object

com.e1c.langtool.generatestring.ProjectGenerateTranslationStrings

All Implemented Interfaces:

TranslationStringsGenerator

Direct Known Subclasses:

ProjectObjectsGenerateTranslationStrings, TranslatedProjectImportTranslationStrings

public class ProjectGenerateTranslationStrings
extends Object
implements TranslationStringsGenerator

Field Summary

Fields

Modifier and Type	Field	Description
protected IFeatureValueCollectingService	collectingService
protected Map<String,? extends Object>	filterParameters
protected ITranslationStorageManager	storageManager

Constructor Summary

Constructors

Constructor	Description
ProjectGenerateTranslationStrings()

Method Summary

Modifier and Type	Method	Description
void	addLanguage(TranslateLanguage language)	Adds the language to collect and to save.
void	addOrUpdateValue(FeatureValue value)	Adds the or update value.
boolean	canProcess()	checks if can process collecting and saving translation strings..
boolean	checkSettings()	Check settings.
void	collectAndSaveStrings(org.eclipse.core.runtime.IProgressMonitor monitor)	Collect and save strings.
protected boolean	collectStrings(TranslationSource object, org.eclipse.core.runtime.IProgressMonitor monitor)	Collects strings and return true if do that successful.
boolean	collectStrings(org.eclipse.core.runtime.IProgressMonitor monitor)	Collect translation strings.
protected ICollectingParameters	createCollectingParameters()
void	disableCache()
void	dispose()	Dispose and free held resources.
void	enableCache()
protected boolean	fillUpCollectedValues(org.eclipse.core.runtime.IProgressMonitor monitor)
TempFileFeatureCollection	getCollectedValues()	Gets the collected values.
ICollectingParameters.CollectModelType	getCollectModelType()	Checks if should to collect computed strings.
Collection<Exception>	getErrors()	Gets the errors that found during collecting features.
FillUpType	getFillUpType()	Gets the fill up type.
List<TranslateLanguage>	getLanguages()	Return the languages that should be collected and saved.
org.eclipse.core.resources.IProject	getProject()	Gets the project of collection.
StorageID	getStorageId()	Gets the storage id.
ITranslatingProject	getTranslatingProject()	Gets the translating project.
String	getTranslationProviderId()	Gets the translation provider id.
boolean	isCheckTranslationsInAnyAvailableStorage()	Checks if the translations need to check exists in any available storage.
boolean	isCollectInterfaceStrings()	Checks if should to collect interface strings.
boolean	isCollectModelStrings()	Checks if should to collect model strings.
boolean	isContinueAfterFirstError()	Checks if the collecting process should continue after first error.
void	removeLanguage(TranslateLanguage language)	Removes the language from collecting languages.
void	saveCollectedStrings(org.eclipse.core.runtime.IProgressMonitor monitor)	Save collected strings.
void	setCheckTranslationsInAnyAvailableStorage(boolean checkTranslationsInAnyAvailableStorage)	Sets the check translations in any available storage.
void	setCollectInterfaceStrings(boolean collectInterfaceStrings)	Sets to collect interface strings.
void	setCollectModelStrings(boolean collectModelStrings)	Sets to collect model strings.
void	setCollectModelType(ICollectingParameters.CollectModelType collectModelType)	Sets to collect computed strings.
void	setContinueAfterFirstError(boolean isContinue)	Sets whether to continue collect after first error.
void	setFillUpType(FillUpType fillUpType)	Sets the fill up type.
void	setFilterParameters(Map<String,? extends Object> filterParameters)	Sets the filter parameters.
void	setLanguages(List<TranslateLanguage> languages)	Sets the languages to collect and to save.
void	setStorageId(StorageID storageId)	Sets the storage id.
void	setTranslatingProject(ITranslatingProject translatingProject)	Sets the translating project.
void	setTranslationProviderId(String providerId)	Sets the translation provider id.

Methods inherited from class java.lang.Object

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

Field Details

storageManager

@Inject
protected ITranslationStorageManager storageManager

collectingService

@Inject
protected IFeatureValueCollectingService collectingService

filterParameters

protected Map<String,? extends Object> filterParameters

Constructor Details

ProjectGenerateTranslationStrings

public ProjectGenerateTranslationStrings()

Method Details

getLanguages

public List<TranslateLanguage> getLanguages()

Return the languages that should be collected and saved.

Specified by:

getLanguages in interface TranslationStringsGenerator

Returns:

the languages

setLanguages

public void setLanguages(List<TranslateLanguage> languages)

Sets the languages to collect and to save.

Specified by:

setLanguages in interface TranslationStringsGenerator

Parameters:

languages - the new languages

addLanguage

public void addLanguage(TranslateLanguage language)

Adds the language to collect and to save.

Specified by:

addLanguage in interface TranslationStringsGenerator

Parameters:

language - the language

removeLanguage

public void removeLanguage(TranslateLanguage language)

Removes the language from collecting languages.

Specified by:

removeLanguage in interface TranslationStringsGenerator

Parameters:

language - the language

getProject

public org.eclipse.core.resources.IProject getProject()

Gets the project of collection.

Specified by:

getProject in interface TranslationStringsGenerator

Returns:

the project

isCollectModelStrings

public boolean isCollectModelStrings()

Checks if should to collect model strings.

Specified by:

isCollectModelStrings in interface TranslationStringsGenerator

Returns:

true, if should collect model strings

setCollectModelStrings

public void setCollectModelStrings(boolean collectModelStrings)

Sets to collect model strings.

Specified by:

setCollectModelStrings in interface TranslationStringsGenerator

Parameters:

collectModelStrings - the new collect model strings

isCollectInterfaceStrings

public boolean isCollectInterfaceStrings()

Checks if should to collect interface strings.

Specified by:

isCollectInterfaceStrings in interface TranslationStringsGenerator

Returns:

true, if should collect interface strings

setCollectInterfaceStrings

public void setCollectInterfaceStrings(boolean collectInterfaceStrings)

Sets to collect interface strings.

Specified by:

setCollectInterfaceStrings in interface TranslationStringsGenerator

Parameters:

collectInterfaceStrings - the new collect interface strings

getCollectModelType

public ICollectingParameters.CollectModelType getCollectModelType()

Checks if should to collect computed strings.

Specified by:

getCollectModelType in interface TranslationStringsGenerator

Returns:

true, if should collect computed strings

setCollectModelType

public void setCollectModelType(ICollectingParameters.CollectModelType collectModelType)

Sets to collect computed strings.

Specified by:

setCollectModelType in interface TranslationStringsGenerator

Parameters:

collectComputedStrings - the new collect computed strings

getStorageId

public StorageID getStorageId()

Gets the storage id.

Specified by:

getStorageId in interface TranslationStringsGenerator

Returns:

the storage id

setStorageId

public void setStorageId(StorageID storageId)

Sets the storage id.

Specified by:

setStorageId in interface TranslationStringsGenerator

Parameters:

storageId - the new storage id

getFillUpType

public FillUpType getFillUpType()

Gets the fill up type. Default is FillUpType.NOT_FILLUP not fill up.

Specified by:

getFillUpType in interface TranslationStringsGenerator

Returns:

the fillUpType

setFillUpType

public void setFillUpType(FillUpType fillUpType)

Sets the fill up type.

Specified by:

setFillUpType in interface TranslationStringsGenerator

Parameters:

fillUpType - the new fill up type

isCheckTranslationsInAnyAvailableStorage

public boolean isCheckTranslationsInAnyAvailableStorage()

Description copied from interface: TranslationStringsGenerator

Checks if the translations need to check exists in any available storage.

Specified by:

isCheckTranslationsInAnyAvailableStorage in interface TranslationStringsGenerator

Returns:

true, if it need to check translations in any available storage

setCheckTranslationsInAnyAvailableStorage

public void setCheckTranslationsInAnyAvailableStorage(boolean checkTranslationsInAnyAvailableStorage)

Description copied from interface: TranslationStringsGenerator

Sets the check translations in any available storage.

Specified by:

setCheckTranslationsInAnyAvailableStorage in interface TranslationStringsGenerator

Parameters:

checkTranslationsInAnyAvailableStorage - the new check translations in any available storage

setTranslationProviderId

public void setTranslationProviderId(String providerId)

Sets the translation provider id.

Specified by:

setTranslationProviderId in interface TranslationStringsGenerator

Parameters:

providerId - the new translation provider id

getTranslationProviderId

public String getTranslationProviderId()

Gets the translation provider id.

Specified by:

getTranslationProviderId in interface TranslationStringsGenerator

Returns:

the translation provider id

getTranslatingProject

public ITranslatingProject getTranslatingProject()

Gets the translating project.

Specified by:

getTranslatingProject in interface TranslationStringsGenerator

Returns:

the translating project

setTranslatingProject

public void setTranslatingProject(ITranslatingProject translatingProject)

Sets the translating project.

Specified by:

setTranslatingProject in interface TranslationStringsGenerator

Parameters:

translatingProject - the new translating project

getCollectedValues

public TempFileFeatureCollection getCollectedValues()

Gets the collected values.

Specified by:

getCollectedValues in interface TranslationStringsGenerator

Returns:

the collected values

setContinueAfterFirstError

public void setContinueAfterFirstError(boolean isContinue)

Sets whether to continue collect after first error.

Specified by:

setContinueAfterFirstError in interface TranslationStringsGenerator

Parameters:

isContinue - true, to continue after first error

isContinueAfterFirstError

public boolean isContinueAfterFirstError()

Checks if the collecting process should continue after first error.

Specified by:

isContinueAfterFirstError in interface TranslationStringsGenerator

Returns:

true, if the collecting process should continue after first error

canProcess

public boolean canProcess()

Description copied from interface: TranslationStringsGenerator

checks if can process collecting and saving translation strings..

Specified by:

canProcess in interface TranslationStringsGenerator

Returns:

true, if can process collecting and saving translation strings.

getErrors

public Collection<Exception> getErrors()

Gets the errors that found during collecting features.

Specified by:

getErrors in interface TranslationStringsGenerator

Returns:

the errors

checkSettings

public boolean checkSettings()

Check settings. If checking is unsuccessful get errors getErrors() to show details to user.

Specified by:

checkSettings in interface TranslationStringsGenerator

Returns:

true, checks of settings if successful

collectStrings

public boolean collectStrings(org.eclipse.core.runtime.IProgressMonitor monitor)

Collect translation strings.

Specified by:

collectStrings in interface TranslationStringsGenerator

Parameters:

monitor - the monitor

Returns:

true, if successfully collected and filled with settings

saveCollectedStrings

public void saveCollectedStrings(org.eclipse.core.runtime.IProgressMonitor monitor)

Save collected strings.

Specified by:

saveCollectedStrings in interface TranslationStringsGenerator

Parameters:

monitor - the monitor

dispose

public void dispose()

Dispose and free held resources.

Specified by:

dispose in interface TranslationStringsGenerator

collectStrings

protected boolean collectStrings(TranslationSource object,
 org.eclipse.core.runtime.IProgressMonitor monitor)

Collects strings and return true if do that successful.

Parameters:

object - the object

monitor - the monitor

Returns:

true, if successful

createCollectingParameters

protected ICollectingParameters createCollectingParameters()

fillUpCollectedValues

protected boolean fillUpCollectedValues(org.eclipse.core.runtime.IProgressMonitor monitor)

collectAndSaveStrings

public void collectAndSaveStrings(org.eclipse.core.runtime.IProgressMonitor monitor)

Collect and save strings.

Specified by:

collectAndSaveStrings in interface TranslationStringsGenerator

Parameters:

monitor - the monitor

addOrUpdateValue

public void addOrUpdateValue(FeatureValue value)

Adds the or update value.

Specified by:

addOrUpdateValue in interface TranslationStringsGenerator

Parameters:

value - the value

setFilterParameters

public void setFilterParameters(Map<String,? extends Object> filterParameters)

Description copied from interface: TranslationStringsGenerator

Sets the filter parameters.

Specified by:

setFilterParameters in interface TranslationStringsGenerator

Parameters:

filterParameters - the filter parameters, where key is public filter's parameter name and value, usually string or other object appropriate for the filter participant passed form a caller, cannot be null.

disableCache

public void disableCache()

Specified by:

disableCache in interface TranslationStringsGenerator

enableCache

public void enableCache()

Specified by:

enableCache in interface TranslationStringsGenerator