KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > db4o > query > Candidate


1 /* Copyright (C) 2004 - 2006 db4objects Inc. http://www.db4o.com
2
3 This file is part of the db4o open source object database.
4
5 db4o is free software; you can redistribute it and/or modify it under
6 the terms of version 2 of the GNU General Public License as published
7 by the Free Software Foundation and as clarified by db4objects' GPL
8 interpretation policy, available at
9 http://www.db4o.com/about/company/legalpolicies/gplinterpretation/
10 Alternatively you can write to db4objects, Inc., 1900 S Norfolk Street,
11 Suite 350, San Mateo, CA 94403, USA.
12
13 db4o is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 for more details.
17
18 You should have received a copy of the GNU General Public License along
19 with this program; if not, write to the Free Software Foundation, Inc.,
20 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
21 package com.db4o.query;
22
23 import com.db4o.*;
24
25 /**
26  * candidate for {@link Evaluation} callbacks.
27  * <br><br>
28  * During {@link Query#execute() query execution} all registered {@link Evaluation} callback
29  * handlers are called with {@link Candidate} proxies that represent the persistent objects that
30  * meet all other {@link Query} criteria.
31  * <br><br>
32  * A {@link Candidate} provides access to the persistent object it
33  * represents and allows to specify, whether it is to be included in the
34  * {@link ObjectSet} resultset.
35  */
36 public interface Candidate {
37     
38     /**
39      * returns the persistent object that is represented by this query
40      * {@link Candidate}.
41      * @return Object the persistent object.
42      */
43     public Object JavaDoc getObject();
44     
45     /**
46      * specify whether the Candidate is to be included in the
47      * {@link ObjectSet} resultset.
48      * <br><br>
49      * This method may be called multiple times. The last call prevails.
50      * @param flag inclusion.
51      */
52     public void include(boolean flag);
53     
54     
55     /**
56      * returns the {@link ObjectContainer} the Candidate object is stored in.
57      * @return the {@link ObjectContainer}
58      */
59     public ObjectContainer objectContainer();
60     
61 }
62
Popular Tags