View Javadoc

1   /*$Id: ParameterDescription.java,v 1.4 2004/08/28 07:17:34 pah Exp $
2    * Created on 25-May-2004
3    *
4    * Copyright (C) AstroGrid. All rights reserved.
5    *
6    * This software is published under the terms of the AstroGrid 
7    * Software License version 1.2, a copy of which has been included 
8    * with this distribution in the LICENSE.txt file.  
9    *
10  **/
11  package org.astrogrid.applications.description;
12   
13  import org.astrogrid.applications.beans.v1.parameters.types.ParameterTypes;
14  
15  /*** Description of a parameter to an application
16   * @see org.astrogrid.applications.description.ApplicationDescription
17   * @author Noel Winstanley nw@jb.man.ac.uk 25-May-2004
18   * @TODO - would be sensible for the schema to match these names.....
19   *
20   */
21  public interface ParameterDescription {
22      /*** name of the parameter */
23      public abstract String getName();
24      /*** name to use in UI */
25      public abstract String getDisplayName();
26     /*** description to use in UI */
27      public abstract String getDisplayDescription();
28       /*** UCD of parameter */
29      public abstract String getUcd();
30      /*** units of parameter */
31      public abstract String getUnits();
32      /*** type of parameter */
33      public abstract  ParameterTypes getType();
34      /*** subtype / contraint on possible value of parameter */
35      public abstract String getSubType();
36      /*** data encodings accepted for this parameter */
37      public abstract String getAcceptEncodings();
38      /*** default value for this parameter */
39      public abstract String getDefaultValue();
40      
41  
42  
43  }
44  /* 
45  $Log: ParameterDescription.java,v $
46  Revision 1.4  2004/08/28 07:17:34  pah
47  commandline parameter passing - unit tests ok
48  
49  Revision 1.3  2004/07/26 00:57:46  nw
50  javadoc
51  
52  Revision 1.2  2004/07/01 11:16:22  nw
53  merged in branch
54  nww-itn06-componentization
55  
56  Revision 1.1.2.3  2004/07/01 01:42:46  nw
57  final version, before merge
58  
59  Revision 1.1.2.2  2004/06/17 09:21:23  nw
60  finished all major functionality additions to core
61  
62  Revision 1.1.2.1  2004/06/14 08:56:58  nw
63  factored applications into sub-projects,
64  got packaging of wars to work again
65  
66  Revision 1.7.8.1  2004/05/28 10:23:10  nw
67  checked in early, broken version - but it builds and tests (fail)
68   
69  */