source: trunk/src/core/net/sf/basedb/core/data/package.html @ 3409

Last change on this file since 3409 was 3409, checked in by Nicklas Nordborg, 14 years ago

References #552, #553, #554: Added information about backwards compatibility and Public vs. Internal
API.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Date
File size: 2.1 KB
Line 
1<!--
2  $Id: package.html 3409 2007-05-30 13:35:40Z nicklas $
3
4  Copyright (C) Authors contributing to this file.
5
6  This file is part of BASE - BioArray Software Environment.
7  Available at http://base.thep.lu.se/
8
9  BASE is free software; you can redistribute it and/or
10  modify it under the terms of the GNU General Public License
11  as published by the Free Software Foundation; either version 2
12  of the License, or (at your option) any later version.
13
14  BASE is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  GNU General Public License for more details.
18
19  You should have received a copy of the GNU General Public License
20  along with this program; if not, write to the Free Software
21  Foundation, Inc., 59 Temple Place - Suite 330,
22  Boston, MA  02111-1307, USA.
23-->
24<body>
25<p>
26  This package contains pure data-holder classes which are mapped
27  to the database using Hibernate. In general, they are not much more
28  than structs with <code>get</code> and <code>set</code> methods
29  to access the data.
30</p>
31<p>
32  The code in this package does not include any business logic, data validation,
33  error handling, database queries or Hibernate dependant code. It is the repsonsibility
34  of the business layer (the {@link net.sf.basedb.core} package) to perform those tasks.
35  For each class in this package, there usually is a corresponding class
36  in the business layer, for example {@link net.sf.basedb.core.data.UserData
37  net.sf.basedb.core.data.UserData} and
38  {@link net.sf.basedb.core.User net.sf.basedb.core.User}.
39</p>
40<p>
41  Client applications do not get direct access to any of the classes
42  in this package. They must use classes from the bussiness layer package
43  {@link net.sf.basedb.core}.
44</p>
45
46<b>See also</b><br>
47<ul>
48<li><a href="../../../../../../../development/overview/data/index.html">An overview of the database schema and data layer API</a>
49<li><a href="../../../../../../../development/coding/data/index.html">Coding rules and guidelines for the data layer</a>
50</ul>
51
52<p>
53  @base.internal Except for the {@link net.sf.basedb.core.data.BatchableData}
54  interface and classes implementing it.
55</p>
56
57</body>
Note: See TracBrowser for help on using the repository browser.