MstParser (DKPro Core - Master Aggregator 1.7.0 API)

java.lang.Object
- org.apache.uima.analysis_component.AnalysisComponent_ImplBase
- - org.apache.uima.analysis_component.Annotator_ImplBase
  - - org.apache.uima.analysis_component.JCasAnnotator_ImplBase
    - - org.apache.uima.fit.component.JCasConsumer_ImplBase
      - de.tudarmstadt.ukp.dkpro.core.mstparser.MstParser

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent
```
public class MstParser
extends org.apache.uima.fit.component.JCasConsumer_ImplBase
```
Wrapper for the MSTParser (high memory requirements). More information about the parser can be found here here

The MSTParser models tend to be very large, e.g. the Eisner model is about 600 MB uncompressed. With this model, parsing a simple sentence with MSTParser requires about 3 GB heap memory.

This component feeds MSTParser only with the FORM (token) and POS (part-of-speech) fields. LEMMA, CPOS, and other columns from the CONLL 2006 format are not generated (cf. DependencyInstance).

Author:

beinborn, zesch

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`dependencyMappingLocation`
`protected String`	`language`
`protected String`	`modelLocation`
`static String`	`PARAM_DEPENDENCY_MAPPING_LOCATION` Load the dependency to UIMA type mapping from this location instead of locating the mapping automatically.
`static String`	`PARAM_LANGUAGE` Use this language instead of the document language to resolve the model.
`static String`	`PARAM_MODEL_LOCATION` Load the model from this location instead of locating the model automatically.
`static String`	`PARAM_ORDER` Specifies the order/scope of features.
`static String`	`PARAM_PRINT_TAGSET` Log the tag set(s) when a model is loaded.
`static String`	`PARAM_VARIANT` Override the default variant used to locate the model.
`protected boolean`	`printTagSet`
`protected String`	`variant`

Constructor Summary

Constructors
Constructor and Description

MstParser()

Constructors
Constructor and Description
`MstParser()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`initialize(org.apache.uima.UimaContext context)` Initializes the MSTParser and creates a ModelResourceProvicer
`void`	`process(org.apache.uima.jcas.JCas jcas)` Processes the given text using the MSTParser.

Methods inherited from class org.apache.uima.fit.component.JCasConsumer_ImplBase
getLogger

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase
getRequiredCasInterface, process

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase
getCasInstancesRequired, hasNext, next

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase
batchProcessComplete, collectionProcessComplete, destroy, getContext, getResultSpecification, reconfigure, setResultSpecification

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

- Field Detail
  - PARAM_LANGUAGE
```
public static final String PARAM_LANGUAGE
```
    Use this language instead of the document language to resolve the model.
    
    See Also:
    Constant Field Values
  - language
```
protected String language
```
  - PARAM_VARIANT
```
public static final String PARAM_VARIANT
```
    Override the default variant used to locate the model.
    
    See Also:
    Constant Field Values
  - variant
```
protected String variant
```
  - PARAM_MODEL_LOCATION
```
public static final String PARAM_MODEL_LOCATION
```
    Load the model from this location instead of locating the model automatically.
    
    See Also:
    Constant Field Values
  - modelLocation
```
protected String modelLocation
```
  - PARAM_PRINT_TAGSET
```
public static final String PARAM_PRINT_TAGSET
```
    Log the tag set(s) when a model is loaded. Default: false
    
    See Also:
    Constant Field Values
  - printTagSet
```
protected boolean printTagSet
```
  - PARAM_DEPENDENCY_MAPPING_LOCATION
```
public static final String PARAM_DEPENDENCY_MAPPING_LOCATION
```
    Load the dependency to UIMA type mapping from this location instead of locating the mapping automatically.
    
    See Also:
    Constant Field Values
  - dependencyMappingLocation
```
protected String dependencyMappingLocation
```
  - PARAM_ORDER
```
public static final String PARAM_ORDER
```
    Specifies the order/scope of features. 1 only has features over single edges and 2 has features over pairs of adjacent edges in the tree. The model must have been trained with the respective order set here.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - MstParser
```
public MstParser()
```
- Method Detail
  - initialize
```
public void initialize(org.apache.uima.UimaContext context)
                throws org.apache.uima.resource.ResourceInitializationException
```
    Initializes the MSTParser and creates a ModelResourceProvicer
    
    Specified by:
    
    initialize in interface org.apache.uima.analysis_component.AnalysisComponent
    
    Overrides:
    
    initialize in class org.apache.uima.fit.component.JCasConsumer_ImplBase
    
    Throws:
    
    org.apache.uima.resource.ResourceInitializationException - Cannot be initialized
  - process
```
public void process(org.apache.uima.jcas.JCas jcas)
             throws org.apache.uima.analysis_engine.AnalysisEngineProcessException
```
    Processes the given text using the MSTParser. As the MSTParser expects an input file, a temporary file is created.
    
    Specified by:
    
    process in class org.apache.uima.analysis_component.JCasAnnotator_ImplBase
    
    Parameters:
    jcas - The JCas containing the textual input
    
    Throws:
    
    org.apache.uima.analysis_engine.AnalysisEngineProcessException - No parse created

Class MstParser

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

Methods inherited from class java.lang.Object

Field Detail

PARAM_LANGUAGE

language

PARAM_VARIANT

variant

PARAM_MODEL_LOCATION

modelLocation

PARAM_PRINT_TAGSET

printTagSet

PARAM_DEPENDENCY_MAPPING_LOCATION

dependencyMappingLocation

PARAM_ORDER

Constructor Detail

MstParser

Method Detail

initialize

process