com.aspc.commander.sql

Class MapCommand

java.lang.Object

com.aspc.commander.Command

com.aspc.commander.sql.SQLCommand

com.aspc.commander.sql.MapCommand

All Implemented Interfaces:

CommandBuildResultsPlugin

public class MapCommand
extends SQLCommand

Geocoding an address or reverse geocoding a coordinate with google map api web service.

For details of the web service, goto https://developers.google.com/maps /documentation/geocoding/index
Syntax

  MAP [ADDRESS address] | [LATLNG latlng] [UPDATE global_key, field] [GOOGLE_KEY key]
  

Usage

  /* get the coordinate of an address */
  MAP ADDRESS '268 Burwood Road, Burwood, NSW';
  
  /* get the address for a coordinate which latitude is -33.13232 and longitude is 151.112849 */
  MAP LATLNG -33.13232,151.112849;
  
  /* get the coordinate of an address and update a field with the coordinate */
  MAP ADDRESS '268 Burwood Road, Burwood, NSW' UPDATE 13237@99999~233@2 coordinate;
  

THREAD MODE: SINGLE THREADED command

Since:

10 January 2014

Author:

Lei Gao

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_GOOGLE_API_KEY

Fields inherited from class com.aspc.commander.sql.SQLCommand

CURSOR_SIZE

Constructor Summary

Constructors

Constructor and Description
MapCommand(Connection connection, Pattern pattern)

Method Summary

Modifier and Type	Method and Description
protected void	execute(Parser p) execute the command.
java.lang.String	getColumnName(int col) Not mandatory to supply a key for the row as well.
java.lang.String	getColumnType(int col) get the column type
java.lang.String	getRecordID(int row) We are at the last row when we return null for the record ID.
java.lang.Object	getValue(int row, int col) The value for this column/row

Methods inherited from class com.aspc.commander.sql.SQLCommand

appendResult, appendResult, getCursorName, getRecordKey, isExecuteOnly

Methods inherited from class com.aspc.commander.Command

execute, extMakeThreadName, getConnection, getPattern, getRawTitle, getTitle, makeThreadName, recordCall, setTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aspc.commander.sql.results.CommandBuildResultsPlugin

getRawTitle

Field Detail

PROPERTY_GOOGLE_API_KEY

public static final java.lang.String PROPERTY_GOOGLE_API_KEY

See Also:

Constant Field Values

Constructor Detail

MapCommand

public MapCommand(Connection connection,
                  Pattern pattern)

Method Detail

execute

protected void execute(Parser p)
                throws java.lang.Exception

Description copied from class: Command

execute the command.

Specified by:

execute in class Command

Parameters:

p - The actual command.

Throws:

java.lang.Exception - A serious problem

getRecordID

public java.lang.String getRecordID(int row)

Description copied from interface: CommandBuildResultsPlugin

We are at the last row when we return null for the record ID. All rows must have a unique ID. Nothing else is assumed about a record ID other than it is unique and will return the same value at a later time.

Parameters:

row - The row number ( offset from 1)

Returns:

The record ID

getColumnName

public java.lang.String getColumnName(int col)

Description copied from interface: CommandBuildResultsPlugin

Not mandatory to supply a key for the row as well. If not the ID will be used.

Parameters:

col - The column number ( offset from 1)

Returns:

The column name

getColumnType

public java.lang.String getColumnType(int col)
                               throws java.lang.Exception

Description copied from interface: CommandBuildResultsPlugin

get the column type

Parameters:

col - The column number ( offset from 1)

Returns:

The column name

Throws:

java.lang.Exception - A serious problem

getValue

public java.lang.Object getValue(int row,
                                 int col)
                          throws java.lang.Exception

Description copied from interface: CommandBuildResultsPlugin

The value for this column/row

Parameters:

row - The row number ( offset from 1)

col - The column number ( offset from 1)

Returns:

The value

Throws:

java.lang.Exception - A serious problem