org.compass.gps.spi
Interface CompassGpsInterfaceDevice

All Superinterfaces:
CompassGps
All Known Implementing Classes:
AbstractCompassGps, DefaultJpaCompassGps, DualCompassGps, SingleCompassGps

public interface CompassGpsInterfaceDevice
extends CompassGps

An extension to the CompassGps interface which should be used by devices. Provides abstraction from the actual Compass instances management.

Author:
kimchy

Method Summary
 void executeForIndex(CompassCallback callback)
          Executes the given callback for index operations.
 void executeForMirror(CompassCallback callback)
          Executes the given callback for mirror operations.
 Compass getIndexCompass()
          Returns the Compass instance used for indexing.
 ResourceMapping getMappingForEntityForIndex(Class clazz)
          Returns the mapping for the given class name when performing the index operation.
 ResourceMapping getMappingForEntityForIndex(String name)
          Returns the mapping of the given name (alias or class name) when performing the index operation.
 Compass getMirrorCompass()
          Returns the Compass instance used for mirroring.
 boolean hasMappingForEntityForIndex(Class clazz)
          Returns true if there is mapping for the given class when performing the index operation.
 boolean hasMappingForEntityForIndex(String name)
          Returns true if there is mapping for the given name (alias or class name) when performing the index operation.
 boolean hasMappingForEntityForMirror(Class clazz, CascadeMapping.Cascade cascade)
          Returns true if there is mapping for the given class when performing the mirror operation.
 boolean hasMappingForEntityForMirror(String name, CascadeMapping.Cascade cascade)
          Returns true if there is mapping for the given name (alias or class name) when performing the mirror operation.
 
Methods inherited from interface org.compass.gps.CompassGps
addGpsDevice, index, index, index, index, isPerformingIndexOperation, isRunning, setGpsDevices, start, stop
 

Method Detail

hasMappingForEntityForMirror

boolean hasMappingForEntityForMirror(Class clazz,
                                     CascadeMapping.Cascade cascade)
                                     throws CompassException
Returns true if there is mapping for the given class when performing the mirror operation.

Throws:
CompassException

hasMappingForEntityForMirror

boolean hasMappingForEntityForMirror(String name,
                                     CascadeMapping.Cascade cascade)
                                     throws CompassException
Returns true if there is mapping for the given name (alias or class name) when performing the mirror operation.

Throws:
CompassException

hasMappingForEntityForIndex

boolean hasMappingForEntityForIndex(Class clazz)
                                    throws CompassException
Returns true if there is mapping for the given class when performing the index operation.

Throws:
CompassException

hasMappingForEntityForIndex

boolean hasMappingForEntityForIndex(String name)
                                    throws CompassException
Returns true if there is mapping for the given name (alias or class name) when performing the index operation.

Throws:
CompassException

getMappingForEntityForIndex

ResourceMapping getMappingForEntityForIndex(String name)
                                            throws CompassException
Returns the mapping of the given name (alias or class name) when performing the index operation.

Throws:
CompassException

getMappingForEntityForIndex

ResourceMapping getMappingForEntityForIndex(Class clazz)
                                            throws CompassException
Returns the mapping for the given class name when performing the index operation.

Throws:
CompassException

executeForIndex

void executeForIndex(CompassCallback callback)
                     throws CompassException
Executes the given callback for index operations.

Throws:
CompassException

executeForMirror

void executeForMirror(CompassCallback callback)
                      throws CompassException
Executes the given callback for mirror operations.

Throws:
CompassException

getIndexCompass

Compass getIndexCompass()
Returns the Compass instance used for indexing. Note that no operations that will affect the index should be made using it, use executeForIndex(CompassCallback) operation instead.


getMirrorCompass

Compass getMirrorCompass()
Returns the Compass instance used for mirroring. Note that no operations that will affect the index should be made using it, use executeForMirror(CompassCallback) operation instead.



Copyright (c) 2004-2008 The Compass Project.