org.languagetool.databroker

Interface ResourceDataBroker

All Known Implementing Classes:

DefaultResourceDataBroker

public interface ResourceDataBroker

Is responsible for getting the necessary resources for the grammar checker library. Following directories are currently needed by a couple of classes:

• /resource
• /rules

This interface determines methods to obtain any contents from these directories.

Make sure that you never obtain any grammar checker 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 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

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_DIR The directory name of the /resource directory.
static String	RULES_DIR The directory name of the /rules directory.

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	getFromResourceDirAsStream(String path) Gets any resource from the grammar checker's /resource directory.
URL	getFromResourceDirAsUrl(String path) Gets any resource from the grammar checker's /resource directory.
InputStream	getFromRulesDirAsStream(String path) Gets any resource from the grammar checker's /rules directory.
URL	getFromRulesDirAsUrl(String path) Gets any resource from the grammar checker's /rules directory.
String	getResourceDir()
String	getRulesDir()
boolean	resourceExists(String path) Checks if a resource in the grammar checker's /resource exists.
boolean	ruleFileExists(String path) Checks if a resource in the grammar checker's /rules exists.

Field Detail

RESOURCE_DIR

static final String RESOURCE_DIR

The directory name of the /resource directory.

See Also:

Constant Field Values

RULES_DIR

static final String RULES_DIR

The directory name of the /rules directory.

See Also:

Constant Field Values

Method Detail

getFromResourceDirAsUrl

URL getFromResourceDirAsUrl(String path)

Gets any resource from the grammar checker's /resource directory.

Parameters:

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

Returns:

An URL object to the requested item

Throws:

RuntimeException - if path cannot be found

resourceExists

boolean resourceExists(String path)

Checks if a resource in the grammar checker's /resource exists.

Parameters:

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

Returns:

true if the resource file exists.

ruleFileExists

boolean ruleFileExists(String path)

Checks if a resource in the grammar checker's /rules exists.

Parameters:

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

Returns:

true if the resource file exists.

getFromResourceDirAsStream

InputStream getFromResourceDirAsStream(String path)

Gets any resource from the grammar checker's /resource directory.

Parameters:

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

Returns:

An InputStream object to the requested item

Throws:

RuntimeException - if path cannot be found

getFromRulesDirAsUrl

URL getFromRulesDirAsUrl(String path)

Gets any resource from the grammar checker's /rules directory.

Parameters:

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

Returns:

An URL object to the requested item

Throws:

RuntimeException - if path cannot be found

getFromRulesDirAsStream

InputStream getFromRulesDirAsStream(String path)

Gets any resource from the grammar checker's /rules directory.

Parameters:

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

Returns:

An InputStream object to the requested item

Throws:

RuntimeException - if path cannot be found

getResourceDir

String getResourceDir()

Returns:

The currently set resource directory path as a string. Make sure that you comply with the following format when setting this value:

/subdir/furtherdir/resourcedir

getRulesDir

String getRulesDir()

Returns:

The currently set rules directory path as a string. Make sure that you comply with the following format when setting this value:

/subdir/furtherdir/rulesdir