starlink-task-java-doc 0.2+2016.05.03-1 / usr / share / doc / starlink-task-java-doc / api / uk / ac / starlink / task / package-summary.html

This file is indexed.

/usr/share/doc/starlink-task-java-doc/api/uk/ac/starlink/task/package-summary.html is in starlink-task-java-doc 0.2+2016.05.03-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>uk.ac.starlink.task (Starjava Task API)</title>
<meta name="date" content="2017-04-10">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="uk.ac.starlink.task (Starjava Task API)";
        }
    }
    catch(err) {
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../uk/ac/starlink/task/package-summary.html">Package</a></li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?uk/ac/starlink/task/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;uk.ac.starlink.task</h1>
<div class="docSummary">
<div class="block">A framework for invoking user-level tasks.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task">Environment</a></td>
<td class="colLast">
<div class="block">Defines an execution environment within which tasks can operate.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/Executable.html" title="interface in uk.ac.starlink.task">Executable</a></td>
<td class="colLast">
<div class="block">Defines an object which does the work of a task without any further
 user or environment interaction.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/MultiParameter.html" title="interface in uk.ac.starlink.task">MultiParameter</a></td>
<td class="colLast">
<div class="block">Marker interface which marks a parameter as one which can have multiple
 appearances on the command line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/Task.html" title="interface in uk.ac.starlink.task">Task</a></td>
<td class="colLast">
<div class="block">Defines a user-level task.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/BooleanParameter.html" title="class in uk.ac.starlink.task">BooleanParameter</a></td>
<td class="colLast">
<div class="block">Parameter value representing a boolean value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/ChoiceParameter.html" title="class in uk.ac.starlink.task">ChoiceParameter</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Parameter whose legal value must be one of a disjunction of given values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/DoubleParameter.html" title="class in uk.ac.starlink.task">DoubleParameter</a></td>
<td class="colLast">
<div class="block">Parameter representing a double precision number.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/InputStreamParameter.html" title="class in uk.ac.starlink.task">InputStreamParameter</a></td>
<td class="colLast">
<div class="block">Parameter which can provide an input stream based on its value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/IntegerParameter.html" title="class in uk.ac.starlink.task">IntegerParameter</a></td>
<td class="colLast">
<div class="block">Parameter representing an integer value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/InvokeUtils.html" title="class in uk.ac.starlink.task">InvokeUtils</a></td>
<td class="colLast">
<div class="block">Provides some utility functions used by classes which invoke tasks.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/LineEnvironment.html" title="class in uk.ac.starlink.task">LineEnvironment</a></td>
<td class="colLast">
<div class="block">Execution environment for use from the command line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/LineFormatter.html" title="class in uk.ac.starlink.task">LineFormatter</a></td>
<td class="colLast">
<div class="block">Compact log record formatter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/LineWord.html" title="class in uk.ac.starlink.task">LineWord</a></td>
<td class="colLast">
<div class="block">Represents a single word on the command line used as by LineEnvironment.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/LongParameter.html" title="class in uk.ac.starlink.task">LongParameter</a></td>
<td class="colLast">
<div class="block">Parameter representing a long integer value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/MultiTaskInvoker.html" title="class in uk.ac.starlink.task">MultiTaskInvoker</a></td>
<td class="colLast">
<div class="block">Invokes tasks from a command line when the tasks are available from 
 an <code>ObjectFactory</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/ObjectFactoryParameter.html" title="class in uk.ac.starlink.task">ObjectFactoryParameter</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Parameter whose (user-supplied) string values correspond to nicknames
 from an <code>ObjectFactory</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/OutputStreamParameter.html" title="class in uk.ac.starlink.task">OutputStreamParameter</a></td>
<td class="colLast">
<div class="block">Parameter for selecting an output stream to write to.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task">Parameter</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A Parameter describes the function of one of a task's parameters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/SingleTaskInvoker.html" title="class in uk.ac.starlink.task">SingleTaskInvoker</a></td>
<td class="colLast">
<div class="block">Invoker which only knows how to invoke a single given task.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/StringParameter.html" title="class in uk.ac.starlink.task">StringParameter</a></td>
<td class="colLast">
<div class="block">Parameter for holding string values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/TerminalEnvironment.html" title="class in uk.ac.starlink.task">TerminalEnvironment</a></td>
<td class="colLast">
<div class="block">Implementation of Environment which accepts an initial command line,
 and communicates with the user using standard input and standard output.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/TerminalInvoker.html" title="class in uk.ac.starlink.task">TerminalInvoker</a></td>
<td class="colLast">
<div class="block">Invokes Task objects in a way suitable for use from the <tt>main</tt> 
 method, using a command line interface.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/URLParameter.html" title="class in uk.ac.starlink.task">URLParameter</a></td>
<td class="colLast">
<div class="block">Parameter representing a URL value.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/AbortException.html" title="class in uk.ac.starlink.task">AbortException</a></td>
<td class="colLast">
<div class="block">Exception generated when the user signals an intention to abort a task.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/ExecutionException.html" title="class in uk.ac.starlink.task">ExecutionException</a></td>
<td class="colLast">
<div class="block">Exception generated when a task does not complete correctly for some
 known reason.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/ParameterValueException.html" title="class in uk.ac.starlink.task">ParameterValueException</a></td>
<td class="colLast">
<div class="block">Exception generated when the value of a parameter is invalid.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/TaskException.html" title="class in uk.ac.starlink.task">TaskException</a></td>
<td class="colLast">
<div class="block">Superclass for exceptions in the task package.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../uk/ac/starlink/task/UsageException.html" title="class in uk.ac.starlink.task">UsageException</a></td>
<td class="colLast">
<div class="block">An Exception thrown when a task is invoked with the wrong usage.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!--   -->
</a>
<h2 title="Package uk.ac.starlink.task Description">Package uk.ac.starlink.task Description</h2>
<div class="block">A framework for invoking user-level tasks.

<p>This package provides the necessary infrastructure for writing
tasks that do things for users, along the same lines as ADAM A-tasks.
An example of use is given in the separate NDTools package.

<p>At the moment all the necessary machinery is provided for invoking
tasks from the command line in a way that looks ADAM-like,
but it is designed so that, for instance, a GUI-style invoker 
could be written to invoke the same tasks.

<p>The provided components are as follows:
<dl>

<dt><a href="../../../../uk/ac/starlink/task/Parameter.html" title="class in uk.ac.starlink.task"><code>Parameter</code></a>
<dd>is an object which knows about the name, default value, data type, 
    validity constraints etc of a parameter of a task.  It also stores
    the actual value of the parameter when it has been obtained from
    the environment.  When it has obtained a value it can return it
    as a string.
    <tt>Parameter</tt> can be subclassed to enforce different validity
    constraints or so it knows how to return itself as some object other
    than a string (see for instance 
    <a href="../../../../uk/ac/starlink/task/IntegerParameter.html" title="class in uk.ac.starlink.task"><code>IntegerParameter</code></a>).

<dt><tt><a href="../../../../uk/ac/starlink/task/Environment.html" title="interface in uk.ac.starlink.task"><code>Environment</code></a></tt>
<dd>is an interface which defines how to request
    the value of a parameter.  It can also tell you about what output
    stream to use for messages to be dispatched to the user.

<dt><a href="../../../../uk/ac/starlink/task/TerminalEnvironment.html" title="class in uk.ac.starlink.task"><code>TerminalEnvironment</code></a>
<dd>is an implementation of <tt>Environment</tt> which assumes a user
    is sitting at a terminal with standard input and standard output.

<dt><a href="../../../../uk/ac/starlink/task/TerminalInvoker.html" title="class in uk.ac.starlink.task"><code>TerminalInvoker</code></a>
<dd>given a map of task names to <tt>Task</tt> objects will use a 
    <tt>TerminalEnvironment</tt> to invoke tasks from an <tt>args</tt>-style
    string array.

<dt><tt><a href="../../../../uk/ac/starlink/task/Task.html" title="interface in uk.ac.starlink.task"><code>Task</code></a></tt>
<dd>is the interface which user tasks themselves have to implement.
    A Task must be able to return a list of the parameters which it uses;
    since each parameter knows its name, default value, order on the
    command line, prompt string etc, this tells the Environment 
    everything it needs to know about how to get the value, including
    what to prompt the user etc.
    It must also be able to invoke itself on request.
    During invocation, it can interrogate its parameters to find out
    what their values are.

</dl>

<p>Setting up a user-level package containing tasks is then a case of
writing a top-level class with a <tt>main</tt> method which invokes
<tt>TerminalInvoker</tt>, and writing a number of classes which 
implement <tt>Task</tt>.  See the NDTools package for an example.

<p>To invoke the same tasks from a GUI you'd want to write something like
a <tt>GUIEnvironment</tt> and <tt>GUIInvoker</tt> class.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../uk/ac/starlink/task/package-summary.html">Package</a></li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?uk/ac/starlink/task/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><i>Copyright &#169; 2017 Central Laboratory of the Research Councils. All Rights Reserved.<i></small></p>
</body>
</html>

APT Browse - Built by Thomas Orozco.