1 /*
2 * Copyright (c) 2005 The University of Reading
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the University of Reading, nor the names of the
14 * authors or contributors may be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 package uk.ac.rdg.resc.jstyx.gridservice.config;
30
31 import org.dom4j.Node;
32
33 /***
34 * Simple class representing a steerable parameter, i.e. a parameter whose value
35 * can be changed whilst the executable is running
36 *
37 * @author Jon Blower
38 * $Revision: 465 $
39 * $Date: 2005-11-07 20:59:34 +0000 (Mon, 07 Nov 2005) $
40 * $Log$
41 * Revision 1.1 2005/11/07 20:59:34 jonblower
42 * Refactored SGS config classes to new package
43 *
44 */
45
46 public class Steerable
47 {
48
49 private String name;
50 private String initialValue;
51 private String filePath;
52
53 public Steerable(Node steerableNode) throws SGSConfigException
54 {
55 this.name = steerableNode.valueOf("@name").trim();
56 this.initialValue = steerableNode.valueOf("@initialvalue");
57 this.filePath = steerableNode.valueOf("@file").trim();
58 if (this.filePath.equals(""))
59 {
60 this.filePath = this.name;
61 }
62 }
63
64 public String getName()
65 {
66 return this.name;
67 }
68
69 public String getInitialValue()
70 {
71 return this.initialValue;
72 }
73
74 /***
75 * @return the path of the backing file for the steerable parameter, relative
76 * to the working directory of the SGS instance. If no filename is explicitly
77 * given in the config file, the filename will be the same as this.getName().
78 */
79 public String getFilePath()
80 {
81 return this.filePath;
82 }
83
84 }