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 java.util.ArrayList;
027import java.util.List;
028
029import org.apache.uima.jcas.JCas;
030import org.apache.uima.jcas.tcas.Annotation;
031import org.cleartk.syntax.constituent.type.TopTreebankNode;
032
033import com.google.common.annotations.Beta;
034
035/**
036 * <br>
037 * Copyright (c) 2007-2008, Regents of the University of Colorado <br>
038 * All rights reserved.
039 * 
040 * 
041 * <p>
042 * A <em>PropbankCorefRelation object</em> represents a reference to multiple relations that are
043 * part of a coreferenced argument in Propbank.
044 * </p>
045 * 
046 * @author Philipp Wetzler
047 */
048@Beta
049public class PropbankCorefRelation extends PropbankRelation {
050
051  public static PropbankCorefRelation fromString(String s) {
052    PropbankCorefRelation rel = new PropbankCorefRelation();
053    String[] fields = s.split("\\*");
054    for (String field : fields) {
055      rel.addCorefRelation(PropbankRelation.fromString(field));
056    }
057    return rel;
058  }
059
060  protected List<PropbankRelation> corefRelations;
061
062  public PropbankCorefRelation() {
063    this.corefRelations = new ArrayList<PropbankRelation>();
064  }
065
066  public List<PropbankRelation> getCorefRelations() {
067    return this.corefRelations;
068  }
069
070  public void addCorefRelation(PropbankRelation rel) {
071    this.corefRelations.add(rel);
072  }
073
074  /**
075   * This is not implemented for PropbankCorefRelation and will always throw
076   * {@link UnsupportedOperationException}. Instead, the conversion of a PropbankCorefRelation
077   * happens during Predicate conversion.
078   */
079  @Override
080  public Annotation convert(JCas jCas, TopTreebankNode topNode) {
081    throw new UnsupportedOperationException();
082  }
083
084  @Override
085  public String toString() {
086    StringBuffer buffer = new StringBuffer();
087
088    boolean first = true;
089    for (PropbankRelation rel : getCorefRelations()) {
090      if (!first)
091        buffer.append("*");
092      buffer.append(rel.toString());
093      first = false;
094    }
095
096    return buffer.toString();
097  }
098
099}