net.sf.yal10n.settings

Class DashboardConfiguration

java.lang.Object

net.sf.yal10n.settings.DashboardConfiguration

public class DashboardConfiguration
extends Object

Configuration for the dashboard-mojo and detect-changes-mojo. The configuration is read as JSON.

Constructor Summary

Constructors

Constructor and Description
DashboardConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
CheckConfiguration	getChecks() Gets the configuration for the file checks.
List<String>	getExcludes() Gets the global ant-style exclude patterns that have effect across all repositories.
List<String>	getIncludes() Gets the global ant-style include patterns that have effect across all repositories.
LanguageComparator	getLanguageComparator() Gets the comparator to be used for the languages in the dashboard.
List<String>	getLanguages() Gets the list of all languages.
String	getMirrorPrefix() Gets the mirror prefix, that should be used when a mirror url is defined in the repositories.
Notification	getNotification() Gets the notification configuration
String	getRepoPrefix() Gets the URL prefix, that should be used for every repository url.
List<Repository>	getRepositories() Gets the list of configured repositories.
Repository	getRepositoryById(String repoId) Lookup a repository configuration by id.
String	getViewvcPrefix() Gets the web-URL prefix, that should be used for every repository url.
boolean	isCreateTMX() Whether to create TMX files for download or not.
static DashboardConfiguration	readFromFile(String file) Reads the configuration from a JSON file.
void	setChecks(CheckConfiguration checks) Sets the configuration for the file checks.
void	setCreateTMX(boolean createTMX) Sets whether to create TMX files for download or not.
void	setExcludes(List<String> excludes) Sets the global ant-style exclude patterns that have effect across all repositories.
void	setIncludes(List<String> includes) Sets the global ant-style include patterns that have effect across all repositories.
void	setLanguageComparator(LanguageComparator languageComparator) Sets the comparator to be used for the languages in the dashboard.
void	setLanguages(List<String> languages) Sets the list of all languages.
void	setMirrorPrefix(String mirrorPrefix) Sets the mirror prefix.
void	setNotification(Notification notification) Sets the notification configuration
void	setRepoPrefix(String repoPrefix) Sets the URL prefix, that should be used for every repository url.
void	setRepositories(List<Repository> repositories) Sets the list of configured repositories.
void	setViewvcPrefix(String viewvcPrefix) Sets the web-URL prefix, that should be used for every repository url.

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardConfiguration

public DashboardConfiguration()

Method Detail

getRepoPrefix

public String getRepoPrefix()

Gets the URL prefix, that should be used for every repository url. This is like a base url.

Returns:

the prefix

setRepoPrefix

public void setRepoPrefix(String repoPrefix)

Sets the URL prefix, that should be used for every repository url.

Parameters:

repoPrefix - the prefix

getMirrorPrefix

public String getMirrorPrefix()

Gets the mirror prefix, that should be used when a mirror url is defined in the repositories.

Returns:

the mirror prefix

setMirrorPrefix

public void setMirrorPrefix(String mirrorPrefix)

Sets the mirror prefix.

Parameters:

mirrorPrefix - the new mirror prefix

getViewvcPrefix

public String getViewvcPrefix()

Gets the web-URL prefix, that should be used for every repository url.

Returns:

the web-URL prefix

setViewvcPrefix

public void setViewvcPrefix(String viewvcPrefix)

Sets the web-URL prefix, that should be used for every repository url.

Parameters:

viewvcPrefix - the web-URL prefix

getRepositories

public List<Repository> getRepositories()

Gets the list of configured repositories.

Returns:

the repositories

setRepositories

public void setRepositories(List<Repository> repositories)

Sets the list of configured repositories.

Parameters:

repositories - the repositories

getIncludes

public List<String> getIncludes()

Gets the global ant-style include patterns that have effect across all repositories.

Returns:

the include patterns.

See Also:

Repository.getIncludes()

setIncludes

public void setIncludes(List<String> includes)

Sets the global ant-style include patterns that have effect across all repositories.

Parameters:

includes - the include patterns.

See Also:

Repository.getIncludes()

getExcludes

public List<String> getExcludes()

Gets the global ant-style exclude patterns that have effect across all repositories.

Returns:

the exclude patterns.

See Also:

Repository.getExcludes()

setExcludes

public void setExcludes(List<String> excludes)

Sets the global ant-style exclude patterns that have effect across all repositories.

Parameters:

excludes - the exclude patterns.

See Also:

Repository.getExcludes()

isCreateTMX

public boolean isCreateTMX()

Whether to create TMX files for download or not.

Returns:

true if TMX files should be created.

setCreateTMX

public void setCreateTMX(boolean createTMX)

Sets whether to create TMX files for download or not.

Parameters:

createTMX - true if TMX files should be created.

getLanguages

public List<String> getLanguages()

Gets the list of all languages.

Returns:

all languages

setLanguages

public void setLanguages(List<String> languages)

Sets the list of all languages.

Parameters:

languages - all languages

getLanguageComparator

public LanguageComparator getLanguageComparator()

Gets the comparator to be used for the languages in the dashboard. Default is: LanguageComparator.ALPHABETICAL_VARIANTS_LAST

Returns:

the language comparator

setLanguageComparator

public void setLanguageComparator(LanguageComparator languageComparator)

Sets the comparator to be used for the languages in the dashboard.

Parameters:

languageComparator - the language comparator

getChecks

public CheckConfiguration getChecks()

Gets the configuration for the file checks.

Returns:

the file check configurations

setChecks

public void setChecks(CheckConfiguration checks)

Sets the configuration for the file checks.

Parameters:

checks - the file check configurations

getNotification

public Notification getNotification()

Gets the notification configuration

Returns:

the notification configuration

setNotification

public void setNotification(Notification notification)

Sets the notification configuration

Parameters:

notification - the notification configuration

getRepositoryById

public Repository getRepositoryById(String repoId)

Lookup a repository configuration by id.

Parameters:

repoId - the repo id

Returns:

the Repository configuration or null

readFromFile

public static DashboardConfiguration readFromFile(String file)

Reads the configuration from a JSON file.

Parameters:

file - the file to read from

Returns:

the configuration