Class StructuredQuery
- Last UpdatedJan 22, 2025
- 2 minute read
Class StructuredQuery
- java.lang.Object
-
- com.here.sdk.search.StructuredQuery
-
public final class StructuredQuery extends java.lang.Object
The options to specify a structured query. Only supported in
OfflineSearchEngine
(not available for all editions).Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
StructuredQuery.AddressElements
Defines query address elements which will be used to build address hierarchy during searches.static class
StructuredQuery.ResultType
Specifies expected result type.
-
Field Summary
Fields Modifier and Type Field Description StructuredQuery.AddressElements
addressElements
Query address elements to get the results from a specific geographical area.GeoCoordinates
areaCenter
Geographic coordinates of the prioritized area center.java.lang.String
query
Desired query to search.StructuredQuery.ResultType
resultType
An optional field to indicates the type of result expected.
-
Constructor Summary
Constructors Constructor Description StructuredQuery(java.lang.String query, GeoCoordinates areaCenter)
Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
int
hashCode()
-
-
-
Field Detail
-
query
@NonNull public java.lang.String query
Desired query to search.
-
areaCenter
@NonNull public GeoCoordinates areaCenter
Geographic coordinates of the prioritized area center.
-
addressElements
@NonNull public StructuredQuery.AddressElements addressElements
Query address elements to get the results from a specific geographical area.
-
resultType
@Nullable public StructuredQuery.ResultType resultType
An optional field to indicates the type of result expected.
-
-
Constructor Detail
-
StructuredQuery
public StructuredQuery(@NonNull java.lang.String query, @NonNull GeoCoordinates areaCenter)
Creates a new instance.
- Parameters:
query
-Desired query to search.
areaCenter
-Geographic coordinates of the prioritized area center.
-
-