View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *  http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17
    18  package org.apache.any23.extractor;
    19
    20  import org.apache.any23.rdf.Prefixes;
    21
    22  /**
    23   *
    24   * It defines a minimal signature for an {@link Extractor} description.
    25   *
    26   */
    27  public interface ExtractorDescription {
    28
    29      /**
    30       * Returns the name of the extractor.
    31       *
    32       * @return a name.
    33       */
    34      String getExtractorName();
    35
    36      /**
    37       * Returns the label for extractors created from this factory.
    38       *
    39       * @return A string label describing the type of extractors created from this factory.
    40       */
    41      String getExtractorLabel();
    42
    43      /**
    44       * An instance defining the prefixes supported by this extractor.
    45       *
    46       * @return prefixes instance.
    47       */
    48      Prefixes getPrefixes();
    49
    50  }