se.walkercrou.places

Class Prediction

java.lang.Object

se.walkercrou.places.Prediction

public class Prediction
extends Object

Represents a autocomplete prediction based on a query.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Prediction.DescriptionTerm Represents an element within a description.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Prediction()

Method Summary

Modifier and Type	Method and Description
protected Prediction	addTerms(Collection<Prediction.DescriptionTerm> terms)
protected Prediction	addTypes(Collection<String> types) Adds a collection of string "types".
GooglePlaces	getClient() Returns the client for this prediction.
String	getDescription() Returns a description of the prediction in human-readable form.
Place	getPlace(Param... extraParams) Returns the place this prediction is suggesting.
String	getPlaceId() Returns the id of the place this prediction is suggesting.
int	getSubstringLength() Returns the length from the substring offset of the matched string.
int	getSubstringOffset() Returns the offset from the query where the matched string starts.
List<Prediction.DescriptionTerm>	getTerms() Returns the components of the description.
List<String>	getTypes() Returns all of this place's types in an unmodifiable list.
static List<Prediction>	parse(GooglePlaces client, String rawJson) Returns a list of predictions from JSON.
protected Prediction	setClient(GooglePlaces client)
protected Prediction	setDescription(String description)
protected Prediction	setPlaceId(String placeId)
protected Prediction	setSubstringLength(int substrLength)
protected Prediction	setSubstringOffset(int substrOffset)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Prediction

protected Prediction()

Method Detail

parse

public static List<Prediction> parse(GooglePlaces client,
                                     String rawJson)

Returns a list of predictions from JSON.

Parameters:

client - of request

rawJson - to parse

Returns:

list of predictions

getClient

public GooglePlaces getClient()

Returns the client for this prediction.

Returns:

client

setClient

protected Prediction setClient(GooglePlaces client)

getPlace

public Place getPlace(Param... extraParams)

Returns the place this prediction is suggesting.

Parameters:

extraParams - to append to request URL

Returns:

place

addTypes

protected Prediction addTypes(Collection<String> types)

Adds a collection of string "types".

Parameters:

types - to add

Returns:

this

getTypes

public List<String> getTypes()

Returns all of this place's types in an unmodifiable list.

Returns:

types

addTerms

protected Prediction addTerms(Collection<Prediction.DescriptionTerm> terms)

getTerms

public List<Prediction.DescriptionTerm> getTerms()

Returns the components of the description.

Returns:

description components

getPlaceId

public String getPlaceId()

Returns the id of the place this prediction is suggesting.

Returns:

place id

setPlaceId

protected Prediction setPlaceId(String placeId)

getDescription

public String getDescription()

Returns a description of the prediction in human-readable form.

Returns:

description

setDescription

protected Prediction setDescription(String description)

getSubstringOffset

public int getSubstringOffset()

Returns the offset from the query where the matched string starts.

Returns:

offset

setSubstringOffset

protected Prediction setSubstringOffset(int substrOffset)

getSubstringLength

public int getSubstringLength()

Returns the length from the substring offset of the matched string.

Returns:

length of substring

setSubstringLength

protected Prediction setSubstringLength(int substrLength)

toString

public String toString()

Overrides:

toString in class Object