org.apache.ctakes.dictionary.lookup.ae.LookupSpec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ctakes-dictionary-lookup Show documentation
The newest version!
/**
 * 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.ctakes.dictionary.lookup.ae;

import org.apache.ctakes.dictionary.lookup.algorithms.LookupAlgorithm;

import javax.annotation.concurrent.Immutable;

/**
 * A container for three related classes used to lookup terms in a dictionary and process hits found.
 * a lookup algorithm - a class with a lookup method that returns hits
 * a lookup initializer - a collection of methods used to initialize/control the lookup algorithm
 * a lookup consumer - class which processes hits found by the lookup algorithm,
 * and typically adds annotations to the CAS
 *
 * @author Mayo Clinic
 */
@Immutable
final public class LookupSpec {
   final private LookupAlgorithm _lookupAlgorithm;
   final private LookupInitializer _lookupInitializer;
   final private LookupConsumer _lookupConsumer;

   public LookupSpec( final LookupAlgorithm lookupAlgorithm,
                      final LookupInitializer lookupInitializer,
                      final LookupConsumer lookupConsumer ) {
      _lookupAlgorithm = lookupAlgorithm;
      _lookupInitializer = lookupInitializer;
      _lookupConsumer = lookupConsumer;
   }

   public LookupAlgorithm getLookupAlgorithm() {
      return _lookupAlgorithm;
   }

   public LookupInitializer getLookupInitializer() {
      return _lookupInitializer;
   }

   public LookupConsumer getLookupConsumer() {
      return _lookupConsumer;
   }

}