de.alpharogroup.address.book.rest.api

Interface AddressesResource

All Superinterfaces:

de.alpharogroup.service.rs.RestfulResource<Integer,de.alpharogroup.address.book.domain.Address>

All Known Implementing Classes:

AddressesRestResource

@Path(value="/address/")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public interface AddressesResource
extends de.alpharogroup.service.rs.RestfulResource<Integer,de.alpharogroup.address.book.domain.Address>

The interface AddressesResource provides methods for resolving addresses.

Method Summary

Modifier and Type	Method and Description
de.alpharogroup.address.book.domain.Address	contains(String latitude, String longitude) Checks if the given latitude and longitude is contained in the database.
de.alpharogroup.address.book.domain.Address	contains(de.alpharogroup.address.book.domain.Zipcode zipcode) Checks if the given Zipcode is contained in the database and return the first occurence.
List<de.alpharogroup.address.book.domain.Address>	find(AddressSearchCriteria addressSearchCriteria) Finds a list of Address from the given arguments.
List<de.alpharogroup.address.book.domain.Address>	find(String geohash) Finds a list of Address from the given geohash.
List<de.alpharogroup.address.book.domain.Address>	find(String latitude, String longitude) Finds a list of Address from the given latitude and longitude.
List<de.alpharogroup.address.book.domain.Address>	find(de.alpharogroup.address.book.domain.Zipcode zipcode) Finds a list of Address from the given Zipcode object.
List<de.alpharogroup.address.book.domain.Address>	findAll(de.alpharogroup.address.book.domain.Country country) Find all Address with the given country.
List<de.alpharogroup.address.book.domain.Zipcode>	findAllAddressesWithCountry(de.alpharogroup.address.book.domain.Country country) Find all Zipcode with the given country.
de.alpharogroup.address.book.domain.Address	findFirst(AddressSearchCriteria addressSearchCriteria) Finds the first Address from the given arguments.
List<de.alpharogroup.address.book.domain.Address>	findFirstAndSecondRingNeighbourhood(String geohash) Finds a list of Address from the first and second ring neighbourhood areas of the given geohash.
List<de.alpharogroup.address.book.domain.Address>	findFirstRingNeighbourhood(String geohash) Finds a list of Address from the first ring neighbourhood areas of the given geohash.
List<de.alpharogroup.address.book.domain.Address>	findGeohashIsNull() Find all addresses that have a geohash value that is null.
List<de.alpharogroup.address.book.domain.Address>	findNeighbourhood(String geohash) Finds a list of Address from the neighbourhood areas of the given geohash.

Methods inherited from interface de.alpharogroup.service.rs.RestfulResource

create, delete, read, update

Method Detail

contains

@GET
 @Path(value="/contains/{latitude}/{longitude}")
de.alpharogroup.address.book.domain.Address contains(@PathParam(value="latitude")
                                                                                                           String latitude,
                                                                                                           @PathParam(value="longitude")
                                                                                                           String longitude)

Checks if the given latitude and longitude is contained in the database.

Parameters:

latitude - the latitude

longitude - the longitude

Returns:

the Address

contains

@POST
 @Path(value="/contains/zipcode")
de.alpharogroup.address.book.domain.Address contains(de.alpharogroup.address.book.domain.Zipcode zipcode)

Checks if the given Zipcode is contained in the database and return the first occurence.

Parameters:

zipcode - the zipcode

Returns:

the Address

find

@POST
 @Path(value="/find/addresses")
List<de.alpharogroup.address.book.domain.Address> find(AddressSearchCriteria addressSearchCriteria)

Finds a list of Address from the given arguments.

Parameters:

addressSearchCriteria - the address search criteria

Returns:

the list of Address

find

@GET
 @Path(value="/geohash/{geohash}/")
List<de.alpharogroup.address.book.domain.Address> find(@PathParam(value="geohash")
                                                                                                String geohash)

Finds a list of Address from the given geohash.

Parameters:

geohash - the geohash

Returns:

the list of Address

find

@GET
 @Path(value="/find/{latitude}/{longitude}")
List<de.alpharogroup.address.book.domain.Address> find(@PathParam(value="latitude")
                                                                                                         String latitude,
                                                                                                         @PathParam(value="longitude")
                                                                                                         String longitude)

Finds a list of Address from the given latitude and longitude.

Parameters:

latitude - the latitude

longitude - the longitude

Returns:

the list of Address

find

@POST
 @Path(value="/find/zipcodes")
List<de.alpharogroup.address.book.domain.Address> find(de.alpharogroup.address.book.domain.Zipcode zipcode)

Finds a list of Address from the given Zipcode object.

Parameters:

zipcode - the zipcode

Returns:

the list of Address

findAll

@POST
 @Path(value="/find/addresses/by/country")
List<de.alpharogroup.address.book.domain.Address> findAll(de.alpharogroup.address.book.domain.Country country)

Find all Address with the given country.

Parameters:

country - the country

Returns:

the list

findAllAddressesWithCountry

@POST
 @Path(value="/find/zipcodes/by/country")
List<de.alpharogroup.address.book.domain.Zipcode> findAllAddressesWithCountry(de.alpharogroup.address.book.domain.Country country)

Find all Zipcode with the given country.

Parameters:

country - the county

Returns:

the list of Zipcode

findFirst

@POST
 @Path(value="/find/first/by/country/and/zipcode")
de.alpharogroup.address.book.domain.Address findFirst(AddressSearchCriteria addressSearchCriteria)

Finds the first Address from the given arguments.

Parameters:

addressSearchCriteria - the address search criteria

Returns:

the Address

findFirstAndSecondRingNeighbourhood

@GET
 @Path(value="/geohash/first/and/second/ring/{geohash}/")
List<de.alpharogroup.address.book.domain.Address> findFirstAndSecondRingNeighbourhood(@PathParam(value="geohash")
                                                                                                                                                     String geohash)

Finds a list of Address from the first and second ring neighbourhood areas of the given geohash.

Parameters:

geohash - the geohash

Returns:

the list of Address

findFirstRingNeighbourhood

@GET
 @Path(value="/geohash/first/ring/{geohash}/")
List<de.alpharogroup.address.book.domain.Address> findFirstRingNeighbourhood(@PathParam(value="geohash")
                                                                                                                                 String geohash)

Finds a list of Address from the first ring neighbourhood areas of the given geohash.

Parameters:

geohash - the geohash

Returns:

the list of Address

findGeohashIsNull

@POST
 @Path(value="/find/addresses/if/geohash/null")
List<de.alpharogroup.address.book.domain.Address> findGeohashIsNull()

Find all addresses that have a geohash value that is null.

Returns:

the list of Address

findNeighbourhood

@GET
 @Path(value="/geohash/neighbourhood/{geohash}/")
List<de.alpharogroup.address.book.domain.Address> findNeighbourhood(@PathParam(value="geohash")
                                                                                                                           String geohash)

Finds a list of Address from the neighbourhood areas of the given geohash.

Parameters:

geohash - the geohash

Returns:

the list of Address