org.pentaho.di.ui.i18n

Class MessagesSourceCrawler

java.lang.Object

org.pentaho.di.ui.i18n.MessagesSourceCrawler

public class MessagesSourceCrawler
extends Object

This class takes care of crawling through the source code

Author:

matt

Constructor Summary

Constructors

Constructor and Description
MessagesSourceCrawler(LogChannelInterface log, List<String> sourceDirectories, String singleMessagesFile, List<SourceCrawlerXMLFolder> xmlFolders)

Method Summary

Modifier and Type	Method and Description
void	addKeyOccurrence(KeyOccurrence occ) Add a key occurrence to the list of occurrences.
void	crawl()
List<String>	getFilesToAvoid()
KeyOccurrence	getKeyOccurrence(String key, String selectedMessagesPackage)
List<KeyOccurrence>	getKeyOccurrences(String sourceFolder) Get the unique package-key
List<String>	getMessagesPackagesList(String sourceFolder)
List<KeyOccurrence>	getOccurrencesForPackage(String messagesPackage) Get all the key occurrences for a certain messages package.
String[]	getScanPhrases()
String	getSingleMessagesFile()
List<String>	getSourceDirectories()
Map<String,Map<String,List<KeyOccurrence>>>	getSourcePackageOccurrences()
void	lookForOccurrencesInFile(String sourceFolder, org.apache.commons.vfs2.FileObject javaFile) Look for additional occurrences of keys in the specified file.
void	setFilesToAvoid(List<String> filesToAvoid)
void	setScanPhrases(String[] scanPhrases)
void	setSingleMessagesFile(String singleMessagesFile)
void	setSourceDirectories(List<String> sourceDirectories)
void	setSourcePackageOccurrences(Map<String,Map<String,List<KeyOccurrence>>> sourcePackageOccurrences)

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagesSourceCrawler

public MessagesSourceCrawler(LogChannelInterface log,
                             List<String> sourceDirectories,
                             String singleMessagesFile,
                             List<SourceCrawlerXMLFolder> xmlFolders)

Parameters:

sourceDirectories - The source directories to crawl through

singleMessagesFile - the messages file if there is only one, otherwise: null

Method Detail

getSourceDirectories

public List<String> getSourceDirectories()

Returns:

The source directories to crawl through

setSourceDirectories

public void setSourceDirectories(List<String> sourceDirectories)

Parameters:

sourceDirectories - The source directories to crawl through

getFilesToAvoid

public List<String> getFilesToAvoid()

Returns:

the files to avoid

setFilesToAvoid

public void setFilesToAvoid(List<String> filesToAvoid)

Parameters:

filesToAvoid - the files to avoid

addKeyOccurrence

public void addKeyOccurrence(KeyOccurrence occ)

Add a key occurrence to the list of occurrences. The list is kept sorted on key and message package. If the key already exists, we increment the number of occurrences.

Parameters:

occ - The key occurrence to add

crawl

public void crawl()
           throws Exception

Throws:

Exception

lookForOccurrencesInFile

public void lookForOccurrencesInFile(String sourceFolder,
                                     org.apache.commons.vfs2.FileObject javaFile)
                              throws IOException

Look for additional occurrences of keys in the specified file.

Parameters:

sourceFolder - The folder the java file and messages files live in

javaFile - The java source file to examine

Throws:

IOException - In case there is a problem accessing the specified source file.

getMessagesPackagesList

public List<String> getMessagesPackagesList(String sourceFolder)

Returns:

A sorted list of distinct occurrences of the used message package names

getOccurrencesForPackage

public List<KeyOccurrence> getOccurrencesForPackage(String messagesPackage)

Get all the key occurrences for a certain messages package.

Parameters:

sourceFolder - the source folder to reference

messagesPackage - the package to hunt for

Returns:

all the key occurrences for a certain messages package.

getKeyOccurrence

public KeyOccurrence getKeyOccurrence(String key,
                                      String selectedMessagesPackage)

getSingleMessagesFile

public String getSingleMessagesFile()

Returns:

the singleMessagesFile

setSingleMessagesFile

public void setSingleMessagesFile(String singleMessagesFile)

Parameters:

singleMessagesFile - the singleMessagesFile to set

getScanPhrases

public String[] getScanPhrases()

Returns:

the scanPhrases

setScanPhrases

public void setScanPhrases(String[] scanPhrases)

Parameters:

scanPhrases - the scanPhrases to set

getSourcePackageOccurrences

public Map<String,Map<String,List<KeyOccurrence>>> getSourcePackageOccurrences()

setSourcePackageOccurrences

public void setSourcePackageOccurrences(Map<String,Map<String,List<KeyOccurrence>>> sourcePackageOccurrences)

getKeyOccurrences

public List<KeyOccurrence> getKeyOccurrences(String sourceFolder)

Get the unique package-key

Parameters:

sourceFolder -