de.tudarmstadt.ukp.dkpro.core.dictionaryannotator.semantictagging

Class SemanticTagResource

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.apache.uima.fit.component.Resource_ImplBase

de.tudarmstadt.ukp.dkpro.core.dictionaryannotator.semantictagging.SemanticTagResource

All Implemented Interfaces:

SemanticTagProvider, org.apache.uima.fit.component.ExternalResourceAware, org.apache.uima.resource.Resource

public class SemanticTagResource
extends org.apache.uima.fit.component.Resource_ImplBase
implements SemanticTagProvider

This shared resource can be added as ExternalResource in Analysis Engines that annotate tokens with semantic tags looked up in a key-value map e.g., to annotate common nouns with semantic field information from WordNet.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_RESOURCE_PATH

Fields inherited from interface org.apache.uima.resource.Resource

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 Summary

Constructors

Constructor and Description
SemanticTagResource()

Method Summary

Modifier and Type	Method and Description
String	getSemanticTag(List<Token> tokens) Get a semantic tag for a list of tokens (e.g.
String	getSemanticTag(Token token) Get a semantic tag for a token.
boolean	initialize(org.apache.uima.resource.ResourceSpecifier aSpecifier, Map aAdditionalParams)

Methods inherited from class org.apache.uima.fit.component.Resource_ImplBase

afterResourcesInitialized, getLogger, getResourceName

Methods inherited from class org.apache.uima.resource.Resource_ImplBase

destroy, getCasManager, getMetaData, getRelativePathResolver, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger, setMetaData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAM_RESOURCE_PATH

public static final String PARAM_RESOURCE_PATH

See Also:

Constant Field Values

Constructor Detail

SemanticTagResource

public SemanticTagResource()

Method Detail

initialize

public boolean initialize(org.apache.uima.resource.ResourceSpecifier aSpecifier,
                          Map aAdditionalParams)
                   throws org.apache.uima.resource.ResourceInitializationException

Specified by:

initialize in interface org.apache.uima.resource.Resource

Overrides:

initialize in class org.apache.uima.fit.component.Resource_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

getSemanticTag

public String getSemanticTag(Token token)
                      throws org.apache.uima.resource.ResourceAccessException

Description copied from interface: SemanticTagProvider

Get a semantic tag for a token.

Specified by:

getSemanticTag in interface SemanticTagProvider

Parameters:

token - token to tag

Returns:

semantic tag of the token. Returns "UNKNOWN" if the (lemma of the) token does not exist in the resource.

Throws:

org.apache.uima.resource.ResourceAccessException - if the semantic resource cannot be accessed.

getSemanticTag

public String getSemanticTag(List<Token> tokens)
                      throws org.apache.uima.resource.ResourceAccessException

Description copied from interface: SemanticTagProvider

Get a semantic tag for a list of tokens (e.g. a multiword).

Specified by:

getSemanticTag in interface SemanticTagProvider

Parameters:

tokens - list of tokens to tag

Returns:

semantic tag of the multiword. Returns "UNKNOWN" if the (lemma of the) multiword does not exist in the resource.

Throws:

org.apache.uima.resource.ResourceAccessException - if the semantic resource cannot be accessed.