Oracle Application Server Wireless Java API Reference
B10400-01

oracle.panama.model
Interface Location

All Superinterfaces:
Point, java.io.Serializable
All Known Subinterfaces:
ExtendedLocation, ExtendedYPBusiness, IntlAddress, LocationMark, YPBusiness

public interface Location
extends Point

Location is a representation of an address with its coordinates (longitude and latitude).


Method Summary
 boolean geocode(boolean checkWhetherNecessary, boolean makeCorrections)
          This function geocodes this address, thus finds its lat/lon location.
 java.lang.String getAddressLastLine()
           
 java.lang.String getAddressLine1()
           
 java.lang.String getAddressLine2()
           
 java.lang.String getBlock()
           
 java.lang.String getCity()
           
 java.lang.String getCompanyName()
           
 java.lang.String getCountry()
           
 java.lang.String getCounty()
           
 ProviderCredit getGeocodeProvider()
           
 java.lang.String getMatchMode()
           
 java.lang.String getPostalCode()
           
 java.lang.String getPostalCodeExt()
           
 java.lang.String getState()
           
 void setAddressLastLine(java.lang.String addrlastline)
           
 void setAddressLine1(java.lang.String addrline1)
           
 void setAddressLine2(java.lang.String addrline2)
           
 void setBlock(java.lang.String block)
           
 void setCity(java.lang.String city)
           
 void setCompanyName(java.lang.String companyName)
           
 void setCountry(java.lang.String country)
           
 void setCounty(java.lang.String county)
           
 void setGeocodeProvider(ProviderCredit credit)
           
 void setMatchMode(java.lang.String matchmode)
           
 void setPostalCode(java.lang.String postalCode)
           
 void setPostalCodeExt(java.lang.String postalCodeExt)
           
 void setState(java.lang.String state)
           

 

Methods inherited from interface oracle.panama.model.Point
getDistance, getLabel, getLatitude, getLongitude, getPositionProvider, getRadius, setLabel, setLatitude, setLongitude, setPositionProvider, setRadius

 

Method Detail

getCompanyName

public java.lang.String getCompanyName()

setCompanyName

public void setCompanyName(java.lang.String companyName)

getAddressLine1

public java.lang.String getAddressLine1()

setAddressLine1

public void setAddressLine1(java.lang.String addrline1)

getAddressLine2

public java.lang.String getAddressLine2()

setAddressLine2

public void setAddressLine2(java.lang.String addrline2)

getAddressLastLine

public java.lang.String getAddressLastLine()

setAddressLastLine

public void setAddressLastLine(java.lang.String addrlastline)

getBlock

public java.lang.String getBlock()

setBlock

public void setBlock(java.lang.String block)

getCity

public java.lang.String getCity()

setCity

public void setCity(java.lang.String city)

getCounty

public java.lang.String getCounty()

setCounty

public void setCounty(java.lang.String county)

getState

public java.lang.String getState()

setState

public void setState(java.lang.String state)

getPostalCode

public java.lang.String getPostalCode()

setPostalCode

public void setPostalCode(java.lang.String postalCode)

getPostalCodeExt

public java.lang.String getPostalCodeExt()

setPostalCodeExt

public void setPostalCodeExt(java.lang.String postalCodeExt)

getCountry

public java.lang.String getCountry()

setCountry

public void setCountry(java.lang.String country)

getMatchMode

public java.lang.String getMatchMode()

setMatchMode

public void setMatchMode(java.lang.String matchmode)

geocode

public boolean geocode(boolean checkWhetherNecessary,
                       boolean makeCorrections)
This function geocodes this address, thus finds its lat/lon location. This is a convenient version of geocodeAddress in the class Geocoder. Generally, geocoding returns a list of alternative addresses if the input address was ambiguous. Furthermore, the geocoder might correct the input address and add previously unspecified field values, such as postal code extension. This convenient function, however, will only consider the first of potentially several resulting addresses. It will furthermore only make a correction to inexact field values, such as an incorrectly spelled company name, if requested.
Parameters:
checkWhetherNecessary - a boolean representing whether geocoding should only be performed if the location is not yet known (true) or whether it should be done irrespective of previously performed geocoding.
makeCorrections - a boolean representing whether non-existant, incorrect or inexact components of the address should be automatically corrected. The quality of the correction depends on the specific external geocoder and a correct value might be substituted for an alternative, equally correct value.
Returns:
a boolean representing whether the geocoding has been successful

getGeocodeProvider

public ProviderCredit getGeocodeProvider()

setGeocodeProvider

public void setGeocodeProvider(ProviderCredit credit)

Oracle Application Server Wireless Java API Reference
B10400-01

Copyright © 2003 Oracle Corporation. All Rights Reserved.