content: // This file is part of AceWiki.
  // Copyright 2008-2013, AceWiki developers.
  // 
  // AceWiki is free software: you can redistribute it and/or modify it under the terms of the GNU
  // Lesser General Public License as published by the Free Software Foundation, either version 3 of
  // the License, or (at your option) any later version.
  // 
  // AceWiki is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
  // even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  // Lesser General Public License for more details.
  // 
  // You should have received a copy of the GNU Lesser General Public License along with AceWiki. If
  // not, see http://www.gnu.org/licenses/.
  
  package ch.uzh.ifi.attempto.acewiki.core;
  
  import java.util.List;
  import java.util.Locale;
  
  import ch.uzh.ifi.attempto.base.PredictiveParser;
  import ch.uzh.ifi.attempto.base.TextContainer;
  import ch.uzh.ifi.attempto.base.TextOperator;
  
  /**
   * This interface represents the language-specific parts of the AceWiki engine.
   * 
   * @author Tobias Kuhn
   */
  public interface LanguageHandler {
  
  	/**
  	 * This is the first method to be called and provides the ontology object.
  	 * 
  	 * @param ontology The ontology object.
  	 */
  	public void init(Ontology ontology);
  	
  	/**
  	 * Returns the text operator.
  	 * 
  	 * @return The text operator.
  	 */
  	public TextOperator getTextOperator();
  	
  	/**
  	 * Returns the language of this language handler. Null can be returned for monolingual engines.
  	 * 
  	 * @return The language identifier.
  	 */
  	public String getLanguage();
  
  	/**
  	 * Returns the name of the language in the form to be shown in the list of languages.
  	 * 
  	 * @return The name of the language.
  	 */
  	public String getLanguageName();
  
  	/**
  	 * Returns the locale for this language handler.
  	 * 
  	 * @return The locale.
  	 */
  	public Locale getLocale();
  	
  	/**
  	 * Extracts the sentences from a text container and/or a parser state.
  	 * 
  	 * @param tc The text container.
  	 * @param parser The parser object with the parsed text.
  	 * @return A list of sentences.
  	 */
  	public List<Sentence> extractSentences(TextContainer tc, PredictiveParser parser);
  	
  	/**
  	 * Returns the predictive parser to be used within the predictive editor.
  	 * 
  	 * @return The predictive parser.
  	 */
  	public PredictiveParser getPredictiveParser();
  	
  	/**
  	 * Returns the controller object for the predictive editor.
  	 * 
  	 * @return The editor controller.
  	 */
  	public EditorController getEditorController();
  	
  	/**
  	 * Returns a lexicon changer object for the given lexical type.
  	 * 
  	 * @param type The lexical type.
  	 * @return A lexicon changer object.
  	 */
  	public LexiconChanger getLexiconChanger(String type);
  	
  	/**
  	 * Returns a suggestion to change a newly created sentence, or null (no suggestion).
  	 * 
  	 * @param sentence The newly created sentence.
  	 * @return A suggestion to change the sentence or null.
  	 */
  	public SentenceSuggestion getSuggestion(Sentence sentence);
  
  }
  