com.navigine.idl.java.Location Class Reference

Class is used for storing location parameters: identifier, version, name, a list of sublocations, etc. More...

Inheritance diagram for com.navigine.idl.java.Location:

Public Member Functions
abstract ElevationGraph	getElevationGraph (String tag)
	Method returns location elevation graph ElevationGraph for specified tag.
abstract ArrayList< String >	getGraphTags ()
	Method returns list of available graph tags.
abstract Sublocation	getSublocationById (int id)
	Method is used for obtaining a sublocation with the specified identifier from the current location.
abstract Category	getCategoryById (int id)
	Method is used for obtaining a category with the specified identifier from the current location.
abstract int	getId ()
	location's identifier.
abstract int	getVersion ()
	location's version.
abstract String	getName ()
	location name.
abstract String	getDescript ()
	location's description.
abstract ArrayList< Category >	getCategories ()
	List of venue categories defined for the location Category.
abstract ArrayList< Sublocation >	getSublocations ()
	List of sublocations Sublocation.
abstract boolean	getModified ()
	Flag indicates if location has been modified by user or not.
abstract boolean	isValid ()

Detailed Description

Class is used for storing location parameters: identifier, version, name, a list of sublocations, etc.

Location instance can be obtained from LocationManager using LocationListener callback, when the location is loaded.

Referenced from LocationManager LocationListener.

Definition at line 19 of file Location.java.

Member Function Documentation

getCategories()

abstract ArrayList< Category > com.navigine.idl.java.Location.getCategories ( )

abstract

List of venue categories defined for the location Category.

Returns

Java code snippet:

        // Get all categories
        java.util.ArrayList<Category> categories = location.getCategories();
        System.out.println("Number of categories: " + categories.size());

Kotlin code snippet:

        // Get all categories
        val categories = location.categories
        println("Number of categories: ${categories.size}")

Reimplemented in com.navigine.idl.java.internal.LocationBinding.

getCategoryById()

abstract Category com.navigine.idl.java.Location.getCategoryById ( int id )

abstract

Method is used for obtaining a category with the specified identifier from the current location.

Parameters

id	category identifier.

Returns

Category of the current location with the specified identifier, if it exists. If category with the specified identifier doesn't exist, function returns null.

Java code snippet:

        // Get category by ID
        if (!categories.isEmpty()) {
            Category category = location.getCategoryById(categories.get(0).getId());
            if (category != null) {
                demonstrateCategoryUsage(category);
            }
        }

Kotlin code snippet:

        // Get category by ID
        categories.firstOrNull()?.let { category ->
            val foundCategory = location.getCategoryById(category.id)
            foundCategory?.let { demonstrateCategoryUsage(it) }
        }

Reimplemented in com.navigine.idl.java.internal.LocationBinding.

getDescript()

abstract String com.navigine.idl.java.Location.getDescript ( )

abstract

location's description.

Returns

Java code snippet:

        // Get location description
        String description = location.getDescript();
        System.out.println("Location description: " + description);

Kotlin code snippet:

        // Get location description
        val description = location.descript
        println("Location description: $description")

Reimplemented in com.navigine.idl.java.internal.LocationBinding.

getElevationGraph()

abstract ElevationGraph com.navigine.idl.java.Location.getElevationGraph ( String tag )

abstract

Method returns location elevation graph ElevationGraph for specified tag.

Parameters

tag	Graph tag in CMS

Returns

Elevation graph instance or null.

ElevationGraph of the current location with the specified tag, if it exists. If elevation graph with the specified tag doesn't exist, function returns null.

Java code snippet:

        // Get elevation graph by tag
        if (!graphTags.isEmpty()) {
            ElevationGraph elevationGraph = location.getElevationGraph(graphTags.get(0));
            if (elevationGraph != null) {
                demonstrateElevationGraphUsage(elevationGraph);
            }
        }

Kotlin code snippet:

        // Get elevation graph by tag
        graphTags.firstOrNull()?.let { tag ->
            val elevationGraph = location.getElevationGraph(tag)
            elevationGraph?.let { demonstrateElevationGraphUsage(it) }
        }

Reimplemented in com.navigine.idl.java.internal.LocationBinding.

getGraphTags()

abstract ArrayList< String > com.navigine.idl.java.Location.getGraphTags ( )

abstract

Method returns list of available graph tags.

Returns

Array of existing tags

Java code snippet:

        // Get available graph tags
        java.util.ArrayList<String> graphTags = location.getGraphTags();
        System.out.println("Available graph tags: " + graphTags);

Kotlin code snippet:

        // Get available graph tags
        val graphTags = location.graphTags
        println("Available graph tags: $graphTags")

Reimplemented in com.navigine.idl.java.internal.LocationBinding.

getId()

abstract int com.navigine.idl.java.Location.getId ( )

abstract

location's identifier.

Returns

Java code snippet:

        // Get location ID
        int locationId = location.getId();
        System.out.println("Location ID: " + locationId);

Kotlin code snippet:

        // Get location ID
        val locationId = location.id
        println("Location ID: $locationId")

Reimplemented in com.navigine.idl.java.internal.LocationBinding.

getModified()

abstract boolean com.navigine.idl.java.Location.getModified ( )

abstract

Flag indicates if location has been modified by user or not.

Returns

Java code snippet:

        // Check if location is modified
        boolean isModified = location.getModified();
        System.out.println("Location modified: " + isModified);

Kotlin code snippet:

        // Check if location is modified
        val isModified = location.modified
        println("Location modified: $isModified")

Reimplemented in com.navigine.idl.java.internal.LocationBinding.

getName()

abstract String com.navigine.idl.java.Location.getName ( )

abstract

location name.

Returns

Java code snippet:

        // Get location name
        String name = location.getName();
        System.out.println("Location name: " + name);

Kotlin code snippet:

        // Get location name
        val name = location.name
        println("Location name: $name")

Reimplemented in com.navigine.idl.java.internal.LocationBinding.

getSublocationById()

abstract Sublocation com.navigine.idl.java.Location.getSublocationById ( int id )

abstract

Method is used for obtaining a sublocation with the specified identifier from the current location.

Parameters

id	sublocation identifier.

Returns

The Sublocation of the current location with the specified identifier, if it exists. If sublocation with the specified identifier doesn't exist, function returns null.

Java code snippet:

        // Get sublocation by ID
        if (!sublocations.isEmpty()) {
            Sublocation sublocation = location.getSublocationById(sublocations.get(0).getId());
            if (sublocation != null) {
                demonstrateSublocationUsage(sublocation);
            }
        }

Kotlin code snippet:

        // Get sublocation by ID
        sublocations.firstOrNull()?.let { sublocation ->
            val foundSublocation = location.getSublocationById(sublocation.id)
            foundSublocation?.let { demonstrateSublocationUsage(it) }
        }

Reimplemented in com.navigine.idl.java.internal.LocationBinding.

getSublocations()

abstract ArrayList< Sublocation > com.navigine.idl.java.Location.getSublocations ( )

abstract

List of sublocations Sublocation.

Returns

Java code snippet:

        // Get all sublocations
        java.util.ArrayList<Sublocation> sublocations = location.getSublocations();
        System.out.println("Number of sublocations: " + sublocations.size());

Kotlin code snippet:

        // Get all sublocations
        val sublocations = location.sublocations
        println("Number of sublocations: ${sublocations.size}")

Reimplemented in com.navigine.idl.java.internal.LocationBinding.

getVersion()

abstract int com.navigine.idl.java.Location.getVersion ( )

abstract

location's version.

Returns

Java code snippet:

        // Get location version
        int version = location.getVersion();
        System.out.println("Location version: " + version);

Kotlin code snippet:

        // Get location version
        val version = location.version
        println("Location version: $version")

Reimplemented in com.navigine.idl.java.internal.LocationBinding.

isValid()

abstract boolean com.navigine.idl.java.Location.isValid ( )

abstract

Tells if this Location is valid or not. Any other method (except for this one) called on an invalid Location will throw java.lang.RuntimeException.

Reimplemented in com.navigine.idl.java.internal.LocationBinding.

---

The documentation for this class was generated from the following file:

• Location.java