de.micromata.opengis.kml.v_2_2_0.xal
Class AddressDetails

java.lang.Object
  extended by de.micromata.opengis.kml.v_2_2_0.xal.AddressDetails
All Implemented Interfaces:
java.lang.Cloneable

public class AddressDetails
extends java.lang.Object
implements java.lang.Cloneable

A structured address, formatted as xAL, or eXtensible Address Language, an international standard for address formatting. is used by KML for geocoding in Google Maps only. For details, see the Google Maps API documentation. Currently, Google Earth does not use this element; use

instead. Be sure to include the namespace for this element in any KML file that uses it: xmlns:xal="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"

A structured address, formatted as xAL, or eXtensible Address Language, an international standard for address formatting. is used by KML for geocoding in Google Maps only. For details, see the Google Maps API documentation. Currently, Google Earth does not use this element; use

instead. Be sure to include the namespace for this element in any KML file that uses it: xmlns:xal="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"


Nested Class Summary
static class AddressDetails.Address
          
static class AddressDetails.Country
           
static class AddressDetails.PostalServiceElements
           
 
Field Summary
protected  java.lang.String address
          
protected  java.lang.String addressDetailsKey
           
protected  AddressLines addressLines
           
protected  AdministrativeArea administrativeArea
           
protected  java.util.List<java.lang.Object> any
           
protected  java.lang.String code
           
protected  AddressDetails.Country country
           
protected  java.lang.String currentStatus
           
protected  Locality locality
           
protected  AddressDetails.PostalServiceElements postalServiceElements
           
protected  Thoroughfare thoroughfare
           
protected  java.lang.String usage
           
protected  java.lang.String validFromDate
           
protected  java.lang.String validToDate
           
protected  AddressDetails.Address xalAddress
          
 
Constructor Summary
AddressDetails(AddressDetails.Address xalAddress, AddressLines addressLines, AddressDetails.Country country, AdministrativeArea administrativeArea, Locality locality, Thoroughfare thoroughfare)
          Value constructor with only mandatory fields
 
Method Summary
 AddressDetails addToAny(java.lang.Object any)
          add a value to the any property collection
 AddressDetails clone()
           
 AddressLines createAndSetAddressLines(java.util.List<AddressLine> addressLine)
          Creates a new instance of AddressLines and set it to addressLines.
 AdministrativeArea createAndSetAdministrativeArea(Locality locality, PostOffice postOffice, PostalCode postalCode)
          Creates a new instance of AdministrativeArea and set it to administrativeArea.
 AddressDetails.Country createAndSetCountry(AdministrativeArea administrativeArea, Locality locality, Thoroughfare thoroughfare)
          Creates a new instance of AddressDetails.Country and set it to country.
 Locality createAndSetLocality(PostBox postBox, LargeMailUser largeMailUser, PostOffice postOffice, PostalRoute postalRoute)
          Creates a new instance of Locality and set it to locality.
 AddressDetails.PostalServiceElements createAndSetPostalServiceElements()
          Creates a new instance of AddressDetails.PostalServiceElements and set it to postalServiceElements.
 Thoroughfare createAndSetThoroughfare(DependentLocality dependentLocality, Premise premise, Firm firm, PostalCode postalCode)
          Creates a new instance of Thoroughfare and set it to thoroughfare.
 AddressDetails.Address createAndSetXalAddress()
          Creates a new instance of AddressDetails.Address and set it to xalAddress.
 boolean equals(java.lang.Object obj)
           
 java.lang.String getAddress()
           
 java.lang.String getAddressDetailsKey()
           
 AddressLines getAddressLines()
           
 AdministrativeArea getAdministrativeArea()
           
 java.util.List<java.lang.Object> getAny()
           
 java.lang.String getCode()
           
 AddressDetails.Country getCountry()
           
 java.lang.String getCurrentStatus()
           
 Locality getLocality()
           
 java.util.Map<javax.xml.namespace.QName,java.lang.String> getOtherAttributes()
           
 AddressDetails.PostalServiceElements getPostalServiceElements()
           
 Thoroughfare getThoroughfare()
           
 java.lang.String getUsage()
           
 java.lang.String getValidFromDate()
           
 java.lang.String getValidToDate()
           
 AddressDetails.Address getXalAddress()
           
 int hashCode()
           
 void setAddress(java.lang.String value)
           
 void setAddressDetailsKey(java.lang.String value)
           
 void setAddressLines(AddressLines value)
           
 void setAdministrativeArea(AdministrativeArea value)
           
 void setAny(java.util.List<java.lang.Object> any)
           
 void setCode(java.lang.String value)
           
 void setCountry(AddressDetails.Country value)
           
 void setCurrentStatus(java.lang.String value)
           
 void setLocality(Locality value)
           
 void setPostalServiceElements(AddressDetails.PostalServiceElements value)
           
 void setThoroughfare(Thoroughfare value)
           
 void setUsage(java.lang.String value)
           
 void setValidFromDate(java.lang.String value)
           
 void setValidToDate(java.lang.String value)
           
 void setXalAddress(AddressDetails.Address value)
           
 AddressDetails withAddress(java.lang.String address)
          fluent setter
 AddressDetails withAddressDetailsKey(java.lang.String addressDetailsKey)
          fluent setter
 AddressDetails withAny(java.util.List<java.lang.Object> any)
          fluent setter
 AddressDetails withCode(java.lang.String code)
          fluent setter
 AddressDetails withCurrentStatus(java.lang.String currentStatus)
          fluent setter
 AddressDetails withPostalServiceElements(AddressDetails.PostalServiceElements postalServiceElements)
          fluent setter
 AddressDetails withUsage(java.lang.String usage)
          fluent setter
 AddressDetails withValidFromDate(java.lang.String validFromDate)
          fluent setter
 AddressDetails withValidToDate(java.lang.String validToDate)
          fluent setter
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

postalServiceElements

protected AddressDetails.PostalServiceElements postalServiceElements

xalAddress

protected AddressDetails.Address xalAddress

A string value representing an unstructured address written as a standard street, city, state address, and/or as a postal code. You can use the

tag to specify the location of a point instead of using latitude and longitude coordinates. (However, if a is provided, it takes precedence over the
.) To find out which locales are supported for this tag in Google Earth, go to the Google Maps Help.


addressLines

protected AddressLines addressLines

country

protected AddressDetails.Country country

administrativeArea

protected AdministrativeArea administrativeArea

locality

protected Locality locality

thoroughfare

protected Thoroughfare thoroughfare

any

protected java.util.List<java.lang.Object> any

address

protected java.lang.String address

A string value representing an unstructured address written as a standard street, city, state address, and/or as a postal code. You can use the

tag to specify the location of a point instead of using latitude and longitude coordinates. (However, if a is provided, it takes precedence over the
.) To find out which locales are supported for this tag in Google Earth, go to the Google Maps Help.


currentStatus

protected java.lang.String currentStatus

validFromDate

protected java.lang.String validFromDate

validToDate

protected java.lang.String validToDate

usage

protected java.lang.String usage

addressDetailsKey

protected java.lang.String addressDetailsKey

code

protected java.lang.String code
Constructor Detail

AddressDetails

public AddressDetails(AddressDetails.Address xalAddress,
                      AddressLines addressLines,
                      AddressDetails.Country country,
                      AdministrativeArea administrativeArea,
                      Locality locality,
                      Thoroughfare thoroughfare)
Value constructor with only mandatory fields

Parameters:
administrativeArea - required parameter
addressLines - required parameter
locality - required parameter
thoroughfare - required parameter
xalAddress - required parameter
country - required parameter
Method Detail

getPostalServiceElements

public AddressDetails.PostalServiceElements getPostalServiceElements()
Returns:
possible object is AddressDetails.PostalServiceElements
See Also:
postalServiceElements

setPostalServiceElements

public void setPostalServiceElements(AddressDetails.PostalServiceElements value)
Parameters:
value - allowed object is AddressDetails.PostalServiceElements
See Also:
postalServiceElements

getXalAddress

public AddressDetails.Address getXalAddress()
Returns:
possible object is AddressDetails.Address
See Also:
xalAddress

setXalAddress

public void setXalAddress(AddressDetails.Address value)
Parameters:
value - allowed object is AddressDetails.Address
See Also:
xalAddress

getAddressLines

public AddressLines getAddressLines()
Returns:
possible object is AddressLines
See Also:
addressLines

setAddressLines

public void setAddressLines(AddressLines value)
Parameters:
value - allowed object is AddressLines
See Also:
addressLines

getCountry

public AddressDetails.Country getCountry()
Returns:
possible object is AddressDetails.Country
See Also:
country

setCountry

public void setCountry(AddressDetails.Country value)
Parameters:
value - allowed object is AddressDetails.Country
See Also:
country

getAdministrativeArea

public AdministrativeArea getAdministrativeArea()
Returns:
possible object is AdministrativeArea
See Also:
administrativeArea

setAdministrativeArea

public void setAdministrativeArea(AdministrativeArea value)
Parameters:
value - allowed object is AdministrativeArea
See Also:
administrativeArea

getLocality

public Locality getLocality()
Returns:
possible object is Locality
See Also:
locality

setLocality

public void setLocality(Locality value)
Parameters:
value - allowed object is Locality
See Also:
locality

getThoroughfare

public Thoroughfare getThoroughfare()
Returns:
possible object is Thoroughfare
See Also:
thoroughfare

setThoroughfare

public void setThoroughfare(Thoroughfare value)
Parameters:
value - allowed object is Thoroughfare
See Also:
thoroughfare

getAny

public java.util.List<java.lang.Object> getAny()
See Also:
any

getAddress

public java.lang.String getAddress()
Returns:
possible object is String
See Also:
address

setAddress

public void setAddress(java.lang.String value)
Parameters:
value - allowed object is String
See Also:
address

getCurrentStatus

public java.lang.String getCurrentStatus()
Returns:
possible object is String
See Also:
currentStatus

setCurrentStatus

public void setCurrentStatus(java.lang.String value)
Parameters:
value - allowed object is String
See Also:
currentStatus

getValidFromDate

public java.lang.String getValidFromDate()
Returns:
possible object is String
See Also:
validFromDate

setValidFromDate

public void setValidFromDate(java.lang.String value)
Parameters:
value - allowed object is String
See Also:
validFromDate

getValidToDate

public java.lang.String getValidToDate()
Returns:
possible object is String
See Also:
validToDate

setValidToDate

public void setValidToDate(java.lang.String value)
Parameters:
value - allowed object is String
See Also:
validToDate

getUsage

public java.lang.String getUsage()
Returns:
possible object is String
See Also:
usage

setUsage

public void setUsage(java.lang.String value)
Parameters:
value - allowed object is String
See Also:
usage

getAddressDetailsKey

public java.lang.String getAddressDetailsKey()
Returns:
possible object is String
See Also:
addressDetailsKey

setAddressDetailsKey

public void setAddressDetailsKey(java.lang.String value)
Parameters:
value - allowed object is String
See Also:
addressDetailsKey

getCode

public java.lang.String getCode()
Returns:
possible object is String
See Also:
AddressDetails.PostalServiceElements.Barcode

setCode

public void setCode(java.lang.String value)
Parameters:
value - allowed object is String
See Also:
AddressDetails.PostalServiceElements.Barcode

getOtherAttributes

public java.util.Map<javax.xml.namespace.QName,java.lang.String> getOtherAttributes()
Returns:
always non-null
See Also:
otherAttributes

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

createAndSetPostalServiceElements

public AddressDetails.PostalServiceElements createAndSetPostalServiceElements()
Creates a new instance of AddressDetails.PostalServiceElements and set it to postalServiceElements. This method is a short version for: PostalServiceElements postalServiceElements = new PostalServiceElements(); this.setPostalServiceElements(postalServiceElements);


createAndSetXalAddress

public AddressDetails.Address createAndSetXalAddress()
Creates a new instance of AddressDetails.Address and set it to xalAddress. This method is a short version for: Address address = new Address(); this.setXalAddress(address);


createAndSetAddressLines

public AddressLines createAndSetAddressLines(java.util.List<AddressLine> addressLine)
Creates a new instance of AddressLines and set it to addressLines. This method is a short version for: AddressLines addressLines = new AddressLines(); this.setAddressLines(addressLines);

Parameters:
addressLine - required parameter

createAndSetCountry

public AddressDetails.Country createAndSetCountry(AdministrativeArea administrativeArea,
                                                  Locality locality,
                                                  Thoroughfare thoroughfare)
Creates a new instance of AddressDetails.Country and set it to country. This method is a short version for: Country country = new Country(); this.setCountry(country);

Parameters:
administrativeArea - required parameter
locality - required parameter
thoroughfare - required parameter

createAndSetAdministrativeArea

public AdministrativeArea createAndSetAdministrativeArea(Locality locality,
                                                         PostOffice postOffice,
                                                         PostalCode postalCode)
Creates a new instance of AdministrativeArea and set it to administrativeArea. This method is a short version for: AdministrativeArea administrativeArea = new AdministrativeArea(); this.setAdministrativeArea(administrativeArea);

Parameters:
postalCode - required parameter
postOffice - required parameter
locality - required parameter

createAndSetLocality

public Locality createAndSetLocality(PostBox postBox,
                                     LargeMailUser largeMailUser,
                                     PostOffice postOffice,
                                     PostalRoute postalRoute)
Creates a new instance of Locality and set it to locality. This method is a short version for: Locality locality = new Locality(); this.setLocality(locality);

Parameters:
postOffice - required parameter
largeMailUser - required parameter
postalRoute - required parameter
postBox - required parameter

createAndSetThoroughfare

public Thoroughfare createAndSetThoroughfare(DependentLocality dependentLocality,
                                             Premise premise,
                                             Firm firm,
                                             PostalCode postalCode)
Creates a new instance of Thoroughfare and set it to thoroughfare. This method is a short version for: Thoroughfare thoroughfare = new Thoroughfare(); this.setThoroughfare(thoroughfare);

Parameters:
postalCode - required parameter
dependentLocality - required parameter
premise - required parameter
firm - required parameter

setAny

public void setAny(java.util.List<java.lang.Object> any)
Parameters:
any -
See Also:
any

addToAny

public AddressDetails addToAny(java.lang.Object any)
add a value to the any property collection

Parameters:
any - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

withPostalServiceElements

public AddressDetails withPostalServiceElements(AddressDetails.PostalServiceElements postalServiceElements)
fluent setter

Parameters:
postalServiceElements - required parameter
See Also:
setPostalServiceElements(PostalServiceElements)

withAny

public AddressDetails withAny(java.util.List<java.lang.Object> any)
fluent setter

Parameters:
any - required parameter
See Also:
#setAny(List)

withAddress

public AddressDetails withAddress(java.lang.String address)
fluent setter

Parameters:
address - required parameter
See Also:
setAddress(String)

withCurrentStatus

public AddressDetails withCurrentStatus(java.lang.String currentStatus)
fluent setter

Parameters:
currentStatus - required parameter
See Also:
setCurrentStatus(String)

withValidFromDate

public AddressDetails withValidFromDate(java.lang.String validFromDate)
fluent setter

Parameters:
validFromDate - required parameter
See Also:
setValidFromDate(String)

withValidToDate

public AddressDetails withValidToDate(java.lang.String validToDate)
fluent setter

Parameters:
validToDate - required parameter
See Also:
setValidToDate(String)

withUsage

public AddressDetails withUsage(java.lang.String usage)
fluent setter

Parameters:
usage - required parameter
See Also:
setUsage(String)

withAddressDetailsKey

public AddressDetails withAddressDetailsKey(java.lang.String addressDetailsKey)
fluent setter

Parameters:
addressDetailsKey - required parameter
See Also:
setAddressDetailsKey(String)

withCode

public AddressDetails withCode(java.lang.String code)
fluent setter

Parameters:
code - required parameter
See Also:
setCode(String)

clone

public AddressDetails clone()
Overrides:
clone in class java.lang.Object