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.preditor.text;
016    
017    /**
018     * This class represents referenceable text elements that contain a noun. One can refer to such
019     * text elements with "the" plus the respective noun, e.g. "the customer" in the case of the noun
020     * "customer". If the text element is followed by a {@link VarTextElement} then the variable is
021     * also included in the reference text, e.g. "the customer X" if the variable has the name "X".
022     * 
023     * @author Tobias Kuhn
024     */
025    public class NounTextElement extends BasicTextElement implements RefableTextElement {
026            
027            private VarTextElement varTextElement;
028            
029            /**
030             * Creates a new noun text element.
031             * 
032             * @param noun The noun.
033             * @param category The category.
034             */
035            public NounTextElement(String noun, String category) {
036                    super(noun, category);
037            }
038    
039            public void checkNeighborTextElements(TextElement precedingTextElement, TextElement nextTextElement) {
040                    if (nextTextElement instanceof VarTextElement) {
041                            this.varTextElement = (VarTextElement) nextTextElement;
042                    } else {
043                            this.varTextElement = null;
044                    }
045            }
046    
047            public String getReferenceText() {
048                    if (varTextElement == null) {
049                            return "the " + getText();
050                    }
051                    return "the " + getText() + " " + varTextElement.getText();
052            }
053    
054    }