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

static String	RESOURCE_DIR The directory name of the /resource directory.
static String	RULES_DIR The directory name of the /rules directory.

Method Summary

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()
void	setResourceDir(String resourceDir)
void	setRulesDir(String rulesDir)

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 or null if it wasn't found.

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 or null if it wasn't 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 or null if it wasn't 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 or null if it wasn't 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

setResourceDir

void setResourceDir(String resourceDir)

Parameters:

resourceDir - The used directory path to the /resource directory. 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

setRulesDir

void setRulesDir(String rulesDir)

Parameters:

rulesDir - The used directory path to the /rules directory. Make sure that you comply with the following format when setting this value:

/subdir/furtherdir/rulesdir