Package com.aerisweather.aeris.tiles

Enum AerisPolygonData

java.lang.Object

java.lang.Enum<AerisPolygonData>

com.aerisweather.aeris.tiles.AerisPolygonData

All Implemented Interfaces:

AerisOverlay, Serializable, Comparable<AerisPolygonData>

public enum AerisPolygonData
extends Enum<AerisPolygonData>
implements AerisOverlay

Aeris polygon enum that helps setup each loading with the proper aeris query, proper handler and proper legend. Legends can be overridden by using their own drawable in the same name.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONVECTIVE_OUTLOOK
DROUGHT_MONITOR
FIRE_OUTLOOK
NONE
TROPICAL_CYCLONE_ERROR_CONES
WARNINGS	Weather warnings on the map within the past 24 hours.

Method Summary

Modifier and Type	Method	Description
AerisPointHandler	getHandler(AerisMapView mapView)	Gets the proper handler for the AerisRequest being made by the overlay.
int	getLegend()	Gets the integer drawable of the overlay's map legend.
String	getName()	Gets the display friendly name of the overlay
static AerisPolygonData	getPolygonDataFromName(String name)	Gets the enum from the string name of it.
com.aerisweather.aeris.communication.AerisRequest	getRequest(com.aerisweather.aeris.communication.Action action, com.aerisweather.aeris.communication.parameter.ParameterBuilder builder, android.content.Context context)	Gets the request needed to load the data for the overlay.
com.aerisweather.aeris.communication.AerisRequest	getRequest(com.aerisweather.aeris.communication.Action action, com.aerisweather.aeris.communication.parameter.ParameterBuilder builder, android.content.Context context, Boolean useDefaultParams)	Gets the request needed to load the data for the overlay.
com.aerisweather.aeris.communication.AerisRequest	getRequest(com.aerisweather.aeris.communication.parameter.PlaceParameter place, com.aerisweather.aeris.communication.Action action, com.aerisweather.aeris.communication.parameter.LimitParameter limit, com.aerisweather.aeris.communication.parameter.FromParameter from, com.aerisweather.aeris.communication.parameter.SortParameter sort)	Deprecated.
static List<String>	getStringList(android.content.Context context)	Gets a list of the String for displaying in lists.
void	setConvectiveOutlookParameters(com.aerisweather.aeris.communication.parameter.ParameterBuilder parameterBuilder)
void	setDroughtMonitorParameters(com.aerisweather.aeris.communication.parameter.ParameterBuilder parameterBuilder)
void	setFireOutlookParameters(com.aerisweather.aeris.communication.parameter.ParameterBuilder parameterBuilder)
void	setTropicalCycloneErrorConesParameters(com.aerisweather.aeris.communication.parameter.ParameterBuilder parameterBuilder)
static AerisPolygonData	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AerisPolygonData[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final AerisPolygonData NONE

WARNINGS

public static final AerisPolygonData WARNINGS

Weather warnings on the map within the past 24 hours. The warnings legend is R.drawable.legends_warnings.

CONVECTIVE_OUTLOOK

public static final AerisPolygonData CONVECTIVE_OUTLOOK

DROUGHT_MONITOR

public static final AerisPolygonData DROUGHT_MONITOR

FIRE_OUTLOOK

public static final AerisPolygonData FIRE_OUTLOOK

TROPICAL_CYCLONE_ERROR_CONES

public static final AerisPolygonData TROPICAL_CYCLONE_ERROR_CONES

Method Detail

values

public static AerisPolygonData[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AerisPolygonData c : AerisPolygonData.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AerisPolygonData valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Description copied from interface: AerisOverlay

Gets the display friendly name of the overlay

Specified by:

getName in interface AerisOverlay

Returns:

String representation of the overlay

getLegend

public int getLegend()

Description copied from interface: AerisOverlay

Gets the integer drawable of the overlay's map legend. Will be 0 if there is not a legend.

Specified by:

getLegend in interface AerisOverlay

Returns:

The legend of the overlay

getPolygonDataFromName

public static AerisPolygonData getPolygonDataFromName(String name)

Gets the enum from the string name of it.

Parameters:

name - name to check for.

Returns:

The enum of the name, null otherwise.

getStringList

public static List<String> getStringList(android.content.Context context)

Gets a list of the String for displaying in lists.

Parameters:

context - app context

Returns:

list of enums as their String names.

getHandler

public AerisPointHandler getHandler(AerisMapView mapView)

Description copied from interface: AerisOverlay

Gets the proper handler for the AerisRequest being made by the overlay.

Specified by:

getHandler in interface AerisOverlay

Parameters:

mapView - The mapview Obj to pass the handler results too

Returns:

The handler to the request made for loading the overlay.

getRequest

@Deprecated
public com.aerisweather.aeris.communication.AerisRequest getRequest(com.aerisweather.aeris.communication.parameter.PlaceParameter place,
                                                                    com.aerisweather.aeris.communication.Action action,
                                                                    com.aerisweather.aeris.communication.parameter.LimitParameter limit,
                                                                    com.aerisweather.aeris.communication.parameter.FromParameter from,
                                                                    com.aerisweather.aeris.communication.parameter.SortParameter sort)

Deprecated.

Description copied from interface: AerisOverlay

Gets the request needed to load the data for the overlay.

Specified by:

getRequest in interface AerisOverlay

Parameters:

place - place parameter to use

action - action type to use

limit - limit parameter to use

from - default from parameter to use

sort - default sort parameter to use

Returns:

The Aeris Request to load the overlay

getRequest

public com.aerisweather.aeris.communication.AerisRequest getRequest(com.aerisweather.aeris.communication.Action action,
                                                                    com.aerisweather.aeris.communication.parameter.ParameterBuilder builder,
                                                                    android.content.Context context)

Description copied from interface: AerisOverlay

Gets the request needed to load the data for the overlay.

Specified by:

getRequest in interface AerisOverlay

Parameters:

action - action type to use

builder - parameters to use

context - context to use to retrieve default option values

Returns:

The request object.

getRequest

public com.aerisweather.aeris.communication.AerisRequest getRequest(com.aerisweather.aeris.communication.Action action,
                                                                    com.aerisweather.aeris.communication.parameter.ParameterBuilder builder,
                                                                    android.content.Context context,
                                                                    Boolean useDefaultParams)

Description copied from interface: AerisOverlay

Gets the request needed to load the data for the overlay.

Specified by:

getRequest in interface AerisOverlay

Parameters:

action - action type to use

builder - parameters to use

context - context to use to retrieve default option values, if needed

useDefaultParams - flag to determine whether or not to use default parameters

Returns:

The request object

setConvectiveOutlookParameters

public void setConvectiveOutlookParameters(com.aerisweather.aeris.communication.parameter.ParameterBuilder parameterBuilder)

setDroughtMonitorParameters

public void setDroughtMonitorParameters(com.aerisweather.aeris.communication.parameter.ParameterBuilder parameterBuilder)

setFireOutlookParameters

public void setFireOutlookParameters(com.aerisweather.aeris.communication.parameter.ParameterBuilder parameterBuilder)

setTropicalCycloneErrorConesParameters

public void setTropicalCycloneErrorConesParameters(com.aerisweather.aeris.communication.parameter.ParameterBuilder parameterBuilder)