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.search.CmsIndexException;
  import org.opencms.search.I_CmsSearchIndex;
  import org.opencms.search.extractors.CmsExtractionResult;
  import org.opencms.search.extractors.I_CmsExtractionResult;
  
  /**
   * Lucene document factory class for indexing data from a generic <code>{@link CmsResource}</code>.<p>
   *
   * Since the document type is generic, no content extraction is performed for the resource.
   * However, meta data from the properties and attributes of the resource are indexed.<p>
   *
   * The class is useful for example to have images appear in the search result if the title of the image
   * matched the search query. It's also used if no specific extraction method is available for a binary document type.<p>
   *
   * @since 6.0.0
   */
  public class CmsDocumentGeneric extends A_CmsVfsDocument {
  
      /**
       * Creates a new instance of this lucene document factory.<p>
       *
       * @param name name of the documenttype
       */
      public CmsDocumentGeneric(String name) {
  
          super(name);
      }
  
      /**
       * Just returns an empty extraction result since the content can't be extracted form a generic resource.<p>
       *
       * @see org.opencms.search.documents.I_CmsSearchExtractor#extractContent(CmsObject, CmsResource, I_CmsSearchIndex)
       */
      public I_CmsExtractionResult extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)
      throws CmsIndexException {
  
          if (resource == null) {
              throw new CmsIndexException(Messages.get().container(Messages.ERR_NO_RAW_CONTENT_1, index.getLocale()));
          }
          // just return an empty result set
          return new CmsExtractionResult("");
      }
  
      /**
       * @see org.opencms.search.documents.I_CmsDocumentFactory#isLocaleDependend()
       */
      public boolean isLocaleDependend() {
  
          return false;
      }
  
      /**
       * @see org.opencms.search.documents.I_CmsDocumentFactory#isUsingCache()
       */
      public boolean isUsingCache() {
  
          return false;
      }
  }