Geo (anoa-tests 3.1.2 API)

All Superinterfaces:

Comparable<Geo<?>>, Serializable, Supplier<T>

All Known Implementing Classes:

Geo.Avro, Geo.NativeImpl, Geo.Protobuf, Geo.Thrift
```
public interface Geo<T>
extends Supplier<T>, Comparable<Geo<?>>, Serializable
```
3.3.11 Geo Object The geo object itself and all of its parameters are optional, so default values are not provided. If an optional parameter is not specified, it should be considered unknown. Note that the Geo Object may appear in one or both the Device Object and the User Object. This is intentional, since the information may be derived from either a device-oriented source (such as IP geo lookup), or by user registration information (for example provided to a publisher through a user registration). If the information is in conflict, it’s up to the bidder to determine which information to use.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Geo.Avro`
`static class`	`Geo.AvroBuilder`
`static interface`	`Geo.Builder<T>`
`static class`	`Geo.Comparator`
`static class`	`Geo.NativeImpl`
`static class`	`Geo.Protobuf`
`static class`	`Geo.ProtobufBuilder`
`static class`	`Geo.Thrift`
`static class`	`Geo.ThriftBuilder`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Geo.Avro`	`avro(Geo<?> instance)` Returns a wrapped Avro record based on an instance of Geo.
`static Geo.Avro`	`avro(GeoAvro wrapped)` Wraps an existing Avro record.
`default int`	`compareTo(Geo<?> other)`
`T`	`get()` Returns underlying object.
`static Class<GeoAvro>`	`getAvroClass()` Returns Avro record class.
`static Schema`	`getAvroSchema()` Returns Avro record schema.
`String`	`getCity()` City using United Nations Code for Trade and Transport Locations (http://www.unece.org/cefact/locode/ser vice/location.htm).
`static Comparator<Geo<?>>`	`getComparator()` Returns comparator instance for Geo objects.
`String`	`getCountry()` Country using ISO-3166-1 Alpha-3.
`float`	`getLat()` Latitude from -90 to 90.
`float`	`getLon()` Longitude from -180 to 180.
`String`	`getMetro()` Pass the metro code (seehttp://code.google.com/apis/adwords/docs/appendix/metrocodes.html).
`static Class<OpenRtbProtobuf.Geo>`	`getProtobufClass()` Returns Protobuf class for this struct.
`static com.google.protobuf.Descriptors.Descriptor`	`getProtobufDescriptor()` Returns Protobuf descriptor for this struct.
`static Class<AdExchangeProtobuf>`	`getProtobufProtocolClass()` Returns Protobuf protocol class for this struct.
`static com.google.protobuf.Descriptors.FileDescriptor`	`getProtobufProtocolDescriptor()` Returns Protobuf protocol descriptor for this struct.
`String`	`getRegion()` Region using ISO 3166-2.
`String`	`getRegionfips104()` Region of a country using FIPS 10-4 notation (alternative to ISO 3166-2).
`static Class<GeoThrift>`	`getThriftClass()` Returns Thrift class for this struct.
`static Map<GeoThrift._Fields,FieldMetaData>`	`getThriftMetadataMap()` Returns Thrift metadata map for this struct.
`int`	`getType()` Indicate the source of the geo data (GPS, IP address, user provided).
`String`	`getZip()` Zip/postal code.
`default boolean`	`isDefault()` True if all fields are set to default values.
`boolean`	`isDefaultCity()`
`boolean`	`isDefaultCountry()`
`boolean`	`isDefaultLat()`
`boolean`	`isDefaultLon()`
`boolean`	`isDefaultMetro()`
`boolean`	`isDefaultRegion()`
`boolean`	`isDefaultRegionfips104()`
`boolean`	`isDefaultType()`
`boolean`	`isDefaultZip()`
`static Geo.NativeImpl`	`nativeImpl(Geo<?> instance)` Returns a POJO based on an instance of Geo.
`static Geo.Builder<GeoAvro>`	`newAvroBuilder()` Returns new Avro builder instance with default values.
`static Geo.Builder<GeoAvro>`	`newAvroBuilder(Geo<?> other)` Returns new Avro builder instance based on existing prototype Geo.
`static Geo.Builder<GeoAvro>`	`newAvroBuilder(GeoAvro.Builder other)` Returns new Avro builder instance based on existing prototype builder.
`static Geo.Builder<GeoAvro>`	`newAvroBuilder(GeoAvro other)` Returns new Avro builder instance based on existing prototype.
`Geo.Builder<T>`	`newBuilder()` Creates a new builder based on this object.
`static Geo.Builder<Geo.NativeImpl>`	`newNativeImplBuilder()` Returns a POJO builder instance with default values.
`static Geo.Builder<Geo.NativeImpl>`	`newNativeImplBuilder(Geo<?> other)` Returns a POJO builder instance based on existing prototype Geo.
`static Geo.Builder<OpenRtbProtobuf.Geo>`	`newProtobufBuilder()` Returns new Protobuf builder instance with default values.
`static Geo.Builder<OpenRtbProtobuf.Geo>`	`newProtobufBuilder(Geo<?> other)` Returns new Protobuf builder instance based on existing prototype Geo.
`static Geo.Builder<OpenRtbProtobuf.Geo>`	`newProtobufBuilder(OpenRtbProtobuf.Geo other)` Returns new Protobuf builder instance based on existing prototype.
`static Geo.Builder<GeoThrift>`	`newThriftBuilder()` Returns new Thrift builder instance with default values.
`static Geo.Builder<GeoThrift>`	`newThriftBuilder(Geo<?> other)` Returns new Thrift builder instance based on existing prototype Geo.
`static Geo.Builder<GeoThrift>`	`newThriftBuilder(GeoThrift other)` Returns new Thrift builder instance based on existing prototype.
`static Geo.Protobuf`	`protobuf(Geo<?> instance)` Returns a wrapped Protobuf message based on an instance of Geo.
`static Geo.Protobuf`	`protobuf(OpenRtbProtobuf.Geo wrapped)` Wraps an existing Protobuf message.
`static Geo.Thrift`	`thrift(Geo<?> instance)` Returns a wrapped Thrift struct based on an instance of Geo.
`static Geo.Thrift`	`thrift(GeoThrift instance)` Creates a new wrapped Thrift struct copied from an existing instance.

- Method Detail
  - isDefault
```
default boolean isDefault()
```
    True if all fields are set to default values.
  - get
```
T get()
```
    Returns underlying object.
    
    Specified by:
    
    get in interface Supplier<T>
  - newBuilder
```
Geo.Builder<T> newBuilder()
```
    Creates a new builder based on this object.
  - getLat
```
float getLat()
```
    Latitude from -90 to 90. South is negative. This should only be passed if known to be accurate (For example, not the centroid of a postal code).
  - isDefaultLat
```
boolean isDefaultLat()
```
  - getLon
```
float getLon()
```
    Longitude from -180 to 180. West is negative. This should only be passed if known to be accurate.
  - isDefaultLon
```
boolean isDefaultLon()
```
  - getCountry
```
String getCountry()
```
    Country using ISO-3166-1 Alpha-3.
  - isDefaultCountry
```
boolean isDefaultCountry()
```
  - getRegion
```
String getRegion()
```
    Region using ISO 3166-2.
  - isDefaultRegion
```
boolean isDefaultRegion()
```
  - getRegionfips104
```
String getRegionfips104()
```
    Region of a country using FIPS 10-4 notation (alternative to ISO 3166-2).
  - isDefaultRegionfips104
```
boolean isDefaultRegionfips104()
```
  - getMetro
```
String getMetro()
```
    Pass the metro code (seehttp://code.google.com/apis/adwords/docs/appendix/metrocodes.html). Metro codes are similar to but not exactly the same as Nielsen DMAs.
  - isDefaultMetro
```
boolean isDefaultMetro()
```
  - getCity
```
String getCity()
```
    City using United Nations Code for Trade and Transport Locations (http://www.unece.org/cefact/locode/ser vice/location.htm).
  - isDefaultCity
```
boolean isDefaultCity()
```
  - getZip
```
String getZip()
```
    Zip/postal code.
  - isDefaultZip
```
boolean isDefaultZip()
```
  - getType
```
int getType()
```
    Indicate the source of the geo data (GPS, IP address, user provided). See Table 6.15 Location Type for a list of potential values. Type should be provided when lat/lon is provided.
  - isDefaultType
```
boolean isDefaultType()
```
  - getComparator
```
static Comparator<Geo<?>> getComparator()
```
    Returns comparator instance for Geo objects.
  - compareTo
```
default int compareTo(Geo<?> other)
```
    Specified by:
    
    compareTo in interface Comparable<Geo<?>>
  - newNativeImplBuilder
```
static Geo.Builder<Geo.NativeImpl> newNativeImplBuilder()
```
    Returns a POJO builder instance with default values.
  - newNativeImplBuilder
```
static Geo.Builder<Geo.NativeImpl> newNativeImplBuilder(Geo<?> other)
```
    Returns a POJO builder instance based on existing prototype Geo.
  - nativeImpl
```
static Geo.NativeImpl nativeImpl(Geo<?> instance)
```
    Returns a POJO based on an instance of Geo.
  - newAvroBuilder
```
static Geo.Builder<GeoAvro> newAvroBuilder()
```
    Returns new Avro builder instance with default values.
  - newAvroBuilder
```
static Geo.Builder<GeoAvro> newAvroBuilder(GeoAvro other)
```
    Returns new Avro builder instance based on existing prototype.
  - newAvroBuilder
```
static Geo.Builder<GeoAvro> newAvroBuilder(GeoAvro.Builder other)
```
    Returns new Avro builder instance based on existing prototype builder.
  - newAvroBuilder
```
static Geo.Builder<GeoAvro> newAvroBuilder(Geo<?> other)
```
    Returns new Avro builder instance based on existing prototype Geo.
  - avro
```
static Geo.Avro avro(Geo<?> instance)
```
    Returns a wrapped Avro record based on an instance of Geo.
  - avro
```
static Geo.Avro avro(GeoAvro wrapped)
```
    Wraps an existing Avro record.
  - getAvroClass
```
static Class<GeoAvro> getAvroClass()
```
    Returns Avro record class.
  - getAvroSchema
```
static Schema getAvroSchema()
```
    Returns Avro record schema.
  - newProtobufBuilder
```
static Geo.Builder<OpenRtbProtobuf.Geo> newProtobufBuilder()
```
    Returns new Protobuf builder instance with default values.
  - newProtobufBuilder
```
static Geo.Builder<OpenRtbProtobuf.Geo> newProtobufBuilder(OpenRtbProtobuf.Geo other)
```
    Returns new Protobuf builder instance based on existing prototype.
  - newProtobufBuilder
```
static Geo.Builder<OpenRtbProtobuf.Geo> newProtobufBuilder(Geo<?> other)
```
    Returns new Protobuf builder instance based on existing prototype Geo.
  - protobuf
```
static Geo.Protobuf protobuf(Geo<?> instance)
```
    Returns a wrapped Protobuf message based on an instance of Geo.
  - protobuf
```
static Geo.Protobuf protobuf(OpenRtbProtobuf.Geo wrapped)
```
    Wraps an existing Protobuf message.
  - getProtobufClass
```
static Class<OpenRtbProtobuf.Geo> getProtobufClass()
```
    Returns Protobuf class for this struct.
  - getProtobufProtocolClass
```
static Class<AdExchangeProtobuf> getProtobufProtocolClass()
```
    Returns Protobuf protocol class for this struct.
  - getProtobufDescriptor
```
static com.google.protobuf.Descriptors.Descriptor getProtobufDescriptor()
```
    Returns Protobuf descriptor for this struct.
  - getProtobufProtocolDescriptor
```
static com.google.protobuf.Descriptors.FileDescriptor getProtobufProtocolDescriptor()
```
    Returns Protobuf protocol descriptor for this struct.
  - newThriftBuilder
```
static Geo.Builder<GeoThrift> newThriftBuilder()
```
    Returns new Thrift builder instance with default values.
  - newThriftBuilder
```
static Geo.Builder<GeoThrift> newThriftBuilder(GeoThrift other)
```
    Returns new Thrift builder instance based on existing prototype.
  - newThriftBuilder
```
static Geo.Builder<GeoThrift> newThriftBuilder(Geo<?> other)
```
    Returns new Thrift builder instance based on existing prototype Geo.
  - thrift
```
static Geo.Thrift thrift(Geo<?> instance)
```
    Returns a wrapped Thrift struct based on an instance of Geo.
  - thrift
```
static Geo.Thrift thrift(GeoThrift instance)
```
    Creates a new wrapped Thrift struct copied from an existing instance.
  - getThriftClass
```
static Class<GeoThrift> getThriftClass()
```
    Returns Thrift class for this struct.
  - getThriftMetadataMap
```
static Map<GeoThrift._Fields,FieldMetaData> getThriftMetadataMap()
```
    Returns Thrift metadata map for this struct.

Interface Geo<T>

Nested Class Summary

Method Summary

Method Detail

isDefault

get

newBuilder

getLat

isDefaultLat

getLon

isDefaultLon

getCountry

isDefaultCountry

getRegion

isDefaultRegion

getRegionfips104

isDefaultRegionfips104

getMetro

isDefaultMetro

getCity

isDefaultCity

getZip

isDefaultZip

getType

isDefaultType

getComparator

compareTo

newNativeImplBuilder

newNativeImplBuilder

nativeImpl

newAvroBuilder

newAvroBuilder

newAvroBuilder

newAvroBuilder

avro

avro

getAvroClass

getAvroSchema

newProtobufBuilder

newProtobufBuilder

newProtobufBuilder

protobuf

protobuf

getProtobufClass

getProtobufProtocolClass

getProtobufDescriptor

getProtobufProtocolDescriptor

newThriftBuilder

newThriftBuilder

newThriftBuilder

thrift

thrift

getThriftClass

getThriftMetadataMap