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.util.ae;
025
026import java.io.IOException;
027import java.io.InputStreamReader;
028import java.net.MalformedURLException;
029import java.net.URI;
030
031import org.apache.uima.analysis_engine.AnalysisEngineDescription;
032import org.apache.uima.analysis_engine.AnalysisEngineProcessException;
033import org.apache.uima.cas.CAS;
034import org.apache.uima.fit.component.JCasAnnotator_ImplBase;
035import org.apache.uima.fit.component.ViewCreatorAnnotator;
036import org.apache.uima.fit.factory.AggregateBuilder;
037import org.apache.uima.fit.factory.AnalysisEngineFactory;
038import org.apache.uima.jcas.JCas;
039import org.apache.uima.resource.ResourceInitializationException;
040import org.cleartk.util.ViewUriUtil;
041
042import com.google.common.io.CharStreams;
043
044/**
045 * <br>
046 * Copyright (c) 2012, Regents of the University of Colorado <br>
047 * All rights reserved.
048 * <p>
049 * 
050 * This Analysis Engine reads in the contents of the URI in the default sofa, and puts it in the CAS
051 * 
052 * @author Lee Becker
053 * 
054 */
055public class UriToDocumentTextAnnotator extends JCasAnnotator_ImplBase {
056
057  public static AnalysisEngineDescription getDescription() throws ResourceInitializationException {
058    return AnalysisEngineFactory.createEngineDescription(UriToDocumentTextAnnotator.class);
059  }
060
061  /**
062   * This description will read the contents into the specify view. If the view does not exist, it
063   * will make it as needed.
064   */
065  public static AnalysisEngineDescription getDescriptionForView(String targetViewName)
066      throws ResourceInitializationException {
067    AggregateBuilder builder = new AggregateBuilder();
068    builder.add(AnalysisEngineFactory.createEngineDescription(
069        ViewCreatorAnnotator.class,
070        ViewCreatorAnnotator.PARAM_VIEW_NAME,
071        targetViewName));
072    builder.add(UriToDocumentTextAnnotator.getDescription(), CAS.NAME_DEFAULT_SOFA, targetViewName);
073    return builder.createAggregateDescription();
074  }
075
076  @Override
077  public void process(JCas jCas) throws AnalysisEngineProcessException {
078
079    URI uri = ViewUriUtil.getURI(jCas);
080    String content;
081
082    try {
083      content = CharStreams.toString(new InputStreamReader(uri.toURL().openStream()));
084      jCas.setSofaDataString(content, "text/plain");
085    } catch (MalformedURLException e) {
086      throw new AnalysisEngineProcessException(e);
087    } catch (IOException e) {
088      throw new AnalysisEngineProcessException(e);
089    }
090  }
091}