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

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 The following fields are used within the additional
static java.lang.String	LONGITUDE_FIELD The following fields are used within the location
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, IP_ADDRESS, 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) Adds the specified shapeTypes to the currently defined shape-types to be returned with the response of the request, i.e.:
java.lang.String	createSignature(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) Creates the signature for temporaldata
BreinTemporalDataResult	execute() Method to execute the request synchronous.
java.lang.String	getEndPoint(BreinConfig config) Gets the endpoint to be used to send the request to
<T> T	getLocation(java.lang.String key) Gets the current value specified within the location of the request.
void	prepareRequestData(BreinConfig config, java.util.Map<java.lang.String,java.lang.Object> requestData) This method adds the request specific information to the requestData.
BreinTemporalData	setLatitude(double latitude) Sets the latitude used to look-up the temporal information, i.e.:
BreinTemporalData	setLocalDateTime() Sets the localDateTime based on the system's time, i.e.:
BreinTemporalData	setLocalDateTime(java.lang.String timeString) Sets the localDateTime for a Stringified date, which will be parsed server side, i.e.:
BreinTemporalData	setLocalDateTime(java.time.ZonedDateTime zonedDateTime) Sets the localDateTime, i.e.:
BreinTemporalData	setLocation(java.lang.String freeText) Sets the location data using free text, i.e.:
BreinTemporalData	setLocation(java.lang.String key, java.lang.Object value)
BreinTemporalData	setLocation(java.lang.String city, java.lang.String state, java.lang.String country) Sets the location data using structured data (city, state, country), i.e.:
BreinTemporalData	setLongitude(double longitude) Sets the longitude used to look-up the temporal information, i.e.:
BreinTemporalData	setLookUpIpAddress(java.lang.String ipAddress) Sets the ipAddress used to look-up the temporal information, i.e.:
BreinTemporalData	setShapeTypes(java.lang.String... shapeTypes) Sets the shape-types to be returned with the response of the request, i.e.:
BreinTemporalData	setTimezone(java.lang.String timezone) Sets the timezone within the request, i.e.:
BreinTemporalData	setTimezone(java.util.TimeZone timezone) Sets the timezone within the request, i.e.:

Methods inherited from class com.brein.api.BreinBase

getClientIpAddress, getGson, getHeaders, getThis, getUnixTimestamp, getUser, prepareRequestData, set, setAdditional, setClientIpAddress, setHeader, setHeaders, setUnixTimestamp, setUser, 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 final java.time.format.DateTimeFormatter JAVA_SCRIPT_FORMAT

LOCATION_FIELD

public static final java.lang.String LOCATION_FIELD

The following fields are used within the additional

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

The following fields are used within the location

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

Gets the endpoint to be used to send the request to

Specified by:

getEndPoint in class BreinBase<BreinTemporalData>

Parameters:

config - the current configuration

Returns:

the endpoint to be used to send the request to

See Also:

BreinConfig

prepareRequestData

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

Description copied from class: BreinBase

This method adds the request specific information to the requestData. It is called by BreinBase.prepareRequestData(BreinConfig) after the request data of the base information is added.

Specified by:

prepareRequestData in class BreinBase<BreinTemporalData>

requestData - the request data to be sent to the endpoint

setTimezone

public BreinTemporalData setTimezone(java.util.TimeZone timezone)

Sets the timezone within the request, i.e.:

     {
         user: {
              additional: {
                  'timezone': timezone
              }
         }
     }
 

Parameters:

timezone - the value to be set

Returns:

this

setTimezone

public BreinTemporalData setTimezone(java.lang.String timezone)

Sets the timezone within the request, i.e.:

     {
         user: {
              additional: {
                  'timezone': timezone
              }
         }
     }
 

Parameters:

timezone - the value to be set

Returns:

this

setLookUpIpAddress

public BreinTemporalData setLookUpIpAddress(java.lang.String ipAddress)

Sets the ipAddress used to look-up the temporal information, i.e.:

     {
         user: {
              additional: {
                  'ipAddress': ipAddress
              }
         }
     }
 

Parameters:

ipAddress - the value to be set

Returns:

this

setLongitude

public BreinTemporalData setLongitude(double longitude)

Sets the longitude used to look-up the temporal information, i.e.:

     {
         user: {
              additional: {
                  location: {
                      'longitude': longitude
                  }
              }
         }
     }
 

Parameters:

longitude - the longitude to be used

Returns:

this

setLatitude

public BreinTemporalData setLatitude(double latitude)

Sets the latitude used to look-up the temporal information, i.e.:

     {
         user: {
              additional: {
                  location: {
                      'latitude': latitude
                  }
              }
         }
     }
 

Parameters:

latitude - the latitude to be used

Returns:

this

setShapeTypes

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

Sets the shape-types to be returned with the response of the request, i.e.:

     {
         user: {
              additional: {
                  location: {
                      'shapeTypes': [...]
                  }
              }
         }
     }
 

Parameters:

shapeTypes - the shapeTypes to be set, if empty the shapeTypes will be removed

Returns:

this

setLocation

public BreinTemporalData setLocation(java.lang.String freeText)

Sets the location data using free text, i.e.:

     {
         user: {
              additional: {
                  location: {
                      'text': freeText
                  }
              }
         }
     }
 

Parameters:

freeText - the text describing the location

Returns:

this

setLocalDateTime

public BreinTemporalData setLocalDateTime()

Sets the localDateTime based on the system's time, i.e.:

     {
         user: {
              additional: {
                  'localDateTime': now
              }
         }
     }
 

Returns:

this

See Also:

ZonedDateTime.now()

setLocalDateTime

public BreinTemporalData setLocalDateTime(java.time.ZonedDateTime zonedDateTime)

Sets the localDateTime, i.e.:

     {
         user: {
              additional: {
                  'localDateTime': zonedDateTime
              }
         }
     }
 

Returns:

this

setLocalDateTime

public BreinTemporalData setLocalDateTime(java.lang.String timeString)

Sets the localDateTime for a Stringified date, which will be parsed server side, i.e.:

     {
         user: {
              additional: {
                  'localDateTime': zonedDateTime
              }
         }
     }
 

Returns:

this

setLocation

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

Sets the location data using structured data (city, state, country), i.e.:

     {
         user: {
              additional: {
                  location: {
                      'city': city,
                      'state': state,
                      'country': country
                  }
              }
         }
     }
 

Parameters:

city - the city to look up

state - the state to look up (can be null)

country - the country to look up (can be null)

Returns:

this

addShapeTypes

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

Adds the specified shapeTypes to the currently defined shape-types to be returned with the response of the request, i.e.:

     {
         user: {
              additional: {
                  location: {
                      'shapeTypes': [...]
                  }
              }
         }
     }
 

Parameters:

shapeTypes - the shapeTypes to be added

Returns:

this

getLocation

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

Gets the current value specified within the location of the request.

Type Parameters:

T - the expected type of the returned value

Parameters:

key - the value to retrieve (e.g., "shapeTypes", "city", or "latitude")

Returns:

the associated value to the specified 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()

Description copied from interface: IExecutable

Method to execute the request synchronous.

Specified by:

execute in interface IExecutable<BreinTemporalDataResult>

Returns:

the returned value