opennlp.tools.doccat.FeatureGenerator Maven / Gradle / Ivy
/*
* 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 opennlp.tools.doccat;
import java.util.Collection;
import java.util.Map;
/**
* Interface for generating features for document categorization.
*/
public interface FeatureGenerator {
/**
* Extracts features from given {@code text} fragments.
*
* @param text The text fragments to extract features from
* @param extraInformation Optional extra information to be used by the {@link FeatureGenerator}.
* @return A collection of features.
*/
Collection extractFeatures(String[] text, Map extraInformation);
}