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.corpus.propbank.util;
025
026import org.apache.uima.jcas.JCas;
027import org.apache.uima.jcas.tcas.Annotation;
028import org.cleartk.syntax.constituent.type.TopTreebankNode;
029
030import com.google.common.annotations.Beta;
031
032/**
033 * <br>
034 * Copyright (c) 2007-2008, Regents of the University of Colorado <br>
035 * All rights reserved.
036 * 
037 * 
038 * 
039 * <p>
040 * A <em>PropbankRelation object</em> represents the relation (or a sub-relation) of one label of an
041 * entry in Propbank.
042 * </p>
043 * 
044 * @author Philipp Wetzler
045 */
046@Beta
047public abstract class PropbankRelation {
048  /**
049   * Parses a relation taken form a Propbank entry and returns its representation as the appropriate
050   * <em>PropbankRelation</em> object.
051   * 
052   * @param s
053   *          the textual representation of a relation taken from <tt>prop.txt</tt>
054   * 
055   * @return a <em>PropbankRelation</em> object representing <b>s</b>
056   */
057  public static PropbankRelation fromString(String s) {
058    if (s.contains("*")) {
059      return PropbankCorefRelation.fromString(s);
060    } else if (s.contains(",")) {
061      return PropbankSplitRelation.fromString(s);
062    } else if (s.contains(":")) {
063      return PropbankNodeRelation.fromString(s);
064    } else {
065      return PropbankTerminalRelation.fromString(s);
066    }
067  }
068
069  /**
070   * Convert to an appropriate ClearTK annotation and add it to <b>jCas</b> if necessary.
071   * 
072   * @param jCas
073   *          the view where the annotation will be added
074   * @param topNode
075   *          the top node annotation of the corresponding Treebank parse
076   * @return the corresponding annotation
077   */
078  public abstract Annotation convert(JCas jCas, TopTreebankNode topNode);
079
080  /**
081   * Re-generate the text that this object was parsed from.
082   */
083  @Override
084  public abstract String toString();
085}