01: /******************************************************************************
02: * JBoss, a division of Red Hat *
03: * Copyright 2006, Red Hat Middleware, LLC, and individual *
04: * contributors as indicated by the @authors tag. See the *
05: * copyright.txt in the distribution for a full listing of *
06: * individual contributors. *
07: * *
08: * This is free software; you can redistribute it and/or modify it *
09: * under the terms of the GNU Lesser General Public License as *
10: * published by the Free Software Foundation; either version 2.1 of *
11: * the License, or (at your option) any later version. *
12: * *
13: * This software is distributed in the hope that it will be useful, *
14: * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16: * Lesser General Public License for more details. *
17: * *
18: * You should have received a copy of the GNU Lesser General Public *
19: * License along with this software; if not, write to the Free *
20: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
21: * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
22: ******************************************************************************/package org.jboss.portal.search;
23:
24: import org.jboss.portal.common.i18n.LocalizedString;
25: import org.jboss.portal.search.federation.Info;
26:
27: /**
28: * @author <a href="mailto:theute@jboss.org">Thomas Heute</a>
29: * @version $Revision: 8784 $
30: */
31: public interface FederatedIndexer {
32: /**
33: * Get the ID for this federated search
34: *
35: * @return String representing this particular federated search
36: */
37: public String getId();
38:
39: /**
40: * Get a localized name for this federated search
41: *
42: * @return String
43: */
44: public LocalizedString getDisplayName();
45:
46: /**
47: * Method called when this federated search is not used anymore. This could be the place to destroy any index
48: *
49: * @throws IndexingException
50: */
51: public void destroyIndex() throws IndexingException;
52:
53: /**
54: * The create method should index the required components
55: *
56: * @throws IndexingException
57: */
58: public void createIndex() throws IndexingException;
59:
60: /**
61: * Info should return information on the current status if the federated search
62: *
63: * @return
64: */
65: public Info getInfo();
66:
67: }
|