source: trunk/greenstone3-extensions/gs3build/src/org/greenstone/gsdl3/gs3build/indexers/IndexerInterface.java@ 12188

Last change on this file since 12188 was 12188, checked in by kjdon, 18 years ago

Initial revision

  • Property svn:keywords set to Author Date Id Revision
File size: 1.1 KB
Line 
1package org.greenstone.gsdl3.gs3build.indexers;
2
3import org.greenstone.gsdl3.gs3build.doctypes.DocumentID;
4import org.greenstone.gsdl3.gs3build.doctypes.DocumentInterface;
5
6public interface IndexerInterface
7{
8 public static final String DOCUMENT_LEVEL = "document";
9 public static final String SECTION_LEVEL = "section";
10 public static final String PARAGRAPH_LEVEL = "paragraph";
11
12 public static final String GS2_INDEX_LABEL = "Index";
13
14 public String getIndexType();
15 public String getName();
16 public int getNumberOfPasses();
17 // TODO: add a function call to provide appropriate XML for the service description
18 public boolean addServiceDescriptions(org.w3c.dom.Element service_rack_list);
19 public void tidyup();
20
21 public boolean configure(String label, String value);
22 public boolean configure(org.w3c.dom.Node node);
23 // public boolean addIndex(String name, String level, String field);
24
25 public boolean startPass(int passNumber);
26 public boolean indexDocument(DocumentID id, DocumentInterface document);
27 public boolean endPass(int passNumber);
28
29}
Note: See TracBrowser for help on using the repository browser.