001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.search;
016    
017    import javax.portlet.PortletURL;
018    
019    /**
020     * @author Brian Wing Shun Chan
021     * @author Raymond Augé
022     */
023    public interface Indexer {
024    
025            public static final int DEFAULT_INTERVAL = 1000;
026    
027            public void delete(Object obj) throws SearchException;
028    
029            public String[] getClassNames();
030    
031            public Document getDocument(Object obj) throws SearchException;
032    
033            public Summary getSummary(
034                    Document document, String snippet, PortletURL portletURL);
035    
036            public void reindex(Object obj) throws SearchException;
037    
038            public void reindex(String className, long classPK) throws SearchException;
039    
040            public void reindex(String[] ids) throws SearchException;
041    
042            public Hits search(SearchContext searchContext) throws SearchException;
043    
044    }