01: /*
02: * Copyright 2004-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16:
17: package org.compass.gps.device.support.parallel;
18:
19: import org.compass.gps.CompassGpsException;
20: import org.compass.gps.spi.CompassGpsInterfaceDevice;
21:
22: /**
23: * Indexes a list of groups of {@link org.compass.gps.device.support.parallel.IndexEntity}
24: * already partitioned using the provided {@link org.compass.gps.device.support.parallel.IndexEntitiesIndexer}.
25: *
26: * @author kimchy
27: * @see org.compass.gps.device.support.parallel.AbstractParallelGpsDevice
28: * @see org.compass.gps.device.support.parallel.IndexEntitiesIndexer
29: * @see org.compass.gps.device.support.parallel.IndexEntity
30: */
31: public interface ParallelIndexExecutor {
32:
33: /**
34: * Indexes a list of groups of index entities already partitioned using the provided
35: * index entities indexer.
36: *
37: * @param entities The entities to index
38: * @param indexEntitiesIndexer The indexer to use in order to index the entities
39: * @param compassGps The gps interface to use in order to obtain meta information
40: * @throws CompassGpsException
41: */
42: void performIndex(IndexEntity[][] entities,
43: IndexEntitiesIndexer indexEntitiesIndexer,
44: CompassGpsInterfaceDevice compassGps)
45: throws CompassGpsException;
46: }
|