Java Doc for CompassGpsDevice.java in  » Search-Engine » compass-2.0 » org » compass » gps » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Search Engine » compass 2.0 » org.compass.gps 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.compass.gps.CompassGpsDevice

All known Subclasses:   org.compass.gps.device.AbstractGpsDeviceWrapper,  org.compass.gps.device.AbstractGpsDevice,
CompassGpsDevice
public interface CompassGpsDevice (Code)
A Compass Gps Device is responsible for interacting with a data source and reflecting it in a compass index. A data source can be a file system, or a database through the use of ORM tool (like hibernate).

A device should be able to provide the ability to index the data source, which usually means iterating through the device data and indexing it. It might also provide "real time" monitoring of changes in the device, and applying them to the index as well.

A CompassGpsDevice can not operate as a standalone, and must be a part of a org.compass.gps.CompassGps instance (even if we have only one device), since the device requires the Compass and the Batch Compass instances in order to apply the changes to the index.

The device has a name associated with it, and the name must be unique among all the devices within a single CompassGps instance.
author:
   kimchy





Method Summary
 CompassGpsgetGps()
     Returns the CompassGps that manages the device.
 StringgetName()
     Returns the name associated with the device.
 voidindex()
     Index the device.
 voidinjectGps(CompassGps compassGps)
     Sets the CompassGps that manages the device.
public  booleanisPerformingIndexOperation()
     Retuns true if the devide performs the index operaiton.
 booleanisRunning()
     Returns if the device is running.
 voidsetName(String name)
     Sets the name associated with the device.
 booleanshouldMirrorDataChanges()
     Returns true if the device is required to perform mirror operation.
 voidstart()
     Starts the device.
 voidstop()
     Stops the device.



Method Detail
getGps
CompassGps getGps()(Code)
Returns the CompassGps that manages the device. compassGps



getName
String getName()(Code)
Returns the name associated with the device. The name of the device.



index
void index() throws CompassGpsException, IllegalStateException(Code)
Index the device. Optional, since it is preferable to manage the all the devices through the CompassGps API.
throws:
  CompassGpsException -
throws:
  IllegalStateException -



injectGps
void injectGps(CompassGps compassGps)(Code)
Sets the CompassGps that manages the device. Optional, since if the device is added to a CompassGps instance, it will be done automatically.



isPerformingIndexOperation
public boolean isPerformingIndexOperation()(Code)
Retuns true if the devide performs the index operaiton.



isRunning
boolean isRunning()(Code)
Returns if the device is running. true if theh device is running



setName
void setName(String name)(Code)
Sets the name associated with the device.



shouldMirrorDataChanges
boolean shouldMirrorDataChanges()(Code)
Returns true if the device is required to perform mirror operation.



start
void start() throws CompassGpsException(Code)
Starts the device. Optional, since it is preferable to manage the all the devices through the CompassGps API.
throws:
  CompassGpsException -



stop
void stop() throws CompassGpsException(Code)
Stops the device. Optional, since it is preferable to manage the all the devices through the CompassGps API.
throws:
  CompassGpsException -



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.