001/*
002 * Copyright (c) 2014, 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.File;
027import java.io.IOException;
028
029import org.apache.uima.analysis_engine.AnalysisEngineDescription;
030import org.apache.uima.analysis_engine.AnalysisEngineProcessException;
031import org.apache.uima.fit.component.JCasAnnotator_ImplBase;
032import org.apache.uima.fit.descriptor.ConfigurationParameter;
033import org.apache.uima.fit.factory.AnalysisEngineFactory;
034import org.apache.uima.fit.util.CasIOUtil;
035import org.apache.uima.jcas.JCas;
036import org.apache.uima.resource.ResourceInitializationException;
037import org.cleartk.util.ViewUriUtil;
038
039import com.google.common.annotations.Beta;
040
041/**
042 * This is a simple annotator for writing out XMI files, used by the parsing examples.
043 * 
044 * <br>
045 * Copyright (c) 2014, Regents of the University of Colorado <br>
046 * All rights reserved.
047 * 
048 * @author Steven Bethard
049 * @author Philip Ogren
050 */
051
052@Beta
053public class XmiWriter extends JCasAnnotator_ImplBase {
054
055  public static AnalysisEngineDescription getDescription(File outputDirectory)
056      throws ResourceInitializationException {
057    return AnalysisEngineFactory.createEngineDescription(
058        XmiWriter.class,
059        XmiWriter.PARAM_OUTPUT_DIRECTORY,
060        outputDirectory);
061  }
062
063  public static final String PARAM_OUTPUT_DIRECTORY = "outputDirectory";
064
065  @ConfigurationParameter(name = PARAM_OUTPUT_DIRECTORY)
066  protected File outputDirectory;
067
068  @Override
069  public void process(JCas jCas) throws AnalysisEngineProcessException {
070    try {
071      File xmiFile = getXmiFile(jCas);
072      CasIOUtil.writeXmi(jCas, xmiFile);
073    } catch (IOException e) {
074      throw new AnalysisEngineProcessException(e);
075    }
076  }
077
078  protected File getXmiFile(JCas jCas) throws AnalysisEngineProcessException {
079    return new File(this.outputDirectory, ViewUriUtil.getURI(jCas).getFragment() + ".xmi");
080  }
081
082}