com.adobe.cq.address.api.location

Class Location

java.lang.Object

org.apache.sling.api.adapter.SlingAdaptable

com.adobe.cq.address.api.location.Location

All Implemented Interfaces:

Adaptable

public final class Location
extends SlingAdaptable

Represents a location. Use LocationManager to access location objects.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HOURS
static String	LATITUDE
static String	LONGITUDE
static String	PHONE

Constructor Summary

Constructors

Constructor and Description
Location(Resource resource) Creates a location object.

Method Summary

Methods

Modifier and Type	Method and Description
<AdapterType> AdapterType	adaptTo(Class<AdapterType> type) Calls into the registered AdapterManager to adapt this object to the desired type.
boolean	equals(Object obj)
Coordinates	getCoordinates() Returns coordinates for this location if latitude and longitude are both available.
String	getDescription() Return the description of this location as entered by the user.
String	getFullAddress() The full string representation of a location using the default set of fields * @return full address string
String	getFullAddress(String[] fields) The full string representation of a location using the provided array of property names.
String[]	getHours() Returns the location hours, or null, if no hours property exists.
String	getPath() Returns the location path in the repository.
String	getPhone() Returns the location phone number.
String	getTitle() Returns the title of this location as entered by the user.
int	hashCode()
void	setCoordinates(Coordinates coord) Sets the location coordinate properties.
void	setHours(String[] hours) Sets the location hours.
void	setPhone(String phone) Sets the location phone number.

Methods inherited from class org.apache.sling.api.adapter.SlingAdaptable

setAdapterManager, unsetAdapterManager

Methods inherited from class java.lang.Object

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

Field Detail

LATITUDE

public static final String LATITUDE

See Also:

Constant Field Values

LONGITUDE

public static final String LONGITUDE

See Also:

Constant Field Values

PHONE

public static final String PHONE

See Also:

Constant Field Values

HOURS

public static final String HOURS

See Also:

Constant Field Values

Constructor Detail

Location

public Location(Resource resource)

Creates a location object.

Parameters:

resource - The resource representing a location.

Throws:

IllegalArgumentException - when Resource is null

Method Detail

getPath

public String getPath()

Returns the location path in the repository.

Returns:

The address path.

getTitle

public String getTitle()

Returns the title of this location as entered by the user.

Returns:

The location title or null if not defined.

getDescription

public String getDescription()

Return the description of this location as entered by the user.

Returns:

The description of this location or null if not defined.

setCoordinates

public void setCoordinates(Coordinates coord)
                    throws AddressException

Sets the location coordinate properties.

Parameters:

coord - The new location properties.

Throws:

AddressException - if persisting the coordinates fails.

getCoordinates

public Coordinates getCoordinates()

Returns coordinates for this location if latitude and longitude are both available.

Returns:

The location coordinates or null if not defined

getPhone

public String getPhone()

Returns the location phone number.

setPhone

public void setPhone(String phone)
              throws AddressException

Sets the location phone number.

Throws:

AddressException

getHours

public String[] getHours()

Returns the location hours, or null, if no hours property exists.

setHours

public void setHours(String[] hours)
              throws AddressException

Sets the location hours.

Throws:

AddressException

getFullAddress

public String getFullAddress()

The full string representation of a location using the default set of fields * @return full address string

getFullAddress

public String getFullAddress(String[] fields)

The full string representation of a location using the provided array of property names.

Parameters:

fields - Property names to use

Returns:

full address string

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

adaptTo

public <AdapterType> AdapterType adaptTo(Class<AdapterType> type)

Description copied from class: SlingAdaptable

Calls into the registered AdapterManager to adapt this object to the desired type.

This method implements a cache of adapters to improve performance. That is repeated calls to this method with the same class will result in the same object to be returned.

Specified by:

adaptTo in interface Adaptable

Overrides:

adaptTo in class SlingAdaptable

Type Parameters:

AdapterType - The generic type to which this resource is adapted to

Parameters:

type - The Class object of the target type, such as javax.jcr.Node.class or java.io.File.class

Returns:

The adapter target or null if the resource cannot adapt to the requested type