01: /**********************************************************************
02: Copyright (c) 2006 Andy Jefferson and others. All rights reserved.
03: Licensed under the Apache License, Version 2.0 (the "License");
04: you may not use this file except in compliance with the License.
05: You may obtain a copy of the License at
06:
07: http://www.apache.org/licenses/LICENSE-2.0
08:
09: Unless required by applicable law or agreed to in writing, software
10: distributed under the License is distributed on an "AS IS" BASIS,
11: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12: See the License for the specific language governing permissions and
13: limitations under the License.
14:
15: Contributors:
16: ...
17: **********************************************************************/package org.jpox.store.query;
18:
19: import org.jpox.ObjectManager;
20:
21: /**
22: * An object that reads result set rows and returns corresponding object(s) from them.
23: * Different queries accomplish this in different ways so a query supplies a suitable ResultObjectFactory
24: * to each QueryResult when it is executed. The QueryResult only uses it to turn ResultSet rows into objects
25: * and otherwise manages the ResultSet itself.
26: * <p>
27: * For example an implementation of this interface could return a single Persistent object per row (PersistentIDROF).
28: * Another implementation could return all columns of the result set as separate objects.
29: * </p>
30: *
31: * @see QueryResult
32: * @version $Revision: 1.4 $
33: */
34: public interface ResultObjectFactory {
35: /**
36: * Instantiates object(s) from the current row of the given result set.
37: * @param om The ObjectManager.
38: * @param rs The result set which will be used to convert the current row into the returned object(s).
39: * @return The object(s) for this row of the ResultSet.
40: */
41: Object getObject(ObjectManager om, Object rs);
42: }
|