uimaj-2.2.0-incubating/uimaj-examples/src/main/opennlp_wrappers/descriptors/OpenNLPNEDetector.xml

<?xml version="1.0" encoding="UTF-8"?>

	<!--
	 ***************************************************************
	 * Licensed to the Apache Software Foundation (ASF) under one
	 * or more contributor license agreements.  See the NOTICE file
	 * distributed with this work for additional information
	 * regarding copyright ownership.  The ASF licenses this file
	 * to you under the Apache License, Version 2.0 (the
	 * "License"); you may not use this file except in compliance
	 * with the License.  You may obtain a copy of the License at
         *
	 *   http://www.apache.org/licenses/LICENSE-2.0
	 * 
	 * Unless required by applicable law or agreed to in writing,
	 * software distributed under the License is distributed on an
	 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	 * KIND, either express or implied.  See the License for the
	 * specific language governing permissions and limitations
	 * under the License.
	 ***************************************************************
   -->
   
<analysisEngineDescription xmlns="http://uima.apache.org/resourceSpecifier">
  <frameworkImplementation>org.apache.uima.java</frameworkImplementation>
  <primitive>true</primitive>
  <annotatorImplementationName>org.apache.uima.examples.opennlp.annotator.NEDetector</annotatorImplementationName>
  <analysisEngineMetaData>
    <name>OpenNLPNEDetector</name>
    <description>Detects named entities in text and creates corresponding entity annotations that span the found entities.  Uses the OpenNLP MaxEnt named entity Detector.  Each entity class has a separate MaxEnt model file.  All model files must be stored in a single model file directory and use the following naming convention: "class.bin.gz", where "class" is the entity class name and ".bin.gz" must appear as shown, e.g., "person.bin.gz".  

This analysis engine takes a parameter called "EntityTypeMapping" which maps each entity class name to an entity annotation type.  The entity class name must match a model file in the model file directory, and the entity annotation type must be defined in the type system and have a corresponding JCas Java class.</description>
    <version>1.0</version>
    <vendor>The Apache Software Foundation</vendor>
    <configurationParameters>
      <configurationParameter>
        <name>ModelDirectory</name>
        <type>String</type>
        <multiValued>false</multiValued>
        <mandatory>true</mandatory>
      </configurationParameter>
      <configurationParameter>
        <name>EntityTypeMappings</name>
        <description>Mapping from entity names (obtained from the model filename) to the JCas class for the corresponding annotation.  Each mapping string is of the form "name,class", i.e., the entity type name followed by a comma followed by the annotation class.</description>
        <type>String</type>
        <multiValued>true</multiValued>
        <mandatory>false</mandatory>
      </configurationParameter>
    </configurationParameters>
    <configurationParameterSettings>
      <nameValuePair>
        <name>ModelDirectory</name>
        <value>
          <string>C:\opennlp-models-1.3.0\english\namefind</string>
        </value>
      </nameValuePair>
      <nameValuePair>
        <name>EntityTypeMappings</name>
        <value>
          <array>
            <string>person,org.apache.uima.examples.opennlp.Person</string>
            <string>organization,org.apache.uima.examples.opennlp.Organization</string>
            <string>location,org.apache.uima.examples.opennlp.Location</string>
            <string>date,org.apache.uima.examples.opennlp.Date</string>
            <string>money,org.apache.uima.examples.opennlp.Money</string>
            <string>percentage,org.apache.uima.examples.opennlp.Percentage</string>
            <string>time,org.apache.uima.examples.opennlp.Time</string>
          </array>
        </value>
      </nameValuePair>
    </configurationParameterSettings>
    <typeSystemDescription>
      <imports>
        <import name="org.apache.uima.examples.opennlp.OpenNLPExampleTypes"/>
      </imports>
    </typeSystemDescription>
    <capabilities>
      <capability>
        <inputs>
          <type>org.apache.uima.examples.opennlp.Sentence</type>
          <type>org.apache.uima.examples.opennlp.Token</type>
        </inputs>
        <outputs>
          <type allAnnotatorFeatures="true">org.apache.uima.examples.opennlp.Person</type>
          <type allAnnotatorFeatures="true">org.apache.uima.examples.opennlp.Organization</type>
          <type allAnnotatorFeatures="true">org.apache.uima.examples.opennlp.Time</type>
          <type allAnnotatorFeatures="true">org.apache.uima.examples.opennlp.Date</type>
          <type allAnnotatorFeatures="true">org.apache.uima.examples.opennlp.Location</type>
          <type allAnnotatorFeatures="true">org.apache.uima.examples.opennlp.Percentage</type>
          <type allAnnotatorFeatures="true">org.apache.uima.examples.opennlp.Money</type>
        </outputs>
        <languagesSupported/>
      </capability>
    </capabilities>
    <operationalProperties>
      <modifiesCas>true</modifiesCas>
      <multipleDeploymentAllowed>true</multipleDeploymentAllowed>
    </operationalProperties>
  </analysisEngineMetaData>
</analysisEngineDescription>