org.cogroo.analyzer.Analyzer Maven / Gradle / Ivy
/**
* Copyright (C) 2012 cogroo
*
* Licensed 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.cogroo.analyzer;
import org.cogroo.text.Document;
/**
* The Analyzer interface is responsible for analyzing part of the
* document.
*
* Some analyzers that implement this interface are:
*
*
*
* SenteceDetector
* Tokenizer
* NameFinder
* ContractionFinder
* POSTagger
*
*
*
* The SentenceDetector, for example, looks for all sentences in a text and
* keeps them separately in a list.
*
*
*/
public interface Analyzer {
/**
* Analyzes part of a text or a word.
*
* For example, it can search all the
* sentences in the text or tag every word in a sentence.
*
* @param document
* contains the whole text given by the user. After an analysis it can store the text's sentences, words or its tags.
*/
public void analyze(Document document);
}