com.tune.ma.analytics.model

Class TuneAnalyticsVariable

java.lang.Object

com.tune.ma.analytics.model.TuneAnalyticsVariable

public class TuneAnalyticsVariable
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TuneAnalyticsVariable.TuneAnalyticsVariableBuilder Created by charlesgilliam on 1/26/16.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DID_HAVE_VALUE_MANUALLY_SET
static String	HASH
static String	IOS_BOOLEAN_FALSE
static String	IOS_BOOLEAN_TRUE
static String	NAME
static String	SHOULD_AUTO_HASH
static String	TYPE
static String	VALUE

Constructor Summary

Constructors

Constructor and Description
TuneAnalyticsVariable(String name, boolean value)
TuneAnalyticsVariable(String name, Date value)
TuneAnalyticsVariable(String name, double value)
TuneAnalyticsVariable(String name, float value)
TuneAnalyticsVariable(String name, int value)
TuneAnalyticsVariable(String name, String value)
TuneAnalyticsVariable(String name, String value, TuneVariableType type)
TuneAnalyticsVariable(String name, String value, TuneVariableType type, TuneHashType hashType, boolean shouldAutohash)
TuneAnalyticsVariable(String name, TuneLocation value)
TuneAnalyticsVariable(TuneAnalyticsVariable var)

Method Summary

Modifier and Type	Method and Description
static TuneAnalyticsVariable.TuneAnalyticsVariableBuilder	Builder(String variableName)
static String	cleanVariableName(String name) Strips non-alphanumeric, underscore or hyphen characters
static String	dateToString(Date date)
boolean	didHaveValueManuallySet()
static TuneAnalyticsVariable	fromJson(String json) Instantiates a TuneAnalyticsVariable object from JSON representation
static String	geolocationToString(TuneLocation loc)
TuneHashType	getHashType()
String	getName()
boolean	getShouldAutoHash()
TuneVariableType	getType()
String	getValue()
static Date	stringToDate(String s)
static TuneLocation	stringToGeolocation(String s)
org.json.JSONObject	toJsonForLocalStorage()
List<org.json.JSONObject>	toListOfJsonObjectsForDispatch()
static boolean	validateName(String name) Validates that an analytics variable name is alphanumeric
static boolean	validateVersion(String version) Validates than an analytics variable is an accepted version format

Methods inherited from class java.lang.Object

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

Field Detail

IOS_BOOLEAN_TRUE

public static final String IOS_BOOLEAN_TRUE

See Also:

Constant Field Values

IOS_BOOLEAN_FALSE

public static final String IOS_BOOLEAN_FALSE

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

VALUE

public static final String VALUE

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

HASH

public static final String HASH

See Also:

Constant Field Values

SHOULD_AUTO_HASH

public static final String SHOULD_AUTO_HASH

See Also:

Constant Field Values

DID_HAVE_VALUE_MANUALLY_SET

public static final String DID_HAVE_VALUE_MANUALLY_SET

See Also:

Constant Field Values

Constructor Detail

TuneAnalyticsVariable

public TuneAnalyticsVariable(String name,
                             String value)

TuneAnalyticsVariable

public TuneAnalyticsVariable(String name,
                             boolean value)

TuneAnalyticsVariable

public TuneAnalyticsVariable(String name,
                             int value)

TuneAnalyticsVariable

public TuneAnalyticsVariable(String name,
                             double value)

TuneAnalyticsVariable

public TuneAnalyticsVariable(String name,
                             float value)

TuneAnalyticsVariable

public TuneAnalyticsVariable(String name,
                             Date value)

TuneAnalyticsVariable

public TuneAnalyticsVariable(String name,
                             TuneLocation value)

TuneAnalyticsVariable

public TuneAnalyticsVariable(String name,
                             String value,
                             TuneVariableType type)

TuneAnalyticsVariable

public TuneAnalyticsVariable(String name,
                             String value,
                             TuneVariableType type,
                             TuneHashType hashType,
                             boolean shouldAutohash)

TuneAnalyticsVariable

public TuneAnalyticsVariable(TuneAnalyticsVariable var)

Method Detail

getName

public String getName()

getValue

public String getValue()

getType

public TuneVariableType getType()

getHashType

public TuneHashType getHashType()

didHaveValueManuallySet

public boolean didHaveValueManuallySet()

toListOfJsonObjectsForDispatch

public List<org.json.JSONObject> toListOfJsonObjectsForDispatch()

getShouldAutoHash

public boolean getShouldAutoHash()

toJsonForLocalStorage

public org.json.JSONObject toJsonForLocalStorage()

fromJson

public static TuneAnalyticsVariable fromJson(String json)

Instantiates a TuneAnalyticsVariable object from JSON representation

Parameters:

json - JSON representation of an analytics variable

Returns:

TuneAnalyticsVariable deserialized from JSON

validateName

public static boolean validateName(String name)

Validates that an analytics variable name is alphanumeric

Parameters:

name - Analytics variable name

Returns:

Whether name is valid to send to the pipeline

cleanVariableName

public static String cleanVariableName(String name)

Strips non-alphanumeric, underscore or hyphen characters

Parameters:

name - Analytics variable name

Returns:

Analytics variable name with non-valid characters removed

validateVersion

public static boolean validateVersion(String version)

Validates than an analytics variable is an accepted version format

Parameters:

version - Analytics variable version value

Returns:

Whether version value is valid to send to the pipeline

dateToString

public static String dateToString(Date date)

stringToDate

public static Date stringToDate(String s)

geolocationToString

public static String geolocationToString(TuneLocation loc)

stringToGeolocation

public static TuneLocation stringToGeolocation(String s)

Builder

public static TuneAnalyticsVariable.TuneAnalyticsVariableBuilder Builder(String variableName)