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.syntax.dependency.type.DependencyNode;
030import org.cleartk.syntax.dependency.type.DependencyRelation;
031import org.cleartk.syntax.dependency.type.TopDependencyNode;
032import org.cleartk.token.type.Sentence;
033import org.cleartk.token.type.Token;
034import org.apache.uima.fit.descriptor.TypeCapability;
035import org.apache.uima.fit.factory.AnalysisEngineFactory;
036
037/**
038 * <br>
039 * Copyright (c) 2012, Regents of the University of Colorado <br>
040 * All rights reserved.
041 * <p>
042 * This class provides a UIMA/ClearTK wrapper for the ClearNLP dependency parser that outputs to the ClearTK type system. A typical
043 * pipeline preceding this analysis engine would consist of a tokenizer, sentence segmenter,
044 * POS tagger, and lemmatizer (mp analyzer).
045 * <p>
046 * This parser is available here:
047 * <p>
048 * http://clearnlp.googlecode.com
049 * <p>
050* 
051 * @author Lee Becker
052 * 
053 */
054@TypeCapability(
055    inputs = { 
056        "org.cleartk.token.type.Sentence", 
057        "org.cleartk.token.type.Token:pos", 
058        "org.cleartk.token.type.Token:lemma" },
059    outputs = { 
060        "org.cleartk.syntax.dependency.type.TopDependencyNode",
061        "org.cleartk.syntax.dependency.type.DependencyNode", 
062        "org.cleartk.syntax.dependency.type.DependencyNode"})
063public class DependencyParser extends DependencyParser_ImplBase<Sentence, Token, DependencyNode, TopDependencyNode, DependencyRelation> {
064
065  /**
066   * Convenience method for creating Analysis Engine for ClearNLP's dependency parser using default English model files
067   */
068  public static AnalysisEngineDescription getDescription() throws ResourceInitializationException {
069    return AnalysisEngineFactory.createEngineDescription(DependencyParser.class);
070  }
071  
072  public static AnalysisEngineDescription getDescription(String languageCode, String modelPath) throws ResourceInitializationException {
073    return AnalysisEngineFactory.createEngineDescription(DependencyParser.class,
074        DependencyParser_ImplBase.PARAM_LANGUAGE_CODE,
075        languageCode,
076        DependencyParser_ImplBase.PARAM_PARSER_MODEL_PATH,
077        modelPath);
078  }
079
080  public DependencyParser() {
081    super(new CleartkTokenOps(), new CleartkDependencyOps());
082  }
083}