com.cinterion.location

Class Landmark

java.lang.Object

com.cinterion.location.Landmark

public class Landmark
extends Object

The Landmark class is a container for the landmark information. It consists of a name and optional a description, coordinates and address information.

Constructor Summary

Constructors

Constructor and Description
Landmark(String name, String description, QualifiedCoordinates coordinates, AddressInfo addressInfo) Constructs a new Landmark object.

Method Summary

Methods

Modifier and Type	Method and Description
AddressInfo	getAddressInfo() Returns the AddressInfo of the landmark.
String	getDescription() Returns the landmark description.
String	getName() Gets the landmark name.
QualifiedCoordinates	getQualifiedCoordinates() Returns the QualifiedCoordinates of the landmark.
void	setAddressInfo(AddressInfo addressInfo) Sets the AddressInfo of the landmark.
void	setDescription(String description) Sets the description of the landmark.
void	setName(String name) Sets the name of the landmark.
void	setQualifiedCoordinates(QualifiedCoordinates coordinates) Sets the QualifiedCoordinates of the landmark.

Methods inherited from class java.lang.Object

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

Constructor Detail

Landmark

public Landmark(String name,
        String description,
        QualifiedCoordinates coordinates,
        AddressInfo addressInfo)

Constructs a new Landmark object.

Parameters:

name - the name of the landmark

description - description of the landmark. null if not available.

coordinates - the Coordinates of the landmark. null if not known.

addressInfo - the textual address information of the landmark. null if not known.

Throws:

NullPointerException - if the name is null

Method Detail

getName

public String getName()

Gets the landmark name.

Returns:

the name of the landmark

See Also:

setName(String)

getDescription

public String getDescription()

Returns the landmark description.

Returns:

the description of the landmark, null if not available

See Also:

setDescription(String)

getQualifiedCoordinates

public QualifiedCoordinates getQualifiedCoordinates()

Returns the QualifiedCoordinates of the landmark.

Returns:

the QualifiedCoordinates of the landmark. null if not available.

See Also:

setQualifiedCoordinates(QualifiedCoordinates)

getAddressInfo

public AddressInfo getAddressInfo()

Returns the AddressInfo of the landmark.

Returns:

the AddressInfo of the landmark

See Also:

setAddressInfo(AddressInfo)

setName

public void setName(String name)

Sets the name of the landmark.

Parameters:

name - name for the landmark

Throws:

NullPointerException - if the parameter is null

See Also:

getName()

setDescription

public void setDescription(String description)

Sets the description of the landmark.

Parameters:

description - description for the landmark, null may be passed in to indicate that description is not available.

See Also:

getDescription()

setQualifiedCoordinates

public void setQualifiedCoordinates(QualifiedCoordinates coordinates)

Sets the QualifiedCoordinates of the landmark.

Parameters:

coordinates - the qualified coordinates of the landmark

See Also:

getQualifiedCoordinates()

setAddressInfo

public void setAddressInfo(AddressInfo addressInfo)

Sets the AddressInfo of the landmark.

Parameters:

addressInfo - the AddressInfo of the landmark

See Also:

getAddressInfo()