Class DefaultResourceDataBroker
- java.lang.Object
-
- org.languagetool.databroker.DefaultResourceDataBroker
-
- All Implemented Interfaces:
ResourceDataBroker
public class DefaultResourceDataBroker extends Object implements ResourceDataBroker
Responsible for getting any items from the grammar checker's resource directories. This default data broker assumes that they are accessible directly via class-path and the directory names are like specified in: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
/res/grammarchecker/rulesdirname
/res/grammarchecker/resourcedirname
Make sure that you never obtain any grammar checker resources by calling
Object.class.getResource(String)
orObject.class.getResourceAsStream(String)
directly. If you would like to obtain something from these directories do always useJLanguageTool.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 invokeResourceDataBroker.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.databroker.ResourceDataBroker
RESOURCE_DIR, RULES_DIR
-
-
Constructor Summary
Constructors Constructor 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InputStream
getFromResourceDirAsStream(String path)
URL
getFromResourceDirAsUrl(String path)
InputStream
getFromRulesDirAsStream(String path)
URL
getFromRulesDirAsUrl(String path)
String
getResourceDir()
String
getRulesDir()
boolean
resourceExists(String path)
See:ResourceDataBroker.resourceExists(String)
Checks if a resource in the grammar checker's/resource
exists.boolean
ruleFileExists(String path)
See:ResourceDataBroker.ruleFileExists(String)
Checks if a resource in the grammar checker's/rules
exists.
-
-
-
Constructor Detail
-
DefaultResourceDataBroker
public DefaultResourceDataBroker()
Instantiates this data broker with the default resource directory names as specified in:
-
DefaultResourceDataBroker
public DefaultResourceDataBroker(String resourceDir, String rulesDir)
Instantiates this data broker with the passed resource directory names.- Parameters:
resourceDir
- The directory's name of the grammar checker's resource directory. The default value equalsResourceDataBroker.RESOURCE_DIR
.rulesDir
- The directory's name of the grammar checker's rules directory. The default value equalsResourceDataBroker.RULES_DIR
.
-
-
Method Detail
-
getFromResourceDirAsStream
public InputStream getFromResourceDirAsStream(String path)
- Specified by:
getFromResourceDirAsStream
in interfaceResourceDataBroker
- 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
-
getFromResourceDirAsUrl
public URL getFromResourceDirAsUrl(String path)
- Specified by:
getFromResourceDirAsUrl
in interfaceResourceDataBroker
- 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
-
getFromRulesDirAsStream
public InputStream getFromRulesDirAsStream(String path)
- Specified by:
getFromRulesDirAsStream
in interfaceResourceDataBroker
- 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
public URL getFromRulesDirAsUrl(String path)
- Specified by:
getFromRulesDirAsUrl
in interfaceResourceDataBroker
- 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 the grammar checker's/resource
exists.- Specified by:
resourceExists
in interfaceResourceDataBroker
- 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 the grammar checker's/rules
exists.- Specified by:
ruleFileExists
in interfaceResourceDataBroker
- 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 interfaceResourceDataBroker
- Returns:
- The directory's name of the grammar checker's resource directory.
The default value equals
ResourceDataBroker.RESOURCE_DIR
.
-
getRulesDir
public String getRulesDir()
- Specified by:
getRulesDir
in interfaceResourceDataBroker
- Returns:
- The directory's name of the grammar checker's rules directory.
The default value equals
ResourceDataBroker.RULES_DIR
.
-
-