001/** 
002 * Copyright (c) 2007-2008, 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;
025
026import java.net.URISyntaxException;
027
028import org.apache.uima.analysis_engine.AnalysisEngineProcessException;
029import org.apache.uima.cas.CAS;
030import org.apache.uima.cas.CASException;
031import org.apache.uima.jcas.JCas;
032
033/**
034 * <br>
035 * Copyright (c) 2007-2008, Regents of the University of Colorado <br>
036 * All rights reserved.
037 * 
038 * @author Philip Ogren
039 * @author Steven Bethard
040 * 
041 */
042public class ViewUriUtil {
043
044  /**
045   * The view where the document Uniform Resource Identifier is placed.
046   */
047  public static final String URI = "UriView";
048
049  /**
050   * Set the primary Uniform Resource Identifier for this CAS and all its views. This creates the
051   * view {@link #URI} and assigns the URI there.
052   * 
053   * @param cas
054   *          The CAS object.
055   * @param uri
056   *          The primary URI for the CAS and all its views.
057   */
058  public static void setURI(CAS cas, java.net.URI uri) {
059    CAS view = cas.createView(URI);
060    view.setSofaDataURI(uri.toString(), null);
061  }
062
063  /**
064   * Set the primary Uniform Resource Identifier for this JCas and all its views. This creates the
065   * view {@link #URI} and assigns the URI there.
066   * 
067   * @param jCas
068   *          The CAS object.
069   * @param uri
070   *          The primary URI for the CAS and all its views.
071   */
072  public static void setURI(JCas jCas, java.net.URI uri) {
073    ViewUriUtil.setURI(jCas.getCas(), uri);
074  }
075
076  /**
077   * Get the primary Uniform Resource Identifier for this JCas and all its views. This is obtained
078   * from the {@link #URI} view of the JCas.
079   * 
080   * @param jCas
081   *          The JCas object.
082   * @return The primary URI for the JCas and all its views.
083   */
084  public static java.net.URI getURI(JCas jCas) throws AnalysisEngineProcessException {
085    try {
086      return new java.net.URI(jCas.getView(URI).getSofaDataURI());
087    } catch (CASException e) {
088      throw new AnalysisEngineProcessException(e);
089    } catch (URISyntaxException e) {
090      throw new AnalysisEngineProcessException(e);
091    }
092  }
093}