001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.search.documents;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResource;
032import org.opencms.search.CmsIndexException;
033import org.opencms.search.I_CmsSearchIndex;
034import org.opencms.search.extractors.CmsExtractionResult;
035import org.opencms.search.extractors.I_CmsExtractionResult;
036
037/**
038 * Lucene document factory class for indexing data from a generic <code>{@link CmsResource}</code>.<p>
039 *
040 * Since the document type is generic, no content extraction is performed for the resource.
041 * However, meta data from the properties and attributes of the resource are indexed.<p>
042 *
043 * The class is useful for example to have images appear in the search result if the title of the image
044 * matched the search query. It's also used if no specific extraction method is available for a binary document type.<p>
045 *
046 * @since 6.0.0
047 */
048public class CmsDocumentGeneric extends A_CmsVfsDocument {
049
050    /**
051     * Creates a new instance of this lucene document factory.<p>
052     *
053     * @param name name of the documenttype
054     */
055    public CmsDocumentGeneric(String name) {
056
057        super(name);
058    }
059
060    /**
061     * Just returns an empty extraction result since the content can't be extracted form a generic resource.<p>
062     *
063     * @see org.opencms.search.documents.I_CmsSearchExtractor#extractContent(CmsObject, CmsResource, I_CmsSearchIndex)
064     */
065    public I_CmsExtractionResult extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)
066    throws CmsIndexException {
067
068        if (resource == null) {
069            throw new CmsIndexException(Messages.get().container(Messages.ERR_NO_RAW_CONTENT_1, index.getLocale()));
070        }
071        // just return an empty result set
072        return new CmsExtractionResult("");
073    }
074
075    /**
076     * @see org.opencms.search.documents.I_CmsDocumentFactory#isLocaleDependend()
077     */
078    public boolean isLocaleDependend() {
079
080        return false;
081    }
082
083    /**
084     * @see org.opencms.search.documents.I_CmsDocumentFactory#isUsingCache()
085     */
086    public boolean isUsingCache() {
087
088        return false;
089    }
090}