001/*
002 * Copyright (c) 2012, Regents of the University of Colorado 
003 * All rights reserved.
004 * 
005 * Redistribution and use in source and binary forms, with or without
006 * modification, are permitted provided that the following conditions are met:
007 * 
008 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
009 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 
010 * Neither the name of the University of Colorado at Boulder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 
011 * 
012 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
013 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
014 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
015 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
016 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
017 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
018 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
019 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
020 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
021 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
022 * POSSIBILITY OF SUCH DAMAGE. 
023 */
024package org.cleartk.clearnlp;
025
026
027import org.apache.uima.analysis_engine.AnalysisEngineDescription;
028import org.apache.uima.resource.ResourceInitializationException;
029import org.cleartk.token.type.Token;
030import org.apache.uima.fit.descriptor.TypeCapability;
031import org.apache.uima.fit.factory.AnalysisEngineFactory;
032
033/**
034 * <br>
035 * Copyright (c) 2012, Regents of the University of Colorado <br>
036 * All rights reserved.
037 * <p>
038 * This class provides a UIMA/ClearTK wrapper for the ClearNLP morphological analyzer. This engine
039 * requires POS-tagged tokens and produces lemmatized forms of said tokens.
040 * 
041 * This analyzer is available here:
042 * <p>
043 * http://clearnlp.googlecode.com
044 * <p>
045* 
046 * @author Lee Becker
047 * 
048 */
049@TypeCapability(
050    inputs = { "org.cleartk.token.type.Token:pos" },
051    outputs = {"org.cleartk.token.type.Token:lemma"})
052public class MpAnalyzer extends MpAnalyzer_ImplBase<Token> {
053        
054        public static final String DEFAULT_DICTIONARY_FILE_NAME= "dictionary-1.2.0.zip";
055        
056        /**
057         * Convenience method to create Analysis Engine for ClearNLP's POSTagger + Lemmatizer using default English models and dictionaries.
058         */
059        public static AnalysisEngineDescription getDescription() throws ResourceInitializationException {
060                return AnalysisEngineFactory.createEngineDescription(MpAnalyzer.class);
061        }
062        
063        public static AnalysisEngineDescription getDescription(String langCode) throws ResourceInitializationException {
064          return AnalysisEngineFactory.createEngineDescription(MpAnalyzer.class, 
065              MpAnalyzer_ImplBase.PARAM_LANGUAGE_CODE, langCode);
066        }
067
068  public MpAnalyzer() {
069    super(new CleartkTokenOps());
070  }
071}