Package es.situm.sdk.model.cartography

Class PoiCategory

java.lang.Object

es.situm.sdk.model.Resource

es.situm.sdk.model.cartography.PoiCategory

All Implemented Interfaces:

android.os.Parcelable, MapperInterface, Filterable

public class PoiCategory
extends Resource
implements android.os.Parcelable, MapperInterface

Category of Point of Interest.

Instances are immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PoiCategory.Builder	Builder to construct a PoiCategory

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T extends Object>, android.os.Parcelable.Creator<T extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final android.os.Parcelable.Creator<PoiCategory>	CREATOR
static final PoiCategory	DEFAULT

Fields inherited from class es.situm.sdk.model.Resource

EMPTY_IDENTIFIER, EMPTY_IDENTIFIER_BACKWARDS

Fields inherited from interface es.situm.sdk.model.MapperInterface

ACCESSIBILITY_MODE, ACCURACY, ADDRESS, ALTITUDE, ASSET_TRACKING_OPTIONS_BEACON_FILTERS, ASSET_TRACKING_OPTIONS_ENABLED, ASSET_TRACKING_OPTIONS_ITERATIONS_TO_UPLOAD, ASSET_TRACKING_OPTIONS_SCANNING_INTERVAL, BEACON_FILTER_UUID, BEARING, BEARING_FROM, BEARING_QUALITY, BOUNDS, BOUNDS_ROTATED, BUILDING, BUILDING_IDENTIFIER, BUILDING_NAME, CARTESIAN_BEARING, CARTESIAN_COORDINATE, CENTER, CLOSEST_LOCATION_IN_ROUTE, CODE, CONVERSION, COORDINATE, CREATED_AT, CURRENT_INDICATION, CURRENT_STEP_INDEX, CUSTOM_FIELDS, dateFormat, DEGREES, DEGREES_CLOCKWISE, DEVICE_ID, DIAGNOSTICS_OPTIONS_UPLOAD_DIAGNOSTICS_DATA, DIMENSIONS, DISTANCE, DISTANCE_TO_CHANGE_FLOOR_THRESHOLD, DISTANCE_TO_CHANGE_INDICATION_THRESHOLD, DISTANCE_TO_CLOSEST_POINT_IN_ROUTE, DISTANCE_TO_END_STEP, DISTANCE_TO_GOAL, DISTANCE_TO_GOAL_THRESHOLD, DISTANCE_TO_IGNORE_FIRST_INDICATION, DISTANCE_TO_NEXT_LEVEL, DURATION_MINUTES, EDGES, EVENTS, EXCLUDED_TAGS, EXTERNAL_NAVIGATION_PAYLOAD, EXTERNAL_NAVIGATION_TYPE, FIRST_STEP, FLOOR, FLOOR_IDENTIFIER, FLOORS, FOREGROUND_SERVICE_NOTIFICATION_MESSAGE, FOREGROUND_SERVICE_NOTIFICATION_SHOW_STOP_ACTION, FOREGROUND_SERVICE_NOTIFICATION_STOP_ACTION_TEXT, FOREGROUND_SERVICE_NOTIFICATION_TAP_ACTION, FOREGROUND_SERVICE_NOTIFICATION_TITLE, FROM, GEOFENCES, HAS_BEARING, HAS_CARTESIAN_BEARING, HEIGHT, HUMAN_READABLE_MESSAGE, ID, IDENTIFIER, IGNORE_LOW_QUALITY_LOCATIONS, INCLUDED_TAGS, INDICATION_TYPE, INDICATIONS, INDICATIONS_INTERVAL, INDOOR_POIS, INFO_HTML, IS_FIRST, IS_INDOOR, IS_LAST, IS_OUTDOOR, IS_PUBLIC, LAST_STEP, LATITUDE, LONGITUDE, MAP_URL, MINIMIZE_FLOOR_CHANGES, NAME, NEEDED_LEVEL_CHANGE, NEXT_INDICATION, NEXT_LEVEL, NODES, NORTH_EAST, NORTH_WEST, ORIENTATION, ORIENTATION_TYPE, OUTDOOR_BUILDING_DETECTOR_BLE, OUTDOOR_POIS, OUTSIDE_ROUTE_THRESHOLD, PICTURE_THUMB_URL, PICTURE_URL, POI_CATEGORIES, POI_CATEGORY, POI_CATEGORY_CODE, POI_CATEGORY_ICON_SELECTED, POI_CATEGORY_ICON_UNSELECTED, POI_CATEGORY_IDENTIFIER, POI_CATEGORY_IDENTIFIERS, POI_CATEGORY_iNAME, POI_CATEGORY_NAME, POI_NAME, POI_TO, POI_TO_IDENTIFIER, POINTS, POLYGON_POINTS, POSITION, PROVIDER, QUALITY, RADIANS, RADIANS_MINUS_PI_PI, RADIUS, REALTIME_UPDATE_INTERVAL, ROTATION, ROUND_INDICATIONS_STEP, ROUTE, ROUTE_STEP, SCALE, SEGMENTS, SOUTH_EAST, SOUTH_WEST, STATUS_NAME, STATUS_ORDINAL, STEP_IDX_DESTINATION, STEP_IDX_ORIGIN, STEPS, TIME_TO_END_STEP, TIME_TO_FIRST_INDICATION, TIME_TO_GOAL, TIME_TO_IGNORE_UNEXPECTED_FLOOR_CHANGES, TIMESTAMP, TO, TO_LEGACY, TRIGGER, UPDATED_AT, USER_IDENTIFIER, WIDTH, X, Y

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method	Description
final int	describeContents()
boolean	equals(Object o)
static PoiCategory	fromMap(Map<String,Object> map)
final String	getCode()	Returns unique code of the category
String	getLocalizedName(String langCode)	Returns the name of the POI category in the language specified.
final String	getName()	Returns the category name appropriate for display to the user
I18nString	getNameAsI18n()	Returns the category name appropriate for display to the user with different value depending on the language
String	getSelectedIconBase64()
final URL	getSelectedIconUrl()
String	getUnselectedIconBase64()
final URL	getUnselectedIconUrl()
int	hashCode()
final boolean	isPublic()	Returns whether the category is public or not
Map<String,Object>	toMap()	Method to transform object into Map<String, Object>
String	toString()
final void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class es.situm.sdk.model.Resource

getCreatedAt, getCustomFields, getIdentifier, getUpdatedAt

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT

public static final PoiCategory DEFAULT

CREATOR

public static final android.os.Parcelable.Creator<PoiCategory> CREATOR

Method Details

getCode

@NonNull
public final String getCode()

Returns unique code of the category

getName

@NonNull
public final String getName()

Returns the category name appropriate for display to the user

getLocalizedName

@NonNull
public String getLocalizedName(String langCode)

Returns the name of the POI category in the language specified. If there is no name for that language it will return the default value

Parameters:

langCode - Language code in ISO 639. It must have two digits, for example "es", "en"

Returns:

Localized name

getNameAsI18n

@NonNull
public I18nString getNameAsI18n()

Returns the category name appropriate for display to the user with different value depending on the language

getUnselectedIconUrl

@NonNull
public final URL getUnselectedIconUrl()

getSelectedIconUrl

@NonNull
public final URL getSelectedIconUrl()

isPublic

public final boolean isPublic()

Returns whether the category is public or not

Returns:

true if the category is public, otherwise not

getUnselectedIconBase64

public String getUnselectedIconBase64()

getSelectedIconBase64

public String getSelectedIconBase64()

toMap

public Map<String,Object> toMap()

Description copied from interface: MapperInterface

Method to transform object into Map<String, Object>

Specified by:

toMap in interface MapperInterface

Returns:

Map<String, Object> with the information of the object mapped

fromMap

public static PoiCategory fromMap(Map<String,Object> map)
                           throws IllegalArgumentException

Throws:

IllegalArgumentException

equals

public boolean equals(Object o)

Overrides:

equals in class Resource

hashCode

public int hashCode()

Overrides:

hashCode in class Resource

toString

public String toString()

Overrides:

toString in class Resource

describeContents

public final int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public final void writeToParcel(android.os.Parcel dest,
 int flags)

Specified by:

writeToParcel in interface android.os.Parcelable