001    /**
002     * Copyright (c) 2000-present 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 com.liferay.portal.kernel.cluster.Priority;
018    
019    /**
020     * @author Bruno Farache
021     * @author Michael C. Han
022     */
023    public interface SearchEngine {
024    
025            public String backup(long companyId, String backupName)
026                    throws SearchException;
027    
028            public BooleanClauseFactory getBooleanClauseFactory();
029    
030            public BooleanQueryFactory getBooleanQueryFactory();
031    
032            public Priority getClusteredWritePriority();
033    
034            public IndexSearcher getIndexSearcher();
035    
036            public IndexWriter getIndexWriter();
037    
038            public TermQueryFactory getTermQueryFactory();
039    
040            public TermRangeQueryFactory getTermRangeQueryFactory();
041    
042            public String getVendor();
043    
044            public void initialize(long companyId);
045    
046            public boolean isClusteredWrite();
047    
048            public boolean isLuceneBased();
049    
050            public void removeBackup(long companyId, String backupName)
051                    throws SearchException;
052    
053            public void removeCompany(long companyId);
054    
055            public void restore(long companyId, String backupName)
056                    throws SearchException;
057    
058    }