Project

General

Profile

metacat / docs / dev / utilities-classes.html @ 8569

1
<!--
2
  * utilities-classes.html
3
  *
4
  *      Authors: Michael Daigle
5
  *    Copyright: 2009 Regents of the University of California and the
6
  *               National Center for Ecological Analysis and Synthesis
7
  *  For Details: http://www.nceas.ucsb.edu/
8
  *      Created: 2009 January 19
9
  *      Version: 
10
  *    File Info: '$ '
11
  * 
12
  * 
13
-->
14
<html>
15
<head>
16
<title>Metacat Utilities Classes</title>
17
<!-- unfortunately, we have to look for the common css file in the 
18
     user docs directory.  This is because the user docs deploy to 
19
     the top level of the metacat docs on the knb web server -->
20
<link rel="stylesheet" type="text/css" href="../user/common.css">
21
<link rel="stylesheet" type="text/css" href="./default.css">
22
</head> 
23

    
24
<body>
25
  <table class="tabledefault" width="100%">
26
    <tr>
27
      <td rowspan="2"><img src="./images/KNBLogo.gif"></td>
28
      <td colspan="7"><div class="title">KNB Software Development Guide: Metacat Utilities Classes</div></td>
29
    </tr>
30
    <tr>
31
      <td><a href="/" class="toollink"> KNB Home </a></td>
32
      <td><a href="/data.html" class="toollink"> Data </a></td>
33
      <td><a href="/people.html" class="toollink"> People </a></td>
34
      <td><a href="/informatics" class="toollink"> Informatics </a></td>
35
      <td><a href="/biodiversity" class="toollink"> Biocomplexity </a></td>
36
      <td><a href="/education" class="toollink"> Education </a></td>
37
      <td><a href="/software" class="toollink"> Software </a></td>
38
    </tr>
39
  </table>
40
  <br>
41

    
42
  <table width="100%">
43
    <tr>
44
      <td class="tablehead" colspan="2"><p class="label">Metacat Utilities Classes</p></td>
45
      <td class="tablehead" colspan="2" align="right">
46
        <a href="service-base.html">Back</a> | <a href="./index.html">Home</a> | 
47
        <!-- a href="add next file here when one exists" -->Next<!-- /a -->
48
      </td>
49
    </tr>
50
  </table>
51
  
52
  <div class="header1">Table of Contents</div>
53
  <div class="toc">
54
    <div class="toc1"><a href="#Overview">Overview</a></div>
55
  </div>  
56
  
57
  <a name="Overview"></a><div class="header1">UtiltiesOverview</div>   
58
  <p>Metacat contains its own utilities classes (as opposed to the utilities classes
59
  available in the generic utilities module).  These utilities classes provide services
60
  that are specific to Metacat.  Some of the properties that typify a utility are:</p>
61
  
62
  <ul>
63
    <li>Static methods - all methods are called statically.</li>
64
    <li>No state - there are no state variables in a utility.</li>
65
    <li>Return UtilException on error - this should be the only checked exception 
66
    that gets thrown</li>
67
  </ul>
68
  
69
  <p/> If state becomes an issue, you may want to use a service class to provide
70
  the functionality you need.  See the 
71
  <a href="./service-base.html">Metacat Service Based Architecture page</a> for more 
72
  information on services.</p>
73
    
74
  <br>
75
  <a href="service-base.html">Back</a> | <a href="./index.html">Home</a> | 
76
  <!-- a href="add next file here when one exists" -->Next<!-- /a -->
77
  </ul>
78

    
79
</body>
80
</html>