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;
18:
19: /**
20: * An active mirror gps device, meaning that in order to perform the mirror
21: * operation, one must actively call the {@link #performMirroring()} method.
22: * <p>
23: * Compass::Gps provides a way to schedule active mirror gps devices by using
24: * the {@link org.compass.gps.device.ScheduledMirrorGpsDevice} gps device
25: * wrapper.
26: *
27: * @author kimchy
28: * @see org.compass.gps.device.ScheduledMirrorGpsDevice
29: */
30: public interface ActiveMirrorGpsDevice extends
31: MirrorDataChangesGpsDevice {
32:
33: /**
34: * Perform the actual data changes mirror operation. The operation will
35: * detect all the changes made to the data source since the last
36: * indexing/mirroring operation and reflect it to the index.
37: *
38: * @throws CompassGpsException
39: */
40: void performMirroring() throws CompassGpsException;
41:
42: }
|