ResourceObjectProviderBase (DKPro Core 1.9.0 API)

java.lang.Object
- de.tudarmstadt.ukp.dkpro.core.api.resources.ResourceObjectProviderBase<M>

Type Parameters:

M - the kind of resource produced

All Implemented Interfaces:

HasResourceMetadata

Direct Known Subclasses:

CasConfigurableProviderBase
```
public abstract class ResourceObjectProviderBase<M>
extends Object
implements HasResourceMetadata
```
Base class for resource providers that produce a resource from some URL depending on changing parameters such as language.
A component using such a provider sets defaults and overrides. The defaults should be set to sensible values with which the component should be able to work out of the box. For example the LOCATION may be set to "classpath:/resources/${language}/model.ser.gz".
The overrides should only be set if the user explicitly wants to override some settings.
Finally, parameters that may change, e.g. depending on the CAS content should be returned from getProperties().
The LOCATION may contain variables referring to any of the other settings, e.g. "${language}".
It is possible a different default variant needs to be used depending on the language. This can be configured by placing a properties file in the classpath and setting its location using setDefaultVariantsLocation(String) or by using setDefaultVariants(Properties). The key in the properties is the language and the value is used a default variant.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ARTIFACT_ID` The artifact ID of the Maven artifact containing a resource.
`static String`	`CATCH_ALL`
`static String`	`FORCE_AUTO_LOAD`
`static String`	`GROUP_ID` The group ID of the Maven artifact containing a resource.
`static String`	`LANGUAGE` The language.
`static String`	`LOCATION` The location from which the resource should be read.
`static String`	`NOT_REQUIRED`
`static String`	`PACKAGE`
`static String`	`PROP_REPO_CACHE`
`static String`	`PROP_REPO_ID`
`static String`	`PROP_REPO_OFFLINE`
`static String`	`PROP_REPO_URL`
`static String`	`SHARABLE` If this property is set to `true`, resources loaded through this provider are remembered by the provider using a weak reference.
`static String`	`VARIANT` The variant.
`static String`	`VERSION` The version of the Maven artifact containing a resource.

Constructor Summary

Constructors
Constructor and Description

ResourceObjectProviderBase()

Constructors
Constructor and Description
`ResourceObjectProviderBase()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAutoOverride(String aParameter, String aProperty)`
`void`	`addImport(String aString, HasResourceMetadata aSource)`
`void`	`applyAutoOverrides(Object aObject)`
`void`	`configure()` Configure a resource using the current configuration.
`protected URL`	`followRedirects(URL aUrl)`
`protected Properties`	`getAggregatedProperties()` Builds the aggregated configuration from defaults and overrides.
`Map<String,String>`	`getAutoOverrides()`
`de.tudarmstadt.ukp.dkpro.core.api.resources.ResourceObjectProviderBase.ExtensibleURLClassLoader`	`getClassLoader()`
`Class<?>`	`getContextClass()`
`String`	`getDefault(String aKey)`
`protected String`	`getLastModelLocation()`
`protected String`	`getModelLocation()` For use in test cases.
`protected String`	`getModelLocation(Properties aProperties)`
`protected org.apache.ivy.plugins.resolver.DependencyResolver`	`getModelResolver()`
`protected String`	`getModelVersionFromMavenPom()` Tries to get the version of the required model from the dependency management section of the Maven POM belonging to the context object.
`String`	`getOverride(String aKey)`
`protected abstract Properties`	`getProperties()`
`M`	`getResource()` Get the currently configured resources.
`Properties`	`getResourceMetaData()`
`protected void`	`init()`
`protected void`	`loadMetadata()`
`protected void`	`loadResource(Properties aProperties)`
`protected void`	`mergeProperties(Properties aTarget, Properties aSource)` Copy all properties that not already exist in target from source.
`protected abstract M`	`produceResource(URL aUrl)`
`void`	`removeDefault(String aKey)`
`void`	`removeImport(String aString)`
`void`	`removeOverride(String aKey)`
`void`	`setContextClass(Class<?> aClass)` Set a class which can be used to try finding a Maven POM from which resource version information could be extracted.
`void`	`setContextObject(Object aObject)` Set an object which can be used to try finding a Maven POM from which resource version information could be extracted.
`void`	`setDefault(String aKey, String aValue)`
`void`	`setDefaultVariants(Properties aDefaultVariants)` Sets language-dependent default variants.
`void`	`setDefaultVariantsLocation(String aLocation)` Set the location in the classpath from where to load the language-dependent default variants properties file.
`void`	`setOverride(String aKey, String aValue)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROP_REPO_OFFLINE
```
public static final String PROP_REPO_OFFLINE
```
    See Also:
    
    Constant Field Values
  - PROP_REPO_ID
```
public static final String PROP_REPO_ID
```
    See Also:
    
    Constant Field Values
  - PROP_REPO_URL
```
public static final String PROP_REPO_URL
```
    See Also:
    
    Constant Field Values
  - PROP_REPO_CACHE
```
public static final String PROP_REPO_CACHE
```
    See Also:
    
    Constant Field Values
  - FORCE_AUTO_LOAD
```
public static final String FORCE_AUTO_LOAD
```
    See Also:
    
    Constant Field Values
  - NOT_REQUIRED
```
public static final String NOT_REQUIRED
```
    See Also:
    
    Constant Field Values
  - LANGUAGE
```
public static final String LANGUAGE
```
    The language.
    
    See Also:
    
    Constant Field Values
  - VARIANT
```
public static final String VARIANT
```
    The variant. (optional)
    
    See Also:
    
    Constant Field Values
  - LOCATION
```
public static final String LOCATION
```
    The location from which the resource should be read. Variables in the location are resolved when configure() is called.
    
    See Also:
    
    ResourceUtils.resolveLocation(String, Object, org.apache.uima.UimaContext), Constant Field Values
  - GROUP_ID
```
public static final String GROUP_ID
```
    The group ID of the Maven artifact containing a resource. Variables in the location are resolved when configure() is called. (optional)
    
    See Also:
    
    Constant Field Values
  - ARTIFACT_ID
```
public static final String ARTIFACT_ID
```
    The artifact ID of the Maven artifact containing a resource. Variables in the location are resolved when configure() is called. (optional)
    
    See Also:
    
    Constant Field Values
  - VERSION
```
public static final String VERSION
```
    The version of the Maven artifact containing a resource. Variables in the location are resolved when configure() is called. (optional)
    
    See Also:
    
    Constant Field Values
  - PACKAGE
```
public static final String PACKAGE
```
    See Also:
    
    Constant Field Values
  - SHARABLE
```
public static final String SHARABLE
```
    If this property is set to true, resources loaded through this provider are remembered by the provider using a weak reference. If the same resource is requested by another instance of this provider class, the same resource is returned.
    
    See Also:
    
    Constant Field Values
  - CATCH_ALL
```
public static final String CATCH_ALL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ResourceObjectProviderBase
```
public ResourceObjectProviderBase()
```
- Method Detail
  - init
```
protected void init()
```
  - setOverride
```
public void setOverride(String aKey,
                        String aValue)
```
  - getOverride
```
public String getOverride(String aKey)
```
  - removeOverride
```
public void removeOverride(String aKey)
```
  - setDefault
```
public void setDefault(String aKey,
                       String aValue)
```
  - getDefault
```
public String getDefault(String aKey)
```
  - removeDefault
```
public void removeDefault(String aKey)
```
  - addImport
```
public void addImport(String aString,
                      HasResourceMetadata aSource)
```
  - removeImport
```
public void removeImport(String aString)
```
  - setDefaultVariantsLocation
```
public void setDefaultVariantsLocation(String aLocation)
```
    Set the location in the classpath from where to load the language-dependent default variants properties file. The key in the properties is the language and the value is used a default variant.
    
    Parameters:
    
    aLocation - a location in the form "some/package/name/tool-default-variants.properties". This is always a classpath location. This location may not contain variables.
  - setDefaultVariants
```
public void setDefaultVariants(Properties aDefaultVariants)
```
    Sets language-dependent default variants. The key in the properties is the language and the value is used a default variant.
    
    Parameters:
    
    aDefaultVariants - the default variant per language
  - setContextObject
```
public void setContextObject(Object aObject)
```
    Set an object which can be used to try finding a Maven POM from which resource version information could be extracted.
    
    Parameters:
    
    aObject - a context object, usually the object creating the provider.
  - setContextClass
```
public void setContextClass(Class<?> aClass)
```
    Set a class which can be used to try finding a Maven POM from which resource version information could be extracted.
    
    Parameters:
    
    aClass - a context class, usually the class creating the provider.
  - getContextClass
```
public Class<?> getContextClass()
```
  - getAutoOverrides
```
public Map<String,String> getAutoOverrides()
```
  - addAutoOverride
```
public void addAutoOverride(String aParameter,
                            String aProperty)
```
  - applyAutoOverrides
```
public void applyAutoOverrides(Object aObject)
```
  - getModelVersionFromMavenPom
```
protected String getModelVersionFromMavenPom()
                                      throws IOException
```
    Tries to get the version of the required model from the dependency management section of the Maven POM belonging to the context object.
    
    Returns:
    
    the version of the required model.
    
    Throws:
    
    IOException - if there was a problem loading the POM file
    
    FileNotFoundException - if no POM could be found
    
    IllegalStateException - if more than one POM was found, if the version information could not be found in the POM, or if no context object was set.
  - getModelLocation
```
protected String getModelLocation()
                           throws IOException
```
    For use in test cases.
    
    Returns:
    
    the location of the model.
    
    Throws:
    
    IOException - if the language-dependent default variants location is set but cannot be read.
  - getLastModelLocation
```
protected String getLastModelLocation()
```
  - getModelLocation
```
protected String getModelLocation(Properties aProperties)
                           throws IOException
```
    Throws:
    
    IOException
  - configure
```
public void configure()
               throws IOException
```
    Configure a resource using the current configuration. The resource can be fetched then using getResource().
    Call this method after all configurations have been made. A already configured resource will only be recreated if the URL from which the resource is generated has changed due to configuration changes.
    
    Throws:
    
    IOException - if the resource cannot be created.
  - followRedirects
```
protected URL followRedirects(URL aUrl)
                       throws IOException
```
    Throws:
    
    IOException
  - loadMetadata
```
protected void loadMetadata()
                     throws IOException
```
    Throws:
    
    IOException
  - loadResource
```
protected void loadResource(Properties aProperties)
                     throws IOException
```
    Throws:
    
    IOException
  - getModelResolver
```
protected org.apache.ivy.plugins.resolver.DependencyResolver getModelResolver()
```
  - getResource
```
public M getResource()
```
    Get the currently configured resources. Before this can be used, configure() needs to be called once or whenever the configuration changes. Mind that sub-classes may provide alternative configuration methods that may need to be used instead of configure().
    
    Returns:
    
    the currently configured resources.
  - getClassLoader
```
public de.tudarmstadt.ukp.dkpro.core.api.resources.ResourceObjectProviderBase.ExtensibleURLClassLoader getClassLoader()
```
  - getAggregatedProperties
```
protected Properties getAggregatedProperties()
                                      throws IOException
```
    Builds the aggregated configuration from defaults and overrides.
    
    Returns:
    
    the aggregated effective configuration.
    
    Throws:
    
    IOException - if the language-dependent default variants location is set but cannot be read.
  - getProperties
```
protected abstract Properties getProperties()
```
  - produceResource
```
protected abstract M produceResource(URL aUrl)
                              throws IOException
```
    Throws:
    
    IOException
  - getResourceMetaData
```
public Properties getResourceMetaData()
```
    Specified by:
    
    getResourceMetaData in interface HasResourceMetadata
  - mergeProperties
```
protected void mergeProperties(Properties aTarget,
                               Properties aSource)
```
    Copy all properties that not already exist in target from source.
    
    Parameters:
    
    aTarget - the properties to merge into.
    
    aSource - the properties to merge from.

Class ResourceObjectProviderBase<M>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_REPO_OFFLINE

PROP_REPO_ID

PROP_REPO_URL

PROP_REPO_CACHE

FORCE_AUTO_LOAD

NOT_REQUIRED

LANGUAGE

VARIANT

LOCATION

GROUP_ID

ARTIFACT_ID

VERSION

PACKAGE

SHARABLE

CATCH_ALL

Constructor Detail

ResourceObjectProviderBase

Method Detail

init

setOverride

getOverride

removeOverride

setDefault

getDefault

removeDefault

addImport

removeImport

setDefaultVariantsLocation

setDefaultVariants

setContextObject

setContextClass

getContextClass

getAutoOverrides

addAutoOverride

applyAutoOverrides

getModelVersionFromMavenPom

getModelLocation

getLastModelLocation

getModelLocation

configure

followRedirects

loadMetadata

loadResource

getModelResolver

getResource

getClassLoader

getAggregatedProperties

getProperties

produceResource

getResourceMetaData

mergeProperties