public class DataResource_impl extends Resource_ImplBase implements DataResource
DataResource
implementation that can read data from a file via a URL. There is
an attribute for specifying the location of a local cache for a remote file, but this is not
currently being used.PARAM_RELATIVE_PATH_RESOLVER
PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT
Constructor and Description |
---|
DataResource_impl() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
Determines if this
DataResource is equal to another DataResource . |
InputStream |
getInputStream()
Gets an
InputStream to the data. |
protected File |
getLocalCache()
Gets the file name of the local cache for a remote resource file, if any.
|
URI |
getUri()
Gets the URI of the data.
|
URL |
getUrl()
Gets the URL where the data is stored.
|
int |
hashCode()
Gest the hash code for this
DataResource . |
boolean |
initialize(ResourceSpecifier aSpecifier,
Map<String,Object> aAdditionalParams)
Initializes this DataResource.
|
destroy, getCasManager, getLogger, getMetaData, getRelativePathResolver, getResourceManager, getUimaContext, getUimaContextAdmin, loadUserClass, loadUserClassOrThrow, setContextHolder, setContextHolderX, setLogger, setMetaData, withContextHolder
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
destroy, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger
public boolean initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams) throws ResourceInitializationException
initialize
in interface Resource
initialize
in class Resource_ImplBase
aSpecifier
- describes how to create this DataResource. Must (at least for now) be a
FileResourceSpecifier
.aAdditionalParams
- not currently usedResourceSpecifier
.ResourceInitializationException
- if a failure occurs during initialization.Resource.initialize(ResourceSpecifier, Map)
public InputStream getInputStream() throws IOException
DataResource
InputStream
to the data. It is the caller's responsibility to close this input
stream when finished with it.getInputStream
in interface DataResource
IOException
- if an I/O error occurred when trying to open the streamDataResource.getInputStream()
public URL getUrl()
DataResource
DataResource.getInputStream()
method be used whenever possible - see the class comment for more
information.getUrl
in interface DataResource
DataResource.getUrl()
public URI getUri()
DataResource
DataResource.getUrl()
. However, in the case where DataResource.getUrl()
returns null
(indicating no URL available), this method may still return a URI. This can be the case if the
URI does not use a standard protocol such as http or file.getUri
in interface DataResource
protected File getLocalCache()
public boolean equals(Object obj)
DataResource
DataResource
is equal to another DataResource
.
It is important that DataResource
implementations override this method
appropriately, because the ResourceManager
can make use of this method to determine
when cached data can be reused. Two DataResource
s that are equal
according to this method will be considered to provide access to the same data; therefore, a
common cache can be used.equals
in interface DataResource
equals
in class Object
obj
- the object to compare toaObj
is a DataResource
and provides
access to the same data as this object.DataResource.equals(java.lang.Object)
public int hashCode()
DataResource
DataResource
. As always, if the
DataResource.equals(Object)
method is overridden, this method should also be overridden. Two
objects that are equal
must have the same hash code.hashCode
in interface DataResource
hashCode
in class Object
DataResource.hashCode()
Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.