Nearcode

Example Name: NcdCS

Language: Java

API type: Java

API component filename: capscan.jar

Environment: Java 1.4 or higher

What does it do?

Demonstrates the use of Nearcode client API. It connects to the Nearcode Pool Manager and queries the server via a user entered search string therefore allowing the user to familiarise themselves with the fields returned by the server. It specifically demonstrates the process of a nearest records lookup using psearch.

Could be used as a starting point for:

Learning about Nearcode and as sample API code, specifically connecting to Nearcode Pool Manager and performing a search.

Where to find the example code:

After running the setup from the Nearcode CD to install the client APIs you will find these examples installed (by default) in:

C:\Program Files\Capscan\SDK\Nearcode Client API\Java\Examples

If you have installed to another location you will need to change the path where necessary.

What each file does:

File name What does it do?

NcdCS.java Source code for the example.

Preparing to run the example:

Please make sure that you have installed the Nearcode Server and that it is up and running. If you install the Libraries example data during installation a LibrariesExample pool will have been created. Else you will need to configure a Nearcode server to run a Nearcode pool.

Running the example:

1. Open a Command Prompt.

2. cd "C:\Program Files\Capscan\SDK\Nearcode Client\Java\Examples "

3. Make sure capscan.jar and the example directory is in the CLASSPATH.

4. javac NcdCS.java

5. java NcdCS hostname poolname

6. Once you have connected to the Capscan Pool Manager you will presented with prompt where you can enter a search to run.

7. The "help" command displays a list of commands. When followed by a command name it displays a description of that command.

8. The "columns" command displays a list of available fields.

9. The "select" command runs a search. Below is an example of a select command.

SELECT nearestrecords FROM psearch WHERE postcode="nw1 9bb"

10. This search will return a list of records near the postcode "nw1 9bb".

11. To exit use the command "exit".

Trouble-shooting and hints:

1. If you are running on a LAN make sure that the Capscan Pool Manager is running correctly. To do this you can use the PoolMan Admin application that is installed along with the Capscan Pool Manager.

2. If you are using a firewall make sure that it is not blocking this example or the Capscan Pool Manager. By default the Capscan Client/Server uses port 27920 for sending and receiving data.

3. For more hints and tips please see the SDK bookshelf documentation.