com.navigine.idl.java.internal.LocationBinding Class Reference

Inheritance diagram for com.navigine.idl.java.internal.LocationBinding:

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

Detailed Description

Definition at line 14 of file LocationBinding.java.

Member Function Documentation

getCategories()

ArrayList< Category > com.navigine.idl.java.internal.LocationBinding.getCategories ( )

inline

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 from com.navigine.idl.java.Location.

Definition at line 85 of file LocationBinding.java.

getCategoryById()

Category com.navigine.idl.java.internal.LocationBinding.getCategoryById ( int id )

inline

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 from com.navigine.idl.java.Location.

Definition at line 50 of file LocationBinding.java.

getDescript()

String com.navigine.idl.java.internal.LocationBinding.getDescript ( )

inline

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 from com.navigine.idl.java.Location.

Definition at line 78 of file LocationBinding.java.

getElevationGraph()

ElevationGraph com.navigine.idl.java.internal.LocationBinding.getElevationGraph ( String tag )

inline

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 from com.navigine.idl.java.Location.

Definition at line 29 of file LocationBinding.java.

getGraphTags()

ArrayList< String > com.navigine.idl.java.internal.LocationBinding.getGraphTags ( )

inline

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 from com.navigine.idl.java.Location.

Definition at line 36 of file LocationBinding.java.

getId()

int com.navigine.idl.java.internal.LocationBinding.getId ( )

inline

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 from com.navigine.idl.java.Location.

Definition at line 57 of file LocationBinding.java.

getModified()

boolean com.navigine.idl.java.internal.LocationBinding.getModified ( )

inline

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 from com.navigine.idl.java.Location.

Definition at line 99 of file LocationBinding.java.

getName()

String com.navigine.idl.java.internal.LocationBinding.getName ( )

inline

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 from com.navigine.idl.java.Location.

Definition at line 71 of file LocationBinding.java.

getSublocationById()

Sublocation com.navigine.idl.java.internal.LocationBinding.getSublocationById ( int id )

inline

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 from com.navigine.idl.java.Location.

Definition at line 43 of file LocationBinding.java.

getSublocations()

ArrayList< Sublocation > com.navigine.idl.java.internal.LocationBinding.getSublocations ( )

inline

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 from com.navigine.idl.java.Location.

Definition at line 92 of file LocationBinding.java.

getVersion()

int com.navigine.idl.java.internal.LocationBinding.getVersion ( )

inline

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 from com.navigine.idl.java.Location.

Definition at line 64 of file LocationBinding.java.

isValid()

native boolean com.navigine.idl.java.internal.LocationBinding.isValid

(

)

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 from com.navigine.idl.java.Location.

---

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

• LocationBinding.java