christophedelory.betty.xml
Class LocationDetails

java.lang.Object
  christophedelory.betty.xml.Child
      christophedelory.betty.xml.IdDetails
          christophedelory.betty.xml.CountryDetails
              christophedelory.betty.xml.LocationDetails

All Implemented Interfaces:

XmlRoot, Serializable

public class LocationDetails
extends CountryDetails
implements XmlRoot

The definition of an event's location.

Version:

$Revision: 106 $

Author:

Christophe Delory

See Also:

LocationBean, Serialized Form

Constructor Summary

LocationDetails()

Method Summary

void	accept(XmlVisitor visitor) Accepts the specified XML visitor.
void	addSubLocation(LocationDetails location) Adds a child location to this one.
LocationDetails	findLocation(String locationId) Returns the location with the specified identifier in this locations list.
String	getParentId() Returns the identifier of the parent location, if any.
List<LocationDetails>	getSubLocations() Returns a list of child locations.
String	getTimeZone() Returns the time zone of this location.
String	getTimeZoneId() Returns the identifier of the time zone of this location.
void	setParentId(String id) Initializes the identifier of the parent location.
void	setTimeZoneId(String timeZone) Initializes the identifier of the time zone of this location.

Methods inherited from class christophedelory.betty.xml.CountryDetails

getCountry, getCountryBoolean, isCountry, setCountry, setCountryBoolean, setIsCountry

Methods inherited from class christophedelory.betty.xml.IdDetails

addDescription, addLink, findDescriptionByLocale, findLinkByLocale, getDescriptions, getId, getLinks, setId

Methods inherited from class christophedelory.betty.xml.Child

getParent, getRoot, getRoot, getVersion, setParent, setVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface christophedelory.betty.xml.XmlRoot

getVersion, setVersion

Constructor Detail

LocationDetails

public LocationDetails()

Method Detail

setParentId

public void setParentId(String id)

Initializes the identifier of the parent location.

Parameters:

id - a location identifier. May be null.

See Also:

getParentId()

getParentId

public String getParentId()

Returns the identifier of the parent location, if any.

Returns:

a location identifier. May be null.

See Also:

setParentId(String)

getTimeZone

public String getTimeZone()

Returns the time zone of this location.

Returns:

a time zone. May be null.

See Also:

getTimeZoneId(), Child.getParent()

setTimeZoneId

public void setTimeZoneId(String timeZone)

Initializes the identifier of the time zone of this location.

Parameters:

timeZone - a time zone identifier. May be null.

See Also:

getTimeZoneId()

getTimeZoneId

public String getTimeZoneId()

Returns the identifier of the time zone of this location.

Returns:

a time zone identifier. May be null.

See Also:

setTimeZoneId(String), getTimeZone()

getSubLocations

public List<LocationDetails> getSubLocations()

Returns a list of child locations.

Returns:

a list of locations. May be empty but not null.

See Also:

addSubLocation(LocationDetails)

addSubLocation

public void addSubLocation(LocationDetails location)

Adds a child location to this one.

Parameters:

location - a location. Shall not be null.

Throws:

NullPointerException - if location is null.

See Also:

getSubLocations()

findLocation

public LocationDetails findLocation(String locationId)

Returns the location with the specified identifier in this locations list.

Parameters:

locationId - a location identifier. May be null.

Returns:

a location, or null if none could be found.

Since:

1.0.0

accept

public void accept(XmlVisitor visitor)
            throws Exception

Description copied from class: IdDetails

Accepts the specified XML visitor.

Specified by:

accept in interface XmlRoot

Overrides:

accept in class IdDetails

Parameters:

visitor - a visitor. Shall not be null.

Throws:

NullPointerException - if visitor is null.

Exception - if any error occurs during the visit.