001    // This file is part of the Attempto Java Packages.
002    // Copyright 2008, Attempto Group, University of Zurich (see http://attempto.ifi.uzh.ch).
003    //
004    // The Attempto Java Packages is free software: you can redistribute it and/or modify it under the
005    // terms of the GNU Lesser General Public License as published by the Free Software Foundation,
006    // either version 3 of the License, or (at your option) any later version.
007    //
008    // The Attempto Java Packages is distributed in the hope that it will be useful, but WITHOUT ANY
009    // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
010    // PURPOSE. See the GNU Lesser General Public License for more details.
011    //
012    // You should have received a copy of the GNU Lesser General Public License along with the Attempto
013    // Java Packages. If not, see http://www.gnu.org/licenses/.
014    
015    package ch.uzh.ifi.attempto.acewiki.core.text;
016    
017    import ch.uzh.ifi.attempto.acewiki.core.ontology.OntologyElement;
018    import ch.uzh.ifi.attempto.preditor.text.TextElement;
019    
020    /**
021     * This class represents a text element that links to an ontology element. The text of
022     * the text elements corresponds to one of the word forms of the ontology element.
023     * 
024     * @author Tobias Kuhn
025     */
026    public interface OntologyTextElement extends TextElement {
027    
028            /**
029             * Returns the ontology element to which this text element is linked.
030             * 
031             * @return The ontology element.
032             */
033            public OntologyElement getOntologyElement();
034            
035            /**
036             * Returns the id of the word form of the ontology element that is used for this
037             * text element.
038             * 
039             * @return The word form id.
040             */
041            public int getWordNumber();
042            
043            /**
044             * Returns the text of this text element in its plain form where underscores are not
045             * replaces by blanks.
046             * 
047             * @return The plain text.
048             */
049            public String getUnderscoredText();
050            
051    }