org.apache.lucene.analysis.morph.Dictionary Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.lucene.analysis.morph;

/** High-level dictionary interface for morphological analyzers. */
public interface Dictionary {
  /**
   * Get left id of specified word
   *
   * @return left id
   */
  default int getLeftId(int morphId) {
    return getMorphAttributes().getLeftId(morphId);
  }

  /**
   * Get right id of specified word
   *
   * @return right id
   */
  default int getRightId(int morphId) {
    return getMorphAttributes().getRightId(morphId);
  }

  /**
   * Get word cost of specified word
   *
   * @return word's cost
   */
  default int getWordCost(int morphId) {
    return getMorphAttributes().getWordCost(morphId);
  }

  T getMorphAttributes();
}