|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Deprecated public interface AnnotatorContext
This interface is maintained only for backwards compatibility with annotators developed in UIMA
SDK v1.x. New code should use UimaContext
instead.
Method Summary | |
---|---|
String[] |
getConfigParameterNames()
Deprecated. Gets the names of all configuration parameters that are not declared in a group. |
String[] |
getConfigParameterNames(String aGroup)
Deprecated. Gets the names of all configuration parameters in the specified group. |
Object |
getConfigParameterValue(String aParamName)
Deprecated. Retrieves the value for a configuration parameter that is not defined in any group or is defined in the default group. |
Object |
getConfigParameterValue(String aGroupName,
String aParamName)
Deprecated. Retrieves the value for a configuration parameter in a particular group. |
String[] |
getConfigurationGroupNames()
Deprecated. Gets the names of all configuration parameter groups. |
String |
getDataPath()
Deprecated. Gets the data path used to locate resources. |
InstrumentationFacility |
getInstrumentationFacility()
Deprecated. Gets the InstrumentationFacility that this annotator can use to record
information about its performance. |
Logger |
getLogger()
Deprecated. Gets the Logger to which this annotator should send its log output. |
InputStream |
getResourceAsStream(String aKey)
Deprecated. Retrieves an InputStream for reading from the named resource. |
InputStream |
getResourceAsStream(String aKey,
String[] aParams)
Deprecated. Retrieves an InputStream for reading from the named resource. |
String |
getResourceFilePath(String aKey)
Deprecated. Retrieves the absolute file path to the named resource. |
String |
getResourceFilePath(String aKey,
String[] aParams)
Deprecated. Retrieves the absolute file path to the named resource. |
Object |
getResourceObject(String aKey)
Deprecated. Retrieves the named resource object. |
Object |
getResourceObject(String aKey,
String[] aParams)
Deprecated. Retrieves the named resource object. |
URI |
getResourceURI(String aKey)
Deprecated. Retrieves the URI to the named resource. |
URI |
getResourceURI(String aKey,
String[] aParams)
Deprecated. Retrieves the URI to the named resource. |
URL |
getResourceURL(String aKey)
Deprecated. Retrieves the URL to the named resource. |
URL |
getResourceURL(String aKey,
String[] aParams)
Deprecated. Retrieves the URL to the named resource. |
SofaID[] |
getSofaMappings()
Deprecated. As of v2.0, annotators no longer need to explicitly call this method. CAS views can now be obtained directly by the method CAS.getView(String) , and the
framework will automatically do the necessary Sofa mappings. |
SofaID |
mapToSofaID(String aSofaName)
Deprecated. As of v2.0, annotators no longer need to explicitly call this method. CAS views can now be obtained directly by the method CAS.getView(String) , and the
framework will automatically do the necessary Sofa mappings. |
Method Detail |
---|
Object getConfigParameterValue(String aParamName) throws AnnotatorContextException
This method returns null
if the parameter is optional and has not been assigned
a value. (For mandatory parameters, an exception is thrown during initialization if no value
has been assigned.) This method also returns null
if there is no declared
configuration parameter with the specified name.
aParamName
- the name of the parameter to look up
null
if the parameter does not
exist or has not been assigned a value.
AnnotatorContextException
- if an internal failure has occurred in the AnnotatorContext
.Object getConfigParameterValue(String aGroupName, String aParamName) throws AnnotatorContextException
ConfigurationParameterDeclarations.getSearchStrategy()
property will be used. The search strategy can be specified in the Analysis Engine Descriptor.
This method returns null
if the parameter is optional and has not been assigned
a value. (For mandatory parameters, an exception is thrown during initialization if no value
has been assigned.) This method also returns null
if there is no declared
configuration parameter with the specified name.
aGroupName
- the name of the group containing the parameteraParamName
- the name of the parameter to look up
null
if the parameter does not
exist or has not been assigned a value.
AnnotatorContextException
- if an internal failure has occurred in the AnnotatorContext
.String[] getConfigurationGroupNames()
String[] getConfigParameterNames(String aGroup)
aGroup
- the group name
aGroup
.
Note that this does include parameters with null values. Returns an empty array if
there are none (including if the group does not exist).String[] getConfigParameterNames()
Logger getLogger() throws AnnotatorContextException
Logger
to which this annotator should send its log output. Annotators
should use this facility rather than writing to their own log files (or to stdout).
AnnotatorContextException
- if an internal failure has occurred in the AnnotatorContext
.InstrumentationFacility getInstrumentationFacility() throws AnnotatorContextException
InstrumentationFacility
that this annotator can use to record
information about its performance.
AnnotatorContextException
- if an internal failure has occurred in the AnnotatorContext
.URL getResourceURL(String aKey) throws AnnotatorContextException
Note that if the URL contains spaces may be encoded as %20. The URL.getPath()
method
does NOT decode these sequences, therefore it is not safe to call
getResourceURL().getPath()
and attempt to use the result as a file path.
Instead, you may use getResourceURI(String)
or getResourceFilePath(String)
.
For backwards compatibility, if the key is not declared as a resource dependency, it is looked
up directly in the data path
and the class path. However, this usage is
deprecated and support may be dropped in future versions. ALL external resource dependencies
should be declared in the descriptor.
aKey
- the key by which the resource is identified. This key should be declared in the
<externalResourceDependencies> section of the descriptor.
URL
at which the named resource is located, null
if
the named resource could not be found.
AnnotatorContextException
UimaContext.getResourceURL(String)
URI getResourceURI(String aKey) throws AnnotatorContextException
This method is safer than getResourceURL(String)
in its treatment of file paths
containing spaces. This is because the URI.getPath()
does perform URL decoding of that
path (decoding %20 sequences to spaces) whereas URL.getPath()
does not.
For backwards compatibility, if the key is not declared as a resource dependency, it is looked
up directly in the data path
and the class path. However, this usage is
deprecated and support may be dropped in future versions. ALL external resource dependencies
should be declared in the descriptor.
aKey
- the key by which the resource is identified. This key should be declared in the
<externalResourceDependencies> section of the descriptor.
URI
at which the named resource is located, null
if
the named resource could not be found.
AnnotatorContextException
UimaContext.getResourceURI(String)
String getResourceFilePath(String aKey) throws AnnotatorContextException
This only works if the resource is a local file. If the resource is not a local file (for
example, it could be an http
URL, then an exception will be thrown.
URL decoding will be done on the file path, so it is safe to use this method for file paths
that contain spaces.
For backwards compatibility, if the key is not declared as a resource dependency, it is looked
up directly in the data path
and the class path. However, this usage is
deprecated and support may be dropped in future versions. ALL external resource dependencies
should be declared in the descriptor.
aKey
- the key by which the resource is identified. This key should be declared in the
<externalResourceDependencies> section of the descriptor.
null
if
the named resource could not be found.
AnnotatorContextException
UimaContext.getResourceFilePath(String)
InputStream getResourceAsStream(String aKey) throws AnnotatorContextException
For backwards compatibility, if the key is not declared as a resource dependency, it is looked
up directly in the data path
and the class path. However, this usage is
deprecated and support may be dropped in future versions. ALL external resource dependencies
should be declared in the descriptor.
aKey
- the key by which the resource is identified. This key should be declared in the
<externalResourceDependencies> section of the descriptor.
InputStream
for reading from the named resource, null
if the named resource could not be found. It is the caller's responsibility to close
this stream once it is no longer needed.
AnnotatorContextException
UimaContext.getResourceAsStream(String)
Object getResourceObject(String aKey) throws AnnotatorContextException
aKey
- the key by which the resource is identified. This key should be declared in the
<externalResourceDependencies> section of the descriptor.
aName
, null
if none.
AnnotatorContextException
UimaContext.getResourceObject(String)
URL getResourceURL(String aKey, String[] aParams) throws AnnotatorContextException
Note that if the URL contains spaces may be encoded as %20. The URL.getPath()
method
does NOT decode these sequences, therefore it is not safe to call
getResourceURL().getPath()
and attempt to use the result as a file path.
Instead, you may use getResourceURI(String)
or getResourceFilePath(String)
.
For backwards compatibility, if the key is not declared as a resource dependency, it is looked
up directly in the data path
and the class path. However, this usage is
deprecated and support may be dropped in future versions. ALL external resource dependencies
should be declared in the descriptor.
This version of this method takes an array of parameters used to further identify the resource. This can be used, for example, with resources that vary depending on the language of the document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in the component descriptor.
aKey
- the key by which the resource is identified. This key should be declared in the
<externalResourceDependencies> section of the descriptor.aParams
- parameters used to further identify the resource. When used to identify the language
for a <fileLanguageResourceSpecifier>, this array should contain a single element,
the ISO language code for the language of the document (e.g. "en", "de").
URL
at which the named resource is located, null
if
the named resource could not be found.
AnnotatorContextException
UimaContext.getResourceURL(String,String[])
URI getResourceURI(String aKey, String[] aParams) throws AnnotatorContextException
This method is safer than getResourceURL(String)
in its treatment of file paths
containing spaces. This is because the URI.getPath()
does perform URL decoding of that
path (decoding %20 sequences to spaces) whereas URL.getPath()
does not.
For backwards compatibility, if the key is not declared as a resource dependency, it is looked
up directly in the data path
and the class path. However, this usage is
deprecated and support may be dropped in future versions. ALL external resource dependencies
should be declared in the descriptor.
This version of this method takes an array of parameters used to further identify the resource. This can be used, for example, with resources that vary depending on the language of the document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in the component descriptor.
aKey
- the key by which the resource is identified. This key should be declared in the
<externalResourceDependencies> section of the descriptor.
URI
at which the named resource is located, null
if
the named resource could not be found.
AnnotatorContextException
UimaContext.getResourceURI(String,String[])
String getResourceFilePath(String aKey, String[] aParams) throws AnnotatorContextException
This only works if the resource is a local file. If the resource is not a local file (for
example, it could be an http
URL, then an exception will be thrown.
URL decoding will be done on the file path, so it is safe to use this method for file paths that contain spaces.
For backwards compatibility, if the key is not declared as a resource dependency, it is looked
up directly in the data path
and the class path. However, this usage is
deprecated and support may be dropped in future versions. ALL external resource dependencies
should be declared in the descriptor.
This version of this method takes an array of parameters used to further identify the resource. This can be used, for example, with resources that vary depending on the language of the document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in the component descriptor.
aKey
- the key by which the resource is identified. This key should be declared in the
<externalResourceDependencies> section of the descriptor.
null
if
the named resource could not be found.
AnnotatorContextException
UimaContext.getResourceFilePath(String,String[])
InputStream getResourceAsStream(String aKey, String[] aParams) throws AnnotatorContextException
For backwards compatibility, if the key is not declared as a resource dependency, it is looked
up directly in the data path
and the class path. However, this usage is
deprecated and support may be dropped in future versions. ALL external resource dependencies
should be declared in the descriptor.
This version of this method takes an array of parameters used to further identify the resource. This can be used, for example, with resources that vary depending on the language of the document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in the component descriptor.
aKey
- the key by which the resource is identified. This key should bd declared in the
<externalResourceDependencies> section of the descriptor.aParams
- parameters used to further identify the resource. When used to identify the language
for a <fileLanguageResourceSpecifier>, this array should contain a single element,
the ISO language code for the language of the document (e.g. "en", "de").
InputStream
for reading from the named resource, null
if the named resource could not be found. It is the caller's responsibility to close
this stream once it is no longer needed.
AnnotatorContextException
UimaContext.getResourceAsStream(String,String[])
Object getResourceObject(String aKey, String[] aParams) throws AnnotatorContextException
This version of this method takes an array of parameters used to further identify the resource. This can be used, for example, with resources that vary depending on the language of the document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in the component descriptor.
aKey
- the key by which the resource is identified. This key should be declared in the
<externalResourceDependencies> section of the descriptor.aParams
- parameters used to further identify the resource. When used to identify the language
for a <fileLanguageResourceSpecifier>, this array should contain a single element,
the ISO language code for the language of the document (e.g. "en", "de").
aName
, null
if none.
AnnotatorContextException
UimaContext.getResourceObject(String,String[])
String getDataPath() throws AnnotatorContextException
path.separator
character (; on windows, : on UNIX).
This method is intended to be used only for integration of legacy or third-party components
that have their own resource management facility. If possible, it is recommended that you use
the getResoureXXX
methods instead.
AnnotatorContextException
- if an internal failure has occurred in the AnnotatorContext
.@Deprecated SofaID mapToSofaID(String aSofaName)
CAS.getView(String)
, and the
framework will automatically do the necessary Sofa mappings.
aSofaName
- this component's name for a SofA
@Deprecated SofaID[] getSofaMappings()
CAS.getView(String)
, and the
framework will automatically do the necessary Sofa mappings.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |