/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.geo.model; import java.io.Serializable; /** *

* Contains a search result from a text search query that is run on a place * index resource. *

*/ public class SearchForTextResult implements Serializable { /** *

* The distance in meters of a great-circle arc between the bias position * specified and the result. Distance will be returned only if * a bias position was specified in the query. *

* *

* A great-circle arc is the shortest path on a sphere, in this case the * Earth. This returns the shortest distance between two locations. *

* *

* Constraints:
* Range: 0.0 -
*/ private Double distance; /** *

* Details about the search result, such as its address and position. *

*/ private Place place; /** *

* The unique identifier of the place. You can use this with the * GetPlace operation to find the place again later. *

* *

* For SearchPlaceIndexForText operations, the * PlaceId is returned only by place indexes that use HERE or * Grab as a data provider. *

* */ private String placeId; /** *

* The relative confidence in the match for a result among the results * returned. For example, if more fields for an address match (including * house number, street, city, country/region, and postal code), the * relevance score is closer to 1. *

*

* Returned only when the partner selected is Esri or Grab. *

*

* Constraints:
* Range: 0.0 - 1.0
*/ private Double relevance; /** *

* The distance in meters of a great-circle arc between the bias position * specified and the result. Distance will be returned only if * a bias position was specified in the query. *

* *

* A great-circle arc is the shortest path on a sphere, in this case the * Earth. This returns the shortest distance between two locations. *

* *

* Constraints:
* Range: 0.0 -
* * @return

* The distance in meters of a great-circle arc between the bias * position specified and the result. Distance will be * returned only if a bias position was specified in the query. *

* *

* A great-circle arc is the shortest path on a sphere, in this case * the Earth. This returns the shortest distance between two * locations. *

* */ public Double getDistance() { return distance; } /** *

* The distance in meters of a great-circle arc between the bias position * specified and the result. Distance will be returned only if * a bias position was specified in the query. *

* *

* A great-circle arc is the shortest path on a sphere, in this case the * Earth. This returns the shortest distance between two locations. *

* *

* Constraints:
* Range: 0.0 -
* * @param distance

* The distance in meters of a great-circle arc between the bias * position specified and the result. Distance will * be returned only if a bias position was specified in the * query. *

* *

* A great-circle arc is the shortest path on a sphere, in this * case the Earth. This returns the shortest distance between two * locations. *

* */ public void setDistance(Double distance) { this.distance = distance; } /** *

* The distance in meters of a great-circle arc between the bias position * specified and the result. Distance will be returned only if * a bias position was specified in the query. *

* *

* A great-circle arc is the shortest path on a sphere, in this case the * Earth. This returns the shortest distance between two locations. *

* *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 0.0 -
* * @param distance

* The distance in meters of a great-circle arc between the bias * position specified and the result. Distance will * be returned only if a bias position was specified in the * query. *

* *

* A great-circle arc is the shortest path on a sphere, in this * case the Earth. This returns the shortest distance between two * locations. *

* * @return A reference to this updated object so that method calls can be * chained together. */ public SearchForTextResult withDistance(Double distance) { this.distance = distance; return this; } /** *

* Details about the search result, such as its address and position. *

* * @return

* Details about the search result, such as its address and * position. *

*/ public Place getPlace() { return place; } /** *

* Details about the search result, such as its address and position. *

* * @param place

* Details about the search result, such as its address and * position. *

*/ public void setPlace(Place place) { this.place = place; } /** *

* Details about the search result, such as its address and position. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param place

* Details about the search result, such as its address and * position. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchForTextResult withPlace(Place place) { this.place = place; return this; } /** *

* The unique identifier of the place. You can use this with the * GetPlace operation to find the place again later. *

* *

* For SearchPlaceIndexForText operations, the * PlaceId is returned only by place indexes that use HERE or * Grab as a data provider. *

* * * @return

* The unique identifier of the place. You can use this with the * GetPlace operation to find the place again later. *

* *

* For SearchPlaceIndexForText operations, the * PlaceId is returned only by place indexes that use * HERE or Grab as a data provider. *

* */ public String getPlaceId() { return placeId; } /** *

* The unique identifier of the place. You can use this with the * GetPlace operation to find the place again later. *

* *

* For SearchPlaceIndexForText operations, the * PlaceId is returned only by place indexes that use HERE or * Grab as a data provider. *

* * * @param placeId

* The unique identifier of the place. You can use this with the * GetPlace operation to find the place again later. *

* *

* For SearchPlaceIndexForText operations, the * PlaceId is returned only by place indexes that * use HERE or Grab as a data provider. *

* */ public void setPlaceId(String placeId) { this.placeId = placeId; } /** *

* The unique identifier of the place. You can use this with the * GetPlace operation to find the place again later. *

* *

* For SearchPlaceIndexForText operations, the * PlaceId is returned only by place indexes that use HERE or * Grab as a data provider. *

* *

* Returns a reference to this object so that method calls can be chained * together. * * @param placeId

* The unique identifier of the place. You can use this with the * GetPlace operation to find the place again later. *

* *

* For SearchPlaceIndexForText operations, the * PlaceId is returned only by place indexes that * use HERE or Grab as a data provider. *

* * @return A reference to this updated object so that method calls can be * chained together. */ public SearchForTextResult withPlaceId(String placeId) { this.placeId = placeId; return this; } /** *

* The relative confidence in the match for a result among the results * returned. For example, if more fields for an address match (including * house number, street, city, country/region, and postal code), the * relevance score is closer to 1. *

*

* Returned only when the partner selected is Esri or Grab. *

*

* Constraints:
* Range: 0.0 - 1.0
* * @return

* The relative confidence in the match for a result among the * results returned. For example, if more fields for an address * match (including house number, street, city, country/region, and * postal code), the relevance score is closer to 1. *

*

* Returned only when the partner selected is Esri or Grab. *

*/ public Double getRelevance() { return relevance; } /** *

* The relative confidence in the match for a result among the results * returned. For example, if more fields for an address match (including * house number, street, city, country/region, and postal code), the * relevance score is closer to 1. *

*

* Returned only when the partner selected is Esri or Grab. *

*

* Constraints:
* Range: 0.0 - 1.0
* * @param relevance

* The relative confidence in the match for a result among the * results returned. For example, if more fields for an address * match (including house number, street, city, country/region, * and postal code), the relevance score is closer to 1. *

*

* Returned only when the partner selected is Esri or Grab. *

*/ public void setRelevance(Double relevance) { this.relevance = relevance; } /** *

* The relative confidence in the match for a result among the results * returned. For example, if more fields for an address match (including * house number, street, city, country/region, and postal code), the * relevance score is closer to 1. *

*

* Returned only when the partner selected is Esri or Grab. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 0.0 - 1.0
* * @param relevance

* The relative confidence in the match for a result among the * results returned. For example, if more fields for an address * match (including house number, street, city, country/region, * and postal code), the relevance score is closer to 1. *

*

* Returned only when the partner selected is Esri or Grab. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SearchForTextResult withRelevance(Double relevance) { this.relevance = relevance; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getDistance() != null) sb.append("Distance: " + getDistance() + ","); if (getPlace() != null) sb.append("Place: " + getPlace() + ","); if (getPlaceId() != null) sb.append("PlaceId: " + getPlaceId() + ","); if (getRelevance() != null) sb.append("Relevance: " + getRelevance()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDistance() == null) ? 0 : getDistance().hashCode()); hashCode = prime * hashCode + ((getPlace() == null) ? 0 : getPlace().hashCode()); hashCode = prime * hashCode + ((getPlaceId() == null) ? 0 : getPlaceId().hashCode()); hashCode = prime * hashCode + ((getRelevance() == null) ? 0 : getRelevance().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SearchForTextResult == false) return false; SearchForTextResult other = (SearchForTextResult) obj; if (other.getDistance() == null ^ this.getDistance() == null) return false; if (other.getDistance() != null && other.getDistance().equals(this.getDistance()) == false) return false; if (other.getPlace() == null ^ this.getPlace() == null) return false; if (other.getPlace() != null && other.getPlace().equals(this.getPlace()) == false) return false; if (other.getPlaceId() == null ^ this.getPlaceId() == null) return false; if (other.getPlaceId() != null && other.getPlaceId().equals(this.getPlaceId()) == false) return false; if (other.getRelevance() == null ^ this.getRelevance() == null) return false; if (other.getRelevance() != null && other.getRelevance().equals(this.getRelevance()) == false) return false; return true; } }