org.languagetool.broker

Class DefaultResourceDataBroker

java.lang.Object

org.languagetool.broker.DefaultResourceDataBroker

All Implemented Interfaces:

ResourceDataBroker

public class DefaultResourceDataBroker
extends Object
implements ResourceDataBroker

Responsible for getting any items from LanguageTool's resource directories. This default data broker assumes that they are accessible directly via class-path and the directory names are like specified in:

• ResourceDataBroker.RESOURCE_DIR
• ResourceDataBroker.RULES_DIR

If you'd like to determine another resource directory location this default data broker provides proper methods. Assuming your /rules and /resource directories are accessible via class-path with following path information:

• /res/grammarchecker/rulesdirname
• /res/grammarchecker/resourcedirname

In this case you have to use the constructor with the following arguments:

• /res/grammarchecker/rulesdirname
• /res/grammarchecker/resourcedirname

Make sure that you never obtain any LanguageTool resources by calling Object.class.getResource(String) or Object.class.getResourceAsStream(String) directly. If you would like to obtain something from these directories do always use JLanguageTool.getDataBroker() which provides proper methods for reading the directories above.

For example, if you want to get the URL of /rules/de/grammar.xml just invoke ResourceDataBroker.getFromRulesDirAsUrl(String) and pass /de/grammar.xml as a string. Note: The /rules directory's name isn't passed because its name might have changed. The same usage does apply for the /resource directory.

Since:

1.0.1

Author:

PAX

See Also:

ResourceDataBroker

Field Summary

Fields inherited from interface org.languagetool.broker.ResourceDataBroker

RESOURCE_DIR, RULES_DIR

Constructor Summary

Constructors

Constructor and Description
DefaultResourceDataBroker() Instantiates this data broker with the default resource directory names as specified in: ResourceDataBroker.RESOURCE_DIR ResourceDataBroker.RULES_DIR
DefaultResourceDataBroker(String resourceDir, String rulesDir) Instantiates this data broker with the passed resource directory names.

Method Summary

Modifier and Type	Method and Description
InputStream	getAsStream(String path) Get from resource broker by a path file
URL	getAsURL(String path) Get from resource broker by a path file
List<URL>	getAsURLs(String path) Get URLs from resource broker by a path file
List<String>	getFromResourceDirAsLines(String path) See: ResourceDataBroker.getFromResourceDirAsStream(String)
InputStream	getFromResourceDirAsStream(String path) See: ResourceDataBroker.getFromResourceDirAsStream(String)
URL	getFromResourceDirAsUrl(String path) See: ResourceDataBroker.getFromResourceDirAsUrl(String)
List<URL>	getFromResourceDirAsUrls(String path) Gets all resources in a form of URL from LanguageTool's /resource directory with the same path.
InputStream	getFromRulesDirAsStream(String path) See: ResourceDataBroker.getFromRulesDirAsStream(String)
URL	getFromRulesDirAsUrl(String path) See: ResourceDataBroker.getFromRulesDirAsUrl(String)
ResourceBundle	getResourceBundle(String baseName, Locale locale) Gets a resource bundle using the specified base name and locale, and the caller module.
String	getResourceDir()
String	getRulesDir()
boolean	resourceExists(String path) See: ResourceDataBroker.resourceExists(String) Checks if a resource in LanguageTool's /resource exists.
boolean	ruleFileExists(String path) See: ResourceDataBroker.ruleFileExists(String) Checks if a resource in LanguageTool's /rules exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultResourceDataBroker

public DefaultResourceDataBroker()

Instantiates this data broker with the default resource directory names as specified in:

• ResourceDataBroker.RESOURCE_DIR
• ResourceDataBroker.RULES_DIR

DefaultResourceDataBroker

public DefaultResourceDataBroker(String resourceDir,
                                 String rulesDir)

Instantiates this data broker with the passed resource directory names.

Parameters:

resourceDir - The directory's name of LanguageTool's resource directory. The default value equals ResourceDataBroker.RESOURCE_DIR.

rulesDir - The directory's name of LanguageTool's rules directory. The default value equals ResourceDataBroker.RULES_DIR.

Method Detail

getFromResourceDirAsStream

@NotNull
public InputStream getFromResourceDirAsStream(String path)

See: ResourceDataBroker.getFromResourceDirAsStream(String)

Specified by:

getFromResourceDirAsStream in interface ResourceDataBroker

Parameters:

path - The relative path to the item inside of the /resource directory. Please start your path information with / because it will be concatenated with the directory's name: /resource/yourpath.

Returns:

An InputStream object to the requested item

Throws:

RuntimeException - if path cannot be found

getFromResourceDirAsLines

@NotNull
public List<String> getFromResourceDirAsLines(String path)

See: ResourceDataBroker.getFromResourceDirAsStream(String)

Specified by:

getFromResourceDirAsLines in interface ResourceDataBroker

Parameters:

path - The relative path to the item inside of the /resource, e.g. /xx/filename

Returns:

An list of strings, one per line

Throws:

RuntimeException - if path cannot be found

Since:

4.9

getAsStream

@Nullable
public InputStream getAsStream(String path)

Get from resource broker by a path file

Specified by:

getAsStream in interface ResourceDataBroker

Parameters:

path - Path to an item

Returns:

An InputStream object to the requested item

getAsURL

@Nullable
public URL getAsURL(String path)

Get from resource broker by a path file

Specified by:

getAsURL in interface ResourceDataBroker

Parameters:

path - Path to an item

Returns:

An URL object to the requested item

getAsURLs

@Nullable
public List<URL> getAsURLs(String path)

Get URLs from resource broker by a path file

Specified by:

getAsURLs in interface ResourceDataBroker

Parameters:

path - Path to an item

Returns:

An list of URL objects to the requested item

getFromResourceDirAsUrl

@NotNull
public URL getFromResourceDirAsUrl(String path)

See: ResourceDataBroker.getFromResourceDirAsUrl(String)

Specified by:

getFromResourceDirAsUrl in interface ResourceDataBroker

Parameters:

path - The relative path to the item inside of the /resource directory. Please start your path information with / because it will be concatenated with the directory's name: /resource/yourpath.

Returns:

An URL object to the requested item

Throws:

RuntimeException - if path cannot be found

getFromResourceDirAsUrls

@NotNull
public List<URL> getFromResourceDirAsUrls(String path)

Gets all resources in a form of URL from LanguageTool's /resource directory with the same path.

Specified by:

getFromResourceDirAsUrls in interface ResourceDataBroker

Parameters:

path - Path to an items from the /resource directory.

Returns:

A list of URL objects to the requested item

getFromRulesDirAsStream

@NotNull
public InputStream getFromRulesDirAsStream(String path)

See: ResourceDataBroker.getFromRulesDirAsStream(String)

Specified by:

getFromRulesDirAsStream in interface ResourceDataBroker

Parameters:

path - The relative path to the item inside of the /rules directory. Please start your path information with / because it will be concatenated with the directory's name: /rules/yourpath.

Returns:

An InputStream object to the requested item

Throws:

RuntimeException - if path cannot be found

getFromRulesDirAsUrl

@NotNull
public URL getFromRulesDirAsUrl(String path)

See: ResourceDataBroker.getFromRulesDirAsUrl(String)

Specified by:

getFromRulesDirAsUrl in interface ResourceDataBroker

Parameters:

path - The relative path to the item inside of the /rules directory. Please start your path information with / because it will be concatenated with the directory's name: /rules/yourpath.

Returns:

An URL object to the requested item

Throws:

RuntimeException - if path cannot be found

resourceExists

public boolean resourceExists(String path)

See: ResourceDataBroker.resourceExists(String) Checks if a resource in LanguageTool's /resource exists.

Specified by:

resourceExists in interface ResourceDataBroker

Parameters:

path - Path to an item from the /resource directory.

Returns:

true if the resource file exists.

ruleFileExists

public boolean ruleFileExists(String path)

See: ResourceDataBroker.ruleFileExists(String) Checks if a resource in LanguageTool's /rules exists.

Specified by:

ruleFileExists in interface ResourceDataBroker

Parameters:

path - Path to an item from the /rules directory.

Returns:

true if the resource file exists.

getResourceDir

public String getResourceDir()

Specified by:

getResourceDir in interface ResourceDataBroker

Returns:

The directory's name of LanguageTool's resource directory. The default value equals ResourceDataBroker.RESOURCE_DIR.

getRulesDir

public String getRulesDir()

Specified by:

getRulesDir in interface ResourceDataBroker

Returns:

The directory's name of the grammar checker's rules directory. The default value equals ResourceDataBroker.RULES_DIR.

getResourceBundle

public ResourceBundle getResourceBundle(String baseName,
                                        Locale locale)

Gets a resource bundle using the specified base name and locale, and the caller module.

Specified by:

getResourceBundle in interface ResourceDataBroker

Parameters:

baseName - the base name of the resource bundle, a fully qualified class name

locale - the locale for which a resource bundle is desired

Returns:

a resource bundle for the given base name and locale

Throws:

NullPointerException - if baseName or locale is null

MissingResourceException - if no resource bundle for the specified base name can be found