| /* |
| * 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.uima.analysis_engine.annotator; |
| |
| import org.apache.uima.analysis_engine.ResultSpecification; |
| import org.apache.uima.cas.CAS; |
| |
| /** |
| * Interface implemented for multiple-sofa annotators in UIMA SDK v1.x As of v2.0, annotators should |
| * extend {@link org.apache.uima.analysis_component.CasAnnotator_ImplBase} or |
| * {@link org.apache.uima.analysis_component.JCasAnnotator_ImplBase}. |
| */ |
| public interface GenericAnnotator extends BaseAnnotator { |
| /** |
| * Invokes this annotator's analysis logic. Prior to calling this method, the caller must ensure |
| * that the {@link CAS} has been populated with all information that this annotator needs to do |
| * its processing. This annotator will access the data in the CAS and add new data to the CAS. |
| * <p> |
| * The caller must also guarantee that the {@link ResultSpecification} falls within the scope of |
| * the {@link org.apache.uima.resource.metadata.Capability Capabilities} of this annotator (as |
| * published by its containing AnalysisEngine). |
| * <p> |
| * The annotator will only produce the output types and features that are declared in the |
| * <code>aResultSpec</code> parameter. |
| * |
| * @param aCAS |
| * contains the artifact to be analyzed and may contain other metadata about that |
| * artifact. |
| * @param aResultSpec |
| * A list of output types and features that this annotator should produce. |
| * |
| * @throws AnnotatorProcessException |
| * if a failure occurs during processing. |
| */ |
| public void process(CAS aCAS, ResultSpecification aResultSpec) throws AnnotatorProcessException; |
| } |
