| 1 | package org.greenstone.gatherer.cdm;
|
|---|
| 2 | /**
|
|---|
| 3 | *#########################################################################
|
|---|
| 4 | *
|
|---|
| 5 | * A component of the Gatherer application, part of the Greenstone digital
|
|---|
| 6 | * library suite from the New Zealand Digital Library Project at the
|
|---|
| 7 | * University of Waikato, New Zealand.
|
|---|
| 8 | *
|
|---|
| 9 | * <BR><BR>
|
|---|
| 10 | *
|
|---|
| 11 | * Author: John Thompson, Greenstone Digital Library, University of Waikato
|
|---|
| 12 | *
|
|---|
| 13 | * <BR><BR>
|
|---|
| 14 | *
|
|---|
| 15 | * Copyright (C) 1999 New Zealand Digital Library Project
|
|---|
| 16 | *
|
|---|
| 17 | * <BR><BR>
|
|---|
| 18 | *
|
|---|
| 19 | * This program is free software; you can redistribute it and/or modify
|
|---|
| 20 | * it under the terms of the GNU General Public License as published by
|
|---|
| 21 | * the Free Software Foundation; either version 2 of the License, or
|
|---|
| 22 | * (at your option) any later version.
|
|---|
| 23 | *
|
|---|
| 24 | * <BR><BR>
|
|---|
| 25 | *
|
|---|
| 26 | * This program is distributed in the hope that it will be useful,
|
|---|
| 27 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 28 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|---|
| 29 | * GNU General Public License for more details.
|
|---|
| 30 | *
|
|---|
| 31 | * <BR><BR>
|
|---|
| 32 | *
|
|---|
| 33 | * You should have received a copy of the GNU General Public License
|
|---|
| 34 | * along with this program; if not, write to the Free Software
|
|---|
| 35 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|---|
| 36 | *########################################################################
|
|---|
| 37 | */
|
|---|
| 38 | import org.greenstone.gatherer.Gatherer;
|
|---|
| 39 | import org.greenstone.gatherer.cdm.Classifier;
|
|---|
| 40 | import org.greenstone.gatherer.file.FileNode;
|
|---|
| 41 | /** The interface for any custom classifier.
|
|---|
| 42 | * @author John Thompson, Greenstone Digital Library, University of Waikato
|
|---|
| 43 | * @version 2.3
|
|---|
| 44 | */
|
|---|
| 45 | public interface CustomClassifier
|
|---|
| 46 | extends Comparable {
|
|---|
| 47 | /** Constructor.
|
|---|
| 48 | * public CustomClassifier(Gatherer gatherer);
|
|---|
| 49 | */
|
|---|
| 50 | /** Create a blank copy of this pseudo-classifier.
|
|---|
| 51 | * @return A newly allocated <strong>CustomClassifier</strong>.
|
|---|
| 52 | */
|
|---|
| 53 | public CustomClassifier copy();
|
|---|
| 54 | /** Destructor. */
|
|---|
| 55 | public void destroy();
|
|---|
| 56 | /** Show the controls for configuring this pseudo-classifier.
|
|---|
| 57 | * @param show <i>true</i> if the component should immediately show itself, <i>false</i> if you just wish to initialize components.
|
|---|
| 58 | */
|
|---|
| 59 | public boolean display(boolean show);
|
|---|
| 60 | /** Method to return this pseudo-classifier represented as a String.
|
|---|
| 61 | * @return A <strong>String</strong>.
|
|---|
| 62 | */
|
|---|
| 63 | public String getCommand();
|
|---|
| 64 | /** Retrieve the custom command, a command line that overrides and replaces some other 'actual' classifier.
|
|---|
| 65 | * @param index The number of the classifer this one is replacing.
|
|---|
| 66 | */
|
|---|
| 67 | public String getCustomCommand(int index);
|
|---|
| 68 | /** Get the name of this custom classifier.
|
|---|
| 69 | * @return A <strong>String</strong> representing the name.
|
|---|
| 70 | */
|
|---|
| 71 | public String getName();
|
|---|
| 72 | public void process(FileNode record);
|
|---|
| 73 | /** Recreate a CustomAZList given several parameters including the real classifier created during custom design.
|
|---|
| 74 | * @param classifier The real <strong>Classifier</strong>.
|
|---|
| 75 | * @param separations A <strong>String</strong> representing the choosen separations.
|
|---|
| 76 | */
|
|---|
| 77 | public void recreate(Classifier classifier, String separations);
|
|---|
| 78 | /** Sets the value of Gatherer, for those classes loaded dynamically.
|
|---|
| 79 | * @param gatherer A reference to the <strong>Gatherer</strong>.
|
|---|
| 80 | */
|
|---|
| 81 | public void setGatherer(Gatherer gatherer);
|
|---|
| 82 | /** Sets the Classifier manager in charge of this classifier.
|
|---|
| 83 | * @param manager This classifiers <strong>ClassifierManager</strong>.
|
|---|
| 84 | */
|
|---|
| 85 | public void setManager(ClassifierManager manager);
|
|---|
| 86 | }
|
|---|
