chalk.tools.doccat.DocumentCategorizer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of chalk Show documentation

chalk

There is a newer version: 1.3.0

/*
 * 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 chalk.tools.doccat;

/**
 * Interface for classes which categorize documents.
 */
public interface DocumentCategorizer {

  /**
   * Categorizes the given text.
   *
   * @param text
   */
  public double[] categorize(String text[]);

  public String getBestCategory(double[] outcome);

  public int getIndex(String category);

  public String getCategory(int index);

  public int getNumberOfCategories();

  public double[] categorize(String documentText);

  public String getAllResults(double results[]);
}