content: /*
   * This library is part of OpenCms -
   * the Open Source Content Management System
   *
   * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU Lesser General Public
   * License as published by the Free Software Foundation; either
   * version 2.1 of the License, or (at your option) any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   * Lesser General Public License for more details.
   *
   * For further information about Alkacon Software GmbH & Co. KG, please see the
   * company website: https://www.alkacon.com
   *
   * For further information about OpenCms, please see the
   * project website: https://www.opencms.org
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   */
  
  package org.opencms.search.documents;
  
  import org.opencms.file.CmsObject;
  import org.opencms.file.CmsResource;
  import org.opencms.main.CmsException;
  import org.opencms.search.I_CmsSearchIndex;
  import org.opencms.search.extractors.I_CmsExtractionResult;
  
  /**
   * Defines a text extractor for the integrated search engine.<p>
   *
   * The job of a search extractor is to extract indexable plain text from
   * a resource in the OpenCms VFS. This may be from the resource content, for example
   * from a PDF file, or from the resource properties, for example the Title, Keywords and
   * Description properties.<p>
   *
   * @since 6.0.0
   */
  public interface I_CmsSearchExtractor {
  
      /**
       * Extracts the content of a given index resource according to the resource file type and the
       * configuration of the given index.<p>
       *
       * @param cms the cms object
       * @param resource the resource to extract the content from
       * @param index the index to extract the content for
       *
       * @return the extracted content of the resource
       *
       * @throws CmsException if something goes wrong
       */
      I_CmsExtractionResult extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)
      throws CmsException;
  
  }