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.opennlp.tools;
025
026import opennlp.uima.tokenize.TokenizerModelResourceImpl;
027
028import org.apache.uima.analysis_engine.AnalysisEngineDescription;
029import org.apache.uima.resource.ResourceInitializationException;
030import org.cleartk.token.type.Sentence;
031import org.cleartk.token.type.Token;
032import org.apache.uima.fit.factory.AnalysisEngineFactory;
033import org.apache.uima.fit.factory.ExternalResourceFactory;
034
035import com.google.common.annotations.Beta;
036
037/**
038 * An OpenNLP {@link opennlp.tools.tokenize.Tokenizer} that uses the ClearTK type system.
039 * 
040 * <br>
041 * Copyright (c) 2012, Regents of the University of Colorado <br>
042 * All rights reserved.
043 * 
044 * @author Steven Bethard
045 */
046@Beta
047public class Tokenizer {
048  public static AnalysisEngineDescription getDescription(String languageCode)
049      throws ResourceInitializationException {
050    String modelPath = String.format("/models/%s-token.bin", languageCode);
051    return AnalysisEngineFactory.createEngineDescription(
052        opennlp.uima.tokenize.Tokenizer.class,
053        opennlp.uima.util.UimaUtil.MODEL_PARAMETER,
054        ExternalResourceFactory.createExternalResourceDescription(
055            TokenizerModelResourceImpl.class,
056            Tokenizer.class.getResource(modelPath).toString()),
057        opennlp.uima.util.UimaUtil.SENTENCE_TYPE_PARAMETER,
058        Sentence.class.getName(),
059        opennlp.uima.util.UimaUtil.TOKEN_TYPE_PARAMETER,
060        Token.class.getName());
061  }
062}