← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_java/db_set_dup_compare.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdb/docs/api_java/db_set_dup_compare.html
1
 
<!--$Id$-->
2
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
 
<!--All rights reserved.-->
4
 
<!--See the file LICENSE for redistribution information.-->
5
 
<html>
6
 
<head>
7
 
<title>Berkeley DB: Db.set_dup_compare</title>
8
 
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
 
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
10
 
</head>
11
 
<body bgcolor=white>
12
 
<a name="2"><!--meow--></a>
13
 
<table width="100%"><tr valign=top>
14
 
<td>
15
 
<h1>Db.set_dup_compare</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
19
 
</td></tr></table>
20
 
<hr size=1 noshade>
21
 
<tt>
22
 
<h3><pre>
23
 
import com.sleepycat.db.*;
24
 
<p>
25
 
public interface DbDupCompare
26
 
{
27
 
    public abstract int dup_compare(Db db, Dbt dbt1, Dbt dbt2);
28
 
}
29
 
public class Db
30
 
{
31
 
    public void set_dup_compare(DbDupCompare dup_compare)
32
 
        throws DbException;
33
 
    ...
34
 
}
35
 
</pre></h3>
36
 
<h1>Description</h1>
37
 
<p>Set the duplicate data item comparison function.  The comparison function
38
 
is called when it is necessary to compare a data item specified by the
39
 
application with a data item currently stored in the tree.  The first
40
 
argument to the comparison function is the <a href="../api_java/dbt_class.html">Dbt</a> representing the
41
 
application's data item; the second is the current tree's data item.
42
 
Calling Db.set_dup_compare implies calling <a href="../api_java/db_set_flags.html">Db.set_flags</a>
43
 
with the <a href="../api_java/db_set_flags.html#DB_DUPSORT">Db.DB_DUPSORT</a> flag.
44
 
<p>The comparison function must return an integer value less than, equal
45
 
to, or greater than zero if the first data item argument is considered
46
 
to be respectively less than, equal to, or greater than the second data
47
 
item argument.  In addition, the comparison function must cause the data
48
 
items in the set to be <i>well-ordered</i>.  The comparison function
49
 
must correctly handle any data item values used by the application
50
 
(possibly including zero-length data items).  The <b>data</b> and
51
 
<b>size</b> fields of the <a href="../api_java/dbt_class.html">Dbt</a> are the only fields that may be
52
 
used for the purposes of this comparison, and no particular alignment
53
 
of the memory to which the <b>data</b> field refers may be assumed.
54
 
<p>If no comparison function is specified, the data items are compared
55
 
lexically, with shorter data items collating before longer data items.
56
 
<p>The Db.set_dup_compare interface may not be called after the <a href="../api_java/db_open.html">Db.open</a>
57
 
interface is called.
58
 
If the database already exists when
59
 
<a href="../api_java/db_open.html">Db.open</a> is called, the information specified to Db.set_dup_compare must
60
 
be the same as that historically used to create the database or
61
 
corruption can occur.
62
 
<p>The Db.set_dup_compare method throws an exception that encapsulates a non-zero error value on
63
 
failure.
64
 
<h1>Errors</h1>
65
 
<p>The Db.set_dup_compare method may fail and throw an exception encapsulating a non-zero error for the following conditions:
66
 
<p><dl compact>
67
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
68
 
</dl>
69
 
<p>The Db.set_dup_compare method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
70
 
If a catastrophic error has occurred, the Db.set_dup_compare method may fail and
71
 
throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>,
72
 
in which case all subsequent Berkeley DB calls will fail in the same way.
73
 
<h1>Class</h1>
74
 
<a href="../api_java/db_class.html">Db</a>
75
 
<h1>See Also</h1>
76
 
<a href="../api_java/db_list.html">Databases and Related Methods</a>
77
 
</tt>
78
 
<table width="100%"><tr><td><br></td><td align=right>
79
 
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
80
 
</td></tr></table>
81
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
82
 
</body>
83
 
</html>