1 | /**
|
---|
2 | *#########################################################################
|
---|
3 | *
|
---|
4 | * A component of the Gatherer application, part of the Greenstone digital
|
---|
5 | * library suite from the New Zealand Digital Library Project at the
|
---|
6 | * University of Waikato, New Zealand.
|
---|
7 | *
|
---|
8 | * Author: John Thompson, Greenstone Digital Library, University of Waikato
|
---|
9 | *
|
---|
10 | * Copyright (C) 1999 New Zealand Digital Library Project
|
---|
11 | *
|
---|
12 | * This program is free software; you can redistribute it and/or modify
|
---|
13 | * it under the terms of the GNU General Public License as published by
|
---|
14 | * the Free Software Foundation; either version 2 of the License, or
|
---|
15 | * (at your option) any later version.
|
---|
16 | *
|
---|
17 | * This program is distributed in the hope that it will be useful,
|
---|
18 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
20 | * GNU General Public License for more details.
|
---|
21 | *
|
---|
22 | * You should have received a copy of the GNU General Public License
|
---|
23 | * along with this program; if not, write to the Free Software
|
---|
24 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
---|
25 | *########################################################################
|
---|
26 | */
|
---|
27 | package org.greenstone.gatherer.cdm;
|
---|
28 |
|
---|
29 | /**************************************************************************************
|
---|
30 | * Written: 20/05/02
|
---|
31 | * Revised: 03/07/03
|
---|
32 | **************************************************************************************/
|
---|
33 | import java.util.ArrayList;
|
---|
34 |
|
---|
35 | /** This class provides an interface to any class that contains a list of Arguments.
|
---|
36 | * @author John Thompson, Greenstone Digital Library, University of Waikato
|
---|
37 | * @version 2.3
|
---|
38 | */
|
---|
39 | public interface ArgumentContainer {
|
---|
40 | /** Method to retrieve the list of arguments from this container. Note that this method returns both the containers arguments plus its 'supers' arguments if any, and alphabetically orders them.
|
---|
41 | * @param include_normal true to filter so normal arguments are returned
|
---|
42 | * @param include_custom true to filter so custom arguments are returned
|
---|
43 | * @return the arguments within a ArrayList
|
---|
44 | */
|
---|
45 | public ArrayList getArguments(boolean include_normal, boolean include_custom);
|
---|
46 | /** Method to retrieve this containers custom argument string.
|
---|
47 | * @return the custom arguments as a String
|
---|
48 | */
|
---|
49 | public String getCustom();
|
---|
50 | /** Method to retrieve the name associated with this argument container.
|
---|
51 | * @return the name as a String
|
---|
52 | */
|
---|
53 | public String getName();
|
---|
54 | /** Method to set the custom arguments string.
|
---|
55 | * @param custom the new custom argument String
|
---|
56 | */
|
---|
57 | public void setCustom(String custom);
|
---|
58 | }
|
---|