de.micromata.opengis.kml.v_2_2_0.xal

Class Locality

java.lang.Object

de.micromata.opengis.kml.v_2_2_0.xal.Locality

All Implemented Interfaces:

Cloneable

public class Locality
extends Object
implements Cloneable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Locality.LocalityName

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AddressLine>	addressLine
protected List<Object>	any
protected DependentLocality	dependentLocality
protected String	indicator
protected LargeMailUser	largeMailUser
protected List<Locality.LocalityName>	localityName
protected PostalCode	postalCode
protected PostalRoute	postalRoute
protected PostBox	postBox
protected PostOffice	postOffice
protected Premise	premise
protected Thoroughfare	thoroughfare
protected String	underscore
protected String	usage

Constructor Summary

Constructors

Constructor and Description
Locality(PostBox postBox, LargeMailUser largeMailUser, PostOffice postOffice, PostalRoute postalRoute) Value constructor with only mandatory fields

Method Summary

Methods

Modifier and Type	Method and Description
Locality	addToAddressLine(AddressLine addressLine) add a value to the addressLine property collection
Locality	addToAny(Object any) add a value to the any property collection
Locality	addToLocalityName(Locality.LocalityName localityName) add a value to the localityName property collection
Locality	clone()
AddressLine	createAndAddAddressLine() Creates a new instance of AddressLine and adds it to addressLine.
Locality.LocalityName	createAndAddLocalityName() Creates a new instance of Locality.LocalityName and adds it to localityName.
DependentLocality	createAndSetDependentLocality(PostBox postBox, LargeMailUser largeMailUser, PostOffice postOffice, PostalRoute postalRoute) Creates a new instance of DependentLocality and set it to dependentLocality.
LargeMailUser	createAndSetLargeMailUser() Creates a new instance of LargeMailUser and set it to largeMailUser.
PostalCode	createAndSetPostalCode() Creates a new instance of PostalCode and set it to postalCode.
PostalRoute	createAndSetPostalRoute(List<PostalRoute.PostalRouteName> postalRouteName, PostalRoute.PostalRouteNumber postalRouteNumber) Creates a new instance of PostalRoute and set it to postalRoute.
PostBox	createAndSetPostBox(PostBox.PostBoxNumber postBoxNumber) Creates a new instance of PostBox and set it to postBox.
PostOffice	createAndSetPostOffice() Creates a new instance of PostOffice and set it to postOffice.
Premise	createAndSetPremise(Premise.PremiseLocation premiseLocation, List<PremiseNumber> premiseNumber, Premise.PremiseNumberRange premiseNumberRange) Creates a new instance of Premise and set it to premise.
Thoroughfare	createAndSetThoroughfare(DependentLocality dependentLocality, Premise premise, Firm firm, PostalCode postalCode) Creates a new instance of Thoroughfare and set it to thoroughfare.
boolean	equals(Object obj)
List<AddressLine>	getAddressLine()
List<Object>	getAny()
DependentLocality	getDependentLocality()
String	getIndicator()
LargeMailUser	getLargeMailUser()
List<Locality.LocalityName>	getLocalityName()
Map<QName,String>	getOtherAttributes()
PostalCode	getPostalCode()
PostalRoute	getPostalRoute()
PostBox	getPostBox()
PostOffice	getPostOffice()
Premise	getPremise()
Thoroughfare	getThoroughfare()
String	getUnderscore()
String	getUsage()
int	hashCode()
void	setAddressLine(List<AddressLine> addressLine) Sets the value of the addressLine property Objects of the following type(s) are allowed in the list List.
void	setAny(List<Object> any) Sets the value of the any property Objects of the following type(s) are allowed in the list List
void	setDependentLocality(DependentLocality value)
void	setIndicator(String value)
void	setLargeMailUser(LargeMailUser value)
void	setLocalityName(List<Locality.LocalityName> localityName) Sets the value of the localityName property Objects of the following type(s) are allowed in the list List.
void	setPostalCode(PostalCode value)
void	setPostalRoute(PostalRoute value)
void	setPostBox(PostBox value)
void	setPostOffice(PostOffice value)
void	setPremise(Premise value)
void	setThoroughfare(Thoroughfare value)
void	setUnderscore(String value)
void	setUsage(String value)
Locality	withAddressLine(List<AddressLine> addressLine) fluent setter
Locality	withAny(List<Object> any) fluent setter
Locality	withDependentLocality(DependentLocality dependentLocality) fluent setter
Locality	withIndicator(String indicator) fluent setter
Locality	withLocalityName(List<Locality.LocalityName> localityName) fluent setter
Locality	withPostalCode(PostalCode postalCode) fluent setter
Locality	withPremise(Premise premise) fluent setter
Locality	withThoroughfare(Thoroughfare thoroughfare) fluent setter
Locality	withUnderscore(String underscore) fluent setter
Locality	withUsage(String usage) fluent setter

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

addressLine

protected List<AddressLine> addressLine

localityName

protected List<Locality.LocalityName> localityName

postBox

protected PostBox postBox

largeMailUser

protected LargeMailUser largeMailUser

postOffice

protected PostOffice postOffice

postalRoute

protected PostalRoute postalRoute

thoroughfare

protected Thoroughfare thoroughfare

premise

protected Premise premise

dependentLocality

protected DependentLocality dependentLocality

postalCode

protected PostalCode postalCode

any

protected List<Object> any

underscore

protected String underscore

usage

protected String usage

indicator

protected String indicator

Constructor Detail

Locality

public Locality(PostBox postBox,
        LargeMailUser largeMailUser,
        PostOffice postOffice,
        PostalRoute postalRoute)

Value constructor with only mandatory fields

Parameters:

postBox - required parameter

postOffice - required parameter

postalRoute - required parameter

largeMailUser - required parameter

Method Detail

getAddressLine

public List<AddressLine> getAddressLine()

getLocalityName

public List<Locality.LocalityName> getLocalityName()

getPostBox

public PostBox getPostBox()

Returns:

possible object is PostBox

setPostBox

public void setPostBox(PostBox value)

Parameters:

value - allowed object is PostBox

getLargeMailUser

public LargeMailUser getLargeMailUser()

Returns:

possible object is LargeMailUser

setLargeMailUser

public void setLargeMailUser(LargeMailUser value)

Parameters:

value - allowed object is LargeMailUser

getPostOffice

public PostOffice getPostOffice()

Returns:

possible object is PostOffice

setPostOffice

public void setPostOffice(PostOffice value)

Parameters:

value - allowed object is PostOffice

getPostalRoute

public PostalRoute getPostalRoute()

Returns:

possible object is PostalRoute

setPostalRoute

public void setPostalRoute(PostalRoute value)

Parameters:

value - allowed object is PostalRoute

getThoroughfare

public Thoroughfare getThoroughfare()

Returns:

possible object is Thoroughfare

setThoroughfare

public void setThoroughfare(Thoroughfare value)

Parameters:

value - allowed object is Thoroughfare

getPremise

public Premise getPremise()

Returns:

possible object is Premise

setPremise

public void setPremise(Premise value)

Parameters:

value - allowed object is Premise

getDependentLocality

public DependentLocality getDependentLocality()

Returns:

possible object is DependentLocality

setDependentLocality

public void setDependentLocality(DependentLocality value)

Parameters:

value - allowed object is DependentLocality

getPostalCode

public PostalCode getPostalCode()

Returns:

possible object is PostalCode

setPostalCode

public void setPostalCode(PostalCode value)

Parameters:

value - allowed object is PostalCode

getAny

public List<Object> getAny()

getUnderscore

public String getUnderscore()

Returns:

possible object is String

setUnderscore

public void setUnderscore(String value)

Parameters:

value - allowed object is String

getUsage

public String getUsage()

Returns:

possible object is String

setUsage

public void setUsage(String value)

Parameters:

value - allowed object is String

getIndicator

public String getIndicator()

Returns:

possible object is String

setIndicator

public void setIndicator(String value)

Parameters:

value - allowed object is String

getOtherAttributes

public Map<QName,String> getOtherAttributes()

Returns:

always non-null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

createAndAddAddressLine

public AddressLine createAndAddAddressLine()

Creates a new instance of AddressLine and adds it to addressLine. This method is a short version for: AddressLine addressLine = new AddressLine(); this.getAddressLine().add(addressLine);

createAndAddLocalityName

public Locality.LocalityName createAndAddLocalityName()

Creates a new instance of Locality.LocalityName and adds it to localityName. This method is a short version for: LocalityName localityName = new LocalityName(); this.getLocalityName().add(localityName);

createAndSetPostBox

public PostBox createAndSetPostBox(PostBox.PostBoxNumber postBoxNumber)

Creates a new instance of PostBox and set it to postBox. This method is a short version for: PostBox postBox = new PostBox(); this.setPostBox(postBox);

Parameters:

postBoxNumber - required parameter

createAndSetLargeMailUser

public LargeMailUser createAndSetLargeMailUser()

Creates a new instance of LargeMailUser and set it to largeMailUser. This method is a short version for: LargeMailUser largeMailUser = new LargeMailUser(); this.setLargeMailUser(largeMailUser);

createAndSetPostOffice

public PostOffice createAndSetPostOffice()

Creates a new instance of PostOffice and set it to postOffice. This method is a short version for: PostOffice postOffice = new PostOffice(); this.setPostOffice(postOffice);

createAndSetPostalRoute

public PostalRoute createAndSetPostalRoute(List<PostalRoute.PostalRouteName> postalRouteName,
                                  PostalRoute.PostalRouteNumber postalRouteNumber)

Creates a new instance of PostalRoute and set it to postalRoute. This method is a short version for: PostalRoute postalRoute = new PostalRoute(); this.setPostalRoute(postalRoute);

Parameters:

postalRouteName - required parameter

postalRouteNumber - 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

premise - required parameter

firm - required parameter

dependentLocality - required parameter

createAndSetPremise

public Premise createAndSetPremise(Premise.PremiseLocation premiseLocation,
                          List<PremiseNumber> premiseNumber,
                          Premise.PremiseNumberRange premiseNumberRange)

Creates a new instance of Premise and set it to premise. This method is a short version for: Premise premise = new Premise(); this.setPremise(premise);

Parameters:

premiseNumber - required parameter

premiseNumberRange - required parameter

premiseLocation - required parameter

createAndSetDependentLocality

public DependentLocality createAndSetDependentLocality(PostBox postBox,
                                              LargeMailUser largeMailUser,
                                              PostOffice postOffice,
                                              PostalRoute postalRoute)

Creates a new instance of DependentLocality and set it to dependentLocality. This method is a short version for: DependentLocality dependentLocality = new DependentLocality(); this.setDependentLocality(dependentLocality);

Parameters:

postBox - required parameter

postOffice - required parameter

postalRoute - required parameter

largeMailUser - required parameter

createAndSetPostalCode

public PostalCode createAndSetPostalCode()

Creates a new instance of PostalCode and set it to postalCode. This method is a short version for: PostalCode postalCode = new PostalCode(); this.setPostalCode(postalCode);

setAddressLine

public void setAddressLine(List<AddressLine> addressLine)

Sets the value of the addressLine property Objects of the following type(s) are allowed in the list List.

Note:

This method does not make use of the fluent pattern.If you would like to make it fluent, use withAddressLine(java.util.List<de.micromata.opengis.kml.v_2_2_0.xal.AddressLine>) instead.

Parameters:

addressLine -

addToAddressLine

public Locality addToAddressLine(AddressLine addressLine)

add a value to the addressLine property collection

Parameters:

addressLine - Objects of the following type are allowed in the list: AddressLine

Returns:

true (as general contract of Collection.add).

setLocalityName

public void setLocalityName(List<Locality.LocalityName> localityName)

Sets the value of the localityName property Objects of the following type(s) are allowed in the list List.

Note:

This method does not make use of the fluent pattern.If you would like to make it fluent, use withLocalityName(java.util.List<de.micromata.opengis.kml.v_2_2_0.xal.Locality.LocalityName>) instead.

Parameters:

localityName -

addToLocalityName

public Locality addToLocalityName(Locality.LocalityName localityName)

add a value to the localityName property collection

Parameters:

localityName - Objects of the following type are allowed in the list: Locality.LocalityName

Returns:

true (as general contract of Collection.add).

setAny

public void setAny(List<Object> any)

Sets the value of the any property Objects of the following type(s) are allowed in the list List