com.textkernel.tx.models.api.geocoding.GeocodeOptionsBase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tx-java Show documentation

The official Java SDK for the Textkernel Tx v10 API.

The newest version!

// Copyright © 2023 Textkernel BV. All rights reserved.
// This file is provided for use by, or on behalf of, Textkernel licensees
// within the terms of their license of Textkernel products or Textkernel customers
// within the Terms of Service pertaining to the Textkernel SaaS products.

package com.textkernel.tx.models.api.geocoding;

import com.textkernel.tx.models.GeoCoordinates;

/**
* Options for geocoding a document (specifying some location on Earth)
*/
public class GeocodeOptionsBase extends GeocodeCredentials {
    
    /**
     * The address you wish to geocode. This field is optional. 
     * If you specify this value,
     * this address will be used to get the geocode coordinates instead of the address included
     * in the parsed document (if present); however, the address in the parsed document will not be modified.
    */
    public Address PostalAddress;
    
    /**
     * The geographic coordinates (latitude/longitude) for your postal address. 
     * Use this if you already 
     * have latitude/longitude coordinates and simply wish to add them to your parsed document. If provided, 
     * these values will be inserted into your parsed document and the address included in the 
     * parsed document (if present), will not be modified.
    */
    public GeoCoordinates GeoCoordinates;
}