com.tomtom.online.sdk.search.data.autocomplete.response

Class Segment

java.lang.Object

com.tomtom.online.sdk.search.data.autocomplete.response.Segment

All Implemented Interfaces:

java.io.Serializable

public class Segment
extends java.lang.Object
implements java.io.Serializable

Describes recognized entitiy of the Autocomplete Search result.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	id Provided for the category segment type.
protected java.lang.String	matchedAlternativeName Optionally provided for the category segment type.
protected Matches	matches Defines a mapping between the inputQuery and segment.
protected SegmentType	type The type of a detected entity.
protected java.lang.String	value The value of the detected entity.

Constructor Summary

Constructors

Constructor and Description
Segment()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

type

protected SegmentType type

The type of a detected entity. Currently we can detect: category, brand, plaintext, but more types can appear in the future. -- GETTER --

value

protected java.lang.String value

The value of the detected entity. It may be a category name, brand name, or a part of unrecognized text. For the brand segment type, the value of this field can be used to restrict results of other search endpoints to the Points Of Interest (POI) of specific brands. See the brandSet parameter in the Search service documentation, e.g., the Fuzzy Search endpoint. -- GETTER --

matches

protected Matches matches

Defines a mapping between the inputQuery and segment. -- GETTER --

id

protected java.lang.String id

Provided for the category segment type. Can be used to restrict the results of other search endpoints to the Points Of Interest (POI) of specific categories. See the categorySet parameter in the Search service documentation, e.g., the Fuzzy Search endpoint. -- GETTER --

matchedAlternativeName

protected java.lang.String matchedAlternativeName

Optionally provided for the category segment type. Present only if a part of the user query matched to the alternative name instead of a primary name. For example, for the input query "petrol station" the category segment value will be "gas station" and the matchedAlternativeName will be "petrol station". -- GETTER --

Constructor Detail

Segment

public Segment()