View Javadoc

1   /*$Id: ParameterAdapter.java,v 1.3 2004/07/26 12:07:38 nw Exp $
2    * Created on 04-Jun-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.parameter;
12  
13  import org.astrogrid.applications.CeaException;
14  import org.astrogrid.applications.beans.v1.parameters.ParameterValue;
15  
16  /*** Abstraction around reading and writing  parameter values.
17   * @see org.astrogrid.applications.AbstractApplication#instantiateAdapter()}
18   * @author Noel Winstanley nw@jb.man.ac.uk 04-Jun-2004
19   *
20   */
21  public interface ParameterAdapter {
22      
23      /*** do what it takes to get the actual value for this parameter (used for input parameters)
24       * 
25       * @return the actual value for this parameter ( or some symbolic representation of it)
26       * @throws CeaException
27       */
28      Object process() throws CeaException;
29      /***
30       * write out this parameter (used for output parameters).
31       * @param o the value of the parameter to write (or some reference / represenation of it)
32       * @throws CeaException
33       */
34      void writeBack(Object o) throws CeaException;
35      
36      /*** returns the parameter object this adapter is wrapping. 
37       * @return the paramter value this adpater wraps.*/
38      ParameterValue getWrappedParameter();
39  }
40  
41  
42  /* 
43  $Log: ParameterAdapter.java,v $
44  Revision 1.3  2004/07/26 12:07:38  nw
45  renamed indirect package to protocol,
46  renamed classes and methods within protocol package
47  javadocs
48  
49  Revision 1.2  2004/07/01 11:16:22  nw
50  merged in branch
51  nww-itn06-componentization
52  
53  Revision 1.1.2.2  2004/07/01 01:42:46  nw
54  final version, before merge
55  
56  Revision 1.1.2.1  2004/06/17 09:21:23  nw
57  finished all major functionality additions to core
58  
59  Revision 1.1.2.1  2004/06/14 08:56:58  nw
60  factored applications into sub-projects,
61  got packaging of wars to work again
62   
63  */