com.brein.api

Class BreinTemporalData

java.lang.Object

com.brein.api.BreinBase<BreinTemporalData>

com.brein.api.BreinTemporalData

All Implemented Interfaces:

IExecutable<BreinTemporalDataResult>, ISecretStrategy

public class BreinTemporalData
extends BreinBase<BreinTemporalData>
implements IExecutable<BreinTemporalDataResult>

Provides the lookup functionality

Nested Class Summary

Nested classes/interfaces inherited from class com.brein.api.BreinBase

BreinBase.BaseField

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CITY_TEXT_FIELD
static java.lang.String	COUNTRY_TEXT_FIELD
static java.lang.String	IP_ADDRESS_FIELD
static java.time.format.DateTimeFormatter	JAVA_SCRIPT_FORMAT
static java.lang.String	LATITUDE_FIELD
static java.lang.String	LOCAL_DATE_TIME_FIELD
static java.lang.String	LOCATION_FIELD
static java.lang.String	LONGITUDE_FIELD
static java.lang.String	SHAPE_TYPES_FIELD
static java.lang.String	STATE_TEXT_FIELD
static java.lang.String	TEXT_FIELD
static java.lang.String	TIMEZONE_FIELD

Fields inherited from class com.brein.api.BreinBase

API_KEY_FIELD, GSON, SIGNATURE_FIELD, SIGNATURE_TYPE_FIELD, UNIX_TIMESTAMP_FIELD

Constructor Summary

Constructors

Constructor and Description
BreinTemporalData()

Method Summary

Modifier and Type	Method and Description
BreinTemporalData	addShapeTypes(java.lang.String... shapeTypes)
java.lang.String	createSignature(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) Creates the signature for temporaldata
BreinTemporalDataResult	execute()
java.lang.String	getEndPoint(BreinConfig config) retrieves the endpoint.
<T> T	getLocation(java.lang.String key)
void	prepareRequestData(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) prepares the request for the base section with standard fields plus possible fields if configured
BreinTemporalData	setLatitude(double latitude)
BreinTemporalData	setLocalDateTime() Sets the current localDateTime based on the system's time.
BreinTemporalData	setLocalDateTime(java.time.ZonedDateTime zonedDateTime)
BreinTemporalData	setLocation(java.lang.String freeText)
BreinTemporalData	setLocation(java.lang.String key, java.lang.Object value)
BreinTemporalData	setLocation(java.lang.String city, java.lang.String state, java.lang.String country)
BreinTemporalData	setLongitude(double longitude)
BreinTemporalData	setLookUpIpAddress(java.lang.String ipAddress)
BreinTemporalData	setShapeTypes(java.lang.String... shapeTypes)
BreinTemporalData	setTimezone(java.lang.String timezone)
BreinTemporalData	setTimezone(java.util.TimeZone timezone)

Methods inherited from class com.brein.api.BreinBase

getBaseField, getGson, getIpAddress, getThis, getUnixTimestamp, getUser, prepareRequestData, set, setAdditional, setClientIpAddress, setUnixTimestamp, setUser, setUser, toString

Methods inherited from class java.lang.Object

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

Field Detail

JAVA_SCRIPT_FORMAT

public static java.time.format.DateTimeFormatter JAVA_SCRIPT_FORMAT

LOCATION_FIELD

public static final java.lang.String LOCATION_FIELD

See Also:

Constant Field Values

LOCAL_DATE_TIME_FIELD

public static final java.lang.String LOCAL_DATE_TIME_FIELD

See Also:

Constant Field Values

TIMEZONE_FIELD

public static final java.lang.String TIMEZONE_FIELD

See Also:

Constant Field Values

IP_ADDRESS_FIELD

public static final java.lang.String IP_ADDRESS_FIELD

See Also:

Constant Field Values

LONGITUDE_FIELD

public static final java.lang.String LONGITUDE_FIELD

See Also:

Constant Field Values

LATITUDE_FIELD

public static final java.lang.String LATITUDE_FIELD

See Also:

Constant Field Values

SHAPE_TYPES_FIELD

public static final java.lang.String SHAPE_TYPES_FIELD

See Also:

Constant Field Values

TEXT_FIELD

public static final java.lang.String TEXT_FIELD

See Also:

Constant Field Values

CITY_TEXT_FIELD

public static final java.lang.String CITY_TEXT_FIELD

See Also:

Constant Field Values

STATE_TEXT_FIELD

public static final java.lang.String STATE_TEXT_FIELD

See Also:

Constant Field Values

COUNTRY_TEXT_FIELD

public static final java.lang.String COUNTRY_TEXT_FIELD

See Also:

Constant Field Values

Constructor Detail

BreinTemporalData

public BreinTemporalData()

Method Detail

getEndPoint

public java.lang.String getEndPoint(BreinConfig config)

Description copied from class: BreinBase

retrieves the endpoint. this depends of the kind of BreinBase type.

Specified by:

getEndPoint in class BreinBase<BreinTemporalData>

Parameters:

config - the current configuration

Returns:

endpoint

prepareRequestData

public void prepareRequestData(BreinConfig config,
                               java.util.Map<java.lang.String,java.lang.Object> requestData)

Description copied from class: BreinBase

prepares the request for the base section with standard fields plus possible fields if configured

Specified by:

prepareRequestData in class BreinBase<BreinTemporalData>

requestData - contains the created json structure

setTimezone

public BreinTemporalData setTimezone(java.util.TimeZone timezone)

setTimezone

public BreinTemporalData setTimezone(java.lang.String timezone)

setLookUpIpAddress

public BreinTemporalData setLookUpIpAddress(java.lang.String ipAddress)

setLongitude

public BreinTemporalData setLongitude(double longitude)

setLatitude

public BreinTemporalData setLatitude(double latitude)

setShapeTypes

public BreinTemporalData setShapeTypes(java.lang.String... shapeTypes)

setLocation

public BreinTemporalData setLocation(java.lang.String freeText)

setLocalDateTime

public BreinTemporalData setLocalDateTime()

Sets the current localDateTime based on the system's time.

Returns:

this

See Also:

ZonedDateTime.now()

setLocalDateTime

public BreinTemporalData setLocalDateTime(java.time.ZonedDateTime zonedDateTime)

setLocation

public BreinTemporalData setLocation(java.lang.String city,
                                     java.lang.String state,
                                     java.lang.String country)

addShapeTypes

public BreinTemporalData addShapeTypes(java.lang.String... shapeTypes)

getLocation

public <T> T getLocation(java.lang.String key)

setLocation

public BreinTemporalData setLocation(java.lang.String key,
                                     java.lang.Object value)

createSignature

public java.lang.String createSignature(BreinConfig config,
                                        java.util.Map<java.lang.String,java.lang.Object> requestData)

Creates the signature for temporaldata

Specified by:

createSignature in interface ISecretStrategy

Parameters:

config - the configuration

requestData - the data used for the request including all the data that will be sent, without the signature

Returns:

signature

execute

public BreinTemporalDataResult execute()

Specified by:

execute in interface IExecutable<BreinTemporalDataResult>