lucene-java-3.5.0/lucene/contrib/icu/src/java/org/apache/lucene/analysis/icu/tokenattributes/ScriptAttribute.java

   1 package org.apache.lucene.analysis.icu.tokenattributes;
   2
   3 /**
   4  * Licensed to the Apache Software Foundation (ASF) under one or more
   5  * contributor license agreements.  See the NOTICE file distributed with
   6  * this work for additional information regarding copyright ownership.
   7  * The ASF licenses this file to You under the Apache License, Version 2.0
   8  * (the "License"); you may not use this file except in compliance with
   9  * the License.  You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19
  20 import org.apache.lucene.util.Attribute;
  21
  22 import com.ibm.icu.lang.UScript; // javadoc @link
  23
  24 /**
  25  * This attribute stores the UTR #24 script value for a token of text.
  26  * @lucene.experimental
  27  */
  28 public interface ScriptAttribute extends Attribute {
  29   /**
  30    * Get the numeric code for this script value.
  31    * This is the constant value from {@link UScript}.
  32    * @return numeric code
  33    */
  34   public int getCode();
  35   /**
  36    * Set the numeric code for this script value.
  37    * This is the constant value from {@link UScript}.
  38    * @param code numeric code
  39    */
  40   public void setCode(int code);
  41   /**
  42    * Get the full name.
  43    * @return UTR #24 full name.
  44    */
  45   public String getName();
  46   /**
  47    * Get the abbreviated name.
  48    * @return UTR #24 abbreviated name.
  49    */
  50   public String getShortName();
  51 }