All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.opencms.search.CmsSearchIndexSource Maven / Gradle / Ivy

Go to download

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0
Show newest version
/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://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: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://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;

import org.opencms.main.CmsIllegalArgumentException;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.util.CmsStringUtil;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.apache.commons.logging.Log;

/**
 * A search index source is a description of a list of Cms resources
 * to be indexed.

* * @since 6.0.0 */ public class CmsSearchIndexSource implements Comparable { /** The log object for this class. */ private static final Log LOG = CmsLog.getLog(CmsSearchIndexSource.class); /** A list of Cms resource types to be indexed. */ private List m_documentTypes; /** The indexer. */ private I_CmsIndexer m_indexer; /** The class name of the indexer. */ private String m_indexerClassName; /** The logical key/name of this index. */ private String m_name; /** A map of optional key/value parameters. */ private Map m_params; /** A list of Cms resources to be indexed. */ private List m_resourcesNames; /** * Creates a new CmsSearchIndexSource.

*/ public CmsSearchIndexSource() { m_params = new HashMap(); m_resourcesNames = new ArrayList(); m_documentTypes = new ArrayList(); } /** * Adds a parameter.

* * @param key the key/name of the parameter * @param value the value of the parameter */ public void addConfigurationParameter(String key, String value) { m_params.put(key, value); } /** * Adds the name of a document type.

* * @param key the name of a document type to add */ public void addDocumentType(String key) { m_documentTypes.add(key); } /** * Adds the path of a Cms resource.

* * @param resourceName the path of a Cms resource */ public void addResourceName(String resourceName) { m_resourcesNames.add(resourceName); } /** * Returns 0 if the given object is an index source with the same name.

* * Note that the name of an index source has to be unique within OpenCms.

* * @param obj another index source * * @return 0 if the given object is an index source with the same name * * @see java.lang.Comparable#compareTo(java.lang.Object) */ public int compareTo(CmsSearchIndexSource obj) { if (obj == this) { return 0; } return m_name.compareTo(obj.m_name); } /** * Two index sources are considered equal if their names as returned by {@link #getName()} is equal.

* * Note that the name of an index source has to be unique within OpenCms.

* * @see java.lang.Object#equals(java.lang.Object) */ @Override public boolean equals(Object obj) { if (obj == this) { return true; } if (obj instanceof CmsSearchIndexSource) { return m_name.equals(((CmsSearchIndexSource)obj).m_name); } return false; } /** * Returns the list of names (Strings) of the document types to be indexed.

* * @return the list of names (Strings) of the document types to be indexed */ public List getDocumentTypes() { return m_documentTypes; } /** * Returns the indexer.

* * @return the indexer */ public I_CmsIndexer getIndexer() { return m_indexer; } /** * Returns the class name of the indexer.

* * @return the class name of the indexer */ public String getIndexerClassName() { return m_indexerClassName; } /** * Returns the logical key/name of this search index source.

* * @return the logical key/name of this search index source */ public String getName() { return m_name; } /** * Returns the value for a specified parameter key.

* * @param key the parameter key/name * @return the value for the specified parameter key */ public String getParam(String key) { return m_params.get(key); } /** * Returns the map of optional key/value parameters.

* * @return the map of optional key/value parameters */ public Map getParams() { return m_params; } /** * Returns the list of VFS resources to be indexed.

* * @return the list of VFS resources to be indexed */ public List getResourcesNames() { return m_resourcesNames; } /** * Overriden to be consistents with overridden method * {@link #equals(Object)}. * * @see java.lang.Object#hashCode() */ @Override public int hashCode() { return m_name.hashCode(); } /** * Returns true in case the given resource root path is contained in the list of * configured resource names of this index source.

* * @param rootPath the resource root path to check * * @return true in case the given resource root path is contained in the list of * configured resource names of this index source * * @see #getResourcesNames() */ public boolean isContaining(String rootPath) { if ((rootPath != null) && (m_resourcesNames != null)) { Iterator i = m_resourcesNames.iterator(); while (i.hasNext()) { String path = i.next(); if (rootPath.startsWith(path)) { return true; } } } return false; } /** * Returns true in case the given resource root path is contained in the list of * configured resource names, and the given document type name is contained in the * list if configured document type names of this index source.

* * @param rootPath the resource root path to check * @param documentType the document type factory name to check * * @return true in case the given resource root path is contained in the list of * configured resource names, and the given document type name is contained in the * list if configured document type names of this index source * * @see #isContaining(String) * @see #getDocumentTypes() */ public boolean isIndexing(String rootPath, String documentType) { return m_documentTypes.contains(documentType) && isContaining(rootPath); } /** * Removes the name of a document type from the list of configured types of this index source.

* * @param key the name of the document type to remove * * @return true if the given document type name was contained before thus could be removed successfully, false otherwise */ public boolean removeDocumentType(String key) { return m_documentTypes.remove(key); } /** * Sets the list of document type names (Strings) to be indexed.

* * @param documentTypes the list of document type names (Strings) to be indexed */ public void setDocumentTypes(List documentTypes) { m_documentTypes = documentTypes; } /** * Sets the class name of the indexer.

* * An Exception is thrown to allow GUI-display of wrong input.

* * @param indexerClassName the class name of the indexer * * @throws CmsIllegalArgumentException if the given String is not a fully qualified classname (within this Java VM) */ public void setIndexerClassName(String indexerClassName) throws CmsIllegalArgumentException { try { m_indexer = (I_CmsIndexer)Class.forName(indexerClassName).newInstance(); m_indexerClassName = indexerClassName; } catch (Exception exc) { if (LOG.isWarnEnabled()) { LOG.warn( Messages.get().getBundle().key(Messages.LOG_INDEXER_CREATION_FAILED_1, m_indexerClassName), exc); } throw new CmsIllegalArgumentException( Messages.get().container( Messages.ERR_INDEXSOURCE_INDEXER_CLASS_NAME_2, indexerClassName, I_CmsIndexer.class.getName())); } } /** * Sets the logical key/name of this search index source.

* * @param name the logical key/name of this search index source * * @throws CmsIllegalArgumentException if argument name is null, an empty or whitespace-only Strings * or already used for another indexsource's name. */ public void setName(String name) throws CmsIllegalArgumentException { if (CmsStringUtil.isEmptyOrWhitespaceOnly(name)) { throw new CmsIllegalArgumentException( Messages.get().container(Messages.ERR_INDEXSOURCE_CREATE_MISSING_NAME_0)); } // already used? Don't test this at xml-configuration time (no manager) if (OpenCms.getRunLevel() > OpenCms.RUNLEVEL_2_INITIALIZING) { CmsSearchManager mngr = OpenCms.getSearchManager(); // don't test this if the indexsource is not new (widget invokes setName even if it was not changed) if (mngr.getIndexSource(name) != this) { if (mngr.getSearchIndexSources().keySet().contains(name)) { throw new CmsIllegalArgumentException( Messages.get().container(Messages.ERR_INDEXSOURCE_CREATE_INVALID_NAME_1, name)); } } } m_name = name; } /** * Sets the map of optional key/value parameters.

* * @param params the map of optional key/value parameters */ public void setParams(Map params) { m_params = params; } /** * Sets the list of Cms resources to be indexed.

* * @param resources the list of Cms resources (Strings) to be indexed */ public void setResourcesNames(List resources) { m_resourcesNames = resources; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy