com.moximedia.aims
Class AimsGeocode

java.lang.Object
  com.moximedia.aims.AimsGeocode

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class AimsGeocode

extends java.lang.Object

implements java.lang.Cloneable, java.io.Serializable

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Field Summary

java.lang.String

m_responseAxl

Constructor Summary

AimsGeocode()
Creates new AimsGeocode

Method Summary

protected boolean	addFeature(AimsFeature feature) Adds a feature to the features collection.
void	addGeocodeTag(AimsGeocodeTag gctag)
void	addGeocodeTag(java.lang.String id, java.lang.String value)
boolean	BOF() Returns true if the recordset is at the beginning (before the first record).
void	clear()
void	clearAddress()
void	clearResults()
java.lang.Object	clone()
boolean	EOF() Returns true if the recordset is at the end (after the last record).
int	getCurrentRecord()
AimsFeature	getFeature() Returns the feature for the current record.
AimsFeature	getFeature(int recordNumber) Returns the feature for the specified record.
int	getFeatureCount()
AimsShapeObject	getShape() Returns the shape for the current recordset record as an AimsShapeObject.
AimsShapeObject	getShape(int recordNumber) Returns the shape for the specified recordset record as an AimsShapeObject.
boolean	moveFirst()
boolean	moveNext()
boolean	movePrevious()
boolean	query()
void	setAddress(java.lang.String id, java.lang.String value)
void	setAxlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.
void	setFeatureCoordsys(AimsCoordsys coordsys) Sets the feature coordsys.
protected void	setLayer(AimsFeatureLayer layer)
void	setMaxCandidates(int maxCandidates)
void	setMinScore(int minScore)
void	setSpellingSensitivity(int sensitivity)
java.lang.String	toAxlString() Returns the AXL string to refresh this object, using the default environment coordinate separators.
java.lang.String	toAxlString(AimsEnvironment env) Returns the AXL string to refresh this object, using the coordinate separators in the specified environnment setting.
java.lang.String	valueAsString(java.lang.String fieldName) Returns the contents of the specified field for the current recordset record as a string value.
java.lang.String	valueAsString(java.lang.String fieldName, int recordNumber) Returns the contents of the specified field for the specified record as a string value.

Methods inherited from class java.lang.Object

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

Field Detail

m_responseAxl

public java.lang.String m_responseAxl

Constructor Detail

AimsGeocode

public AimsGeocode()

Creates new AimsGeocode

Method Detail

clear

public void clear()

clearAddress

public void clearAddress()

setAddress

public void setAddress(java.lang.String id,
                       java.lang.String value)

clone

public java.lang.Object clone()

addFeature

protected boolean addFeature(AimsFeature feature)

Adds a feature to the features collection. This method is protected, as features cannot be arbitrarily added by the programmer.

Parameters:

feature - A feature to add to the feature collection.

Returns:

True if successful, otherwise false.

addGeocodeTag

public void addGeocodeTag(AimsGeocodeTag gctag)

addGeocodeTag

public void addGeocodeTag(java.lang.String id,
                          java.lang.String value)

setFeatureCoordsys

public void setFeatureCoordsys(AimsCoordsys coordsys)

Sets the feature coordsys.

Parameters:

coordsys - The feature coordsys used to locate features.

setLayer

protected void setLayer(AimsFeatureLayer layer)

setMaxCandidates

public void setMaxCandidates(int maxCandidates)

setMinScore

public void setMinScore(int minScore)

setSpellingSensitivity

public void setSpellingSensitivity(int sensitivity)

toAxlString

public java.lang.String toAxlString()

Returns the AXL string to refresh this object, using the default environment coordinate separators. This method is not typically used by the application programmer.

Returns:

The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(AimsEnvironment env)

Returns the AXL string to refresh this object, using the coordinate separators in the specified environnment setting. This method is not typically used by the application programmer.

Parameters:

env - The environment object containing coordinate separators.

Returns:

The AXL string to refresh this object.

getCurrentRecord

public int getCurrentRecord()

getFeatureCount

public int getFeatureCount()

BOF

public boolean BOF()

Returns true if the recordset is at the beginning (before the first record).

Returns:

True if the recorset is at the beginning.

EOF

public boolean EOF()

Returns true if the recordset is at the end (after the last record).

Returns:

True if the recorset is at the end.

moveNext

public boolean moveNext()

movePrevious

public boolean movePrevious()

moveFirst

public boolean moveFirst()

getFeature

public AimsFeature getFeature()

Returns the feature for the current record.

Returns:

The feature for the current record, or null.

getFeature

public AimsFeature getFeature(int recordNumber)

Returns the feature for the specified record.

Parameters:

recordNumber - The index of the requested record.

Returns:

The feature for the specified record, or null.

valueAsString

public java.lang.String valueAsString(java.lang.String fieldName,
                                      int recordNumber)

Returns the contents of the specified field for the specified record as a string value. This method returns an error string if the specified record does not point at a valid record.

Parameters:

fieldName - The name of the field that contents are requested.

recordNumber - The index of the requested record.

Returns:

The content of the field as a string

valueAsString

public java.lang.String valueAsString(java.lang.String fieldName)

Returns the contents of the specified field for the current recordset record as a string value. This method returns an error string if the current record does not point at a valid record.

Parameters:

fieldName - The name of the field that contents are requested.

Returns:

The content of the field as a string

getShape

public AimsShapeObject getShape(int recordNumber)

Returns the shape for the specified recordset record as an AimsShapeObject. This method returns null if the specified record number does not point at a valid record.

Parameters:

recordNumber - The index of the requested record.

Returns:

The shape associated with the current record

getShape

public AimsShapeObject getShape()

Returns the shape for the current recordset record as an AimsShapeObject. This method returns null if the current record does not point at a valid record.

Returns:

The shape associated with the current record

clearResults

public void clearResults()

query

public boolean query()

setAxlAttribute

public void setAxlAttribute(java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value)

Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:

tag - The AXL element tag containing this attribute (not used).

name - The AXL attribute name.

value - The AXL attribute value.