View Javadoc

1   /* Copyright (c) 2008 Sascha Kohlmann
2    *
3    * This program is free software: you can redistribute it and/or modify
4    * it under the terms of the GNU Affero General Public License as published by
5    * the Free Software Foundation, either version 3 of the License, or
6    * (at your option) any later version.
7    *
8    * This program is distributed in the hope that it will be useful,
9    * but WITHOUT ANY WARRANTY; without even the implied warranty of
10   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11   * GNU Affero General Public License for more details.
12   *
13   * You should have received a copy of the GNU Affero General Public License
14   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
15   */
16  package net.sf.eos.analyzer;
17  
18  import net.sf.eos.Metadata;
19  
20  /**
21   * A Token represents a part of a tokenized text.
22   * @see Tokenizer
23   * @author Sascha Kohlmann
24   */
25  @SuppressWarnings("nls")
26  public interface Token extends Metadata {
27  
28      /** The default type of a token. */
29      public final static String DEFAULT_TYPE = "word";
30  
31      /**
32       * Returns the text of a token. The text may be a single word or a sequence
33       * of words, e.g. a sentence.
34       * @return the character sequence of the token
35       */
36      CharSequence getTokenText();
37  
38      /**
39       * Returns the type of the token.
40       * @return the type of a token.
41       */
42      String getType();
43  }