View Javadoc

1   /*
2    * Copyright (C) 2004 Christian Siefkes <christian@siefkes.net>.
3    * Development of this software is supported by the German Research Society,
4    * Berlin-Brandenburg Graduate School in Distributed Information Systems
5    * (DFG grant no. GRK 316).
6    *
7    * This library is free software; you can redistribute it and/or
8    * modify it under the terms of the GNU Lesser General Public
9    * License as published by the Free Software Foundation; either
10   * version 2.1 of the License, or (at your option) any later version.
11   *
12   * This library is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15   * Lesser General Public License for more details.
16   *
17   * You should have received a copy of the GNU Lesser General Public
18   * License along with this library; if not, visit
19   * http://www.gnu.org/licenses/lgpl.html or write to the Free Software
20   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
21   */
22  package de.fu_berlin.ties.context;
23  
24  /***
25   * A recognition has a type (class) and contains text.
26   *
27   * @author Christian Siefkes
28   * @version $Revision: 1.1 $, $Date: 2004/02/02 18:35:58 $, $Author: siefkes $
29   */
30  public interface Recognition {
31  
32      /***
33       * Returns the type (class) of the recognition.
34       * @return the type (class)
35       */
36      String getType();
37  
38      /***
39       * Returns the recognized text fragment.
40       * @return the recognized text
41       */
42      String getText();
43  
44      /***
45       * Whether this recognition has been sealed. The text of a sealed
46       * recognition is stable and cannot be changed.
47       *
48       * @return <code>true</code> iff this recognition is sealed
49       */
50      boolean isSealed();
51  
52  }