ctakes-core/desc/analysis_engine/PiperFileRunEngine.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.

-->
<!--  Piper Files should be used to create ctakes pipelines.
      If some non-ctakes tool like UIMA CPE/CVD requires an XML descriptor file then this can be used.   -->
<!--    Make a copy of this abstract descriptor PiperFileRunEngine.xml
        and add your normal command line parameters for running a piper file.
        Make the change below, substituting for CHANGE_ME. -->
<taeDescription xmlns="http://uima.apache.org/resourceSpecifier">
   <frameworkImplementation>org.apache.uima.java</frameworkImplementation>
   <primitive>true</primitive>
   <annotatorImplementationName>org.apache.ctakes.core.ae.PiperFileRunEngine</annotatorImplementationName>
   <analysisEngineMetaData>
      <name>PiperFileRunEngine</name>
      <description>Runs a pipeline via a piper file.</description>
      <version>1.0</version>
      <vendor/>
      <configurationParameters>
         <configurationParameter>
            <name>PiperParams</name>
            <description>Command Line parameters for piper.  e.g. -p piperFile -i inputDir -o outputDir</description>
            <type>String</type>
            <multiValued>false</multiValued>
            <mandatory>true</mandatory>
         </configurationParameter>
      </configurationParameters>
      <configurationParameterSettings>
         <nameValuePair>
            <name>PiperParams</name>
            <value>
<!--    You must provide the path to the piper file at the very least!!  -p piperFile   -->
               <string>CHANGE_ME</string>
            </value>
         </nameValuePair>
      </configurationParameterSettings>
      <!--  As far as I can tell everything that follows is superfluous  -->
      <typeSystemDescription>
         <imports>
            <import name="org.apache.ctakes.typesystem.types.TypeSystem"/>
         </imports>
      </typeSystemDescription>
      <typePriorities/>
      <fsIndexCollection/>
      <capabilities>
         <capability>
            <inputs/>
            <outputs/>
            <languagesSupported/>
         </capability>
      </capabilities>
      <operationalProperties>
         <modifiesCas>true</modifiesCas>
         <multipleDeploymentAllowed>true</multipleDeploymentAllowed>
         <outputsNewCASes>false</outputsNewCASes>
      </operationalProperties>
   </analysisEngineMetaData>
   <resourceManagerConfiguration/>
</taeDescription>