uk.ac.newcastle.team22.usb.navigation

Class Node

java.lang.Object

uk.ac.newcastle.team22.usb.navigation.Node

All Implemented Interfaces:

FirestoreConstructable<Node>

public class Node
extends java.lang.Object
implements FirestoreConstructable<Node>

A class that represents a node used for navigation in the Urban Sciences Building.

Version:

1.0

Author:

Daniel Vincent

Nested Class Summary

Nested classes/interfaces inherited from interface uk.ac.newcastle.team22.usb.firebase.FirestoreConstructable

FirestoreConstructable.InitialisationFailed

Constructor Summary

Constructors

Constructor and Description
Node() Empty constructor.
Node(int nodeIdentifier, int floorNumber, java.util.List<Edge> edges)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Logical equality checking for node objects, falls back to superclass for other object types.
java.lang.String	getDescription()
java.util.List<Edge>	getEdges()
int	getFloorNumber()
int	getImage()
java.lang.String	getName()
int	getNodeIdentifier()
Node	initFromFirebase(java.util.Map<java.lang.String,java.lang.Object> firestoreDictionary, java.lang.String documentIdentifier) Constructs the object from a Firestore document dictionary.
boolean	isTourNode()
boolean	isTourRouteNode()

Methods inherited from class java.lang.Object

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

Constructor Detail

Node

public Node(int nodeIdentifier,
            int floorNumber,
            java.util.List<Edge> edges)

Parameters:

nodeIdentifier - Identifier of node in

USB.navigationNodes.

floorNumber - The floor this node resides on.

edges - A list of edges adjacent to this node.

Node

public Node()

Empty constructor.

Method Detail

initFromFirebase

public Node initFromFirebase(java.util.Map<java.lang.String,java.lang.Object> firestoreDictionary,
                             java.lang.String documentIdentifier)
                      throws FirestoreConstructable.InitialisationFailed

Description copied from interface: FirestoreConstructable

Constructs the object from a Firestore document dictionary.

Specified by:

initFromFirebase in interface FirestoreConstructable<Node>

Parameters:

firestoreDictionary - The Firestore document dictionary.

documentIdentifier - The identifier of the Firestore document, used as the

nodeIdentifier

.

Returns:

A node from database data.

Throws:

FirestoreConstructable.InitialisationFailed

FirestoreConstructable.InitialisationFailed

getNodeIdentifier

public int getNodeIdentifier()

Returns:

Unique identifier of the node.

getFloorNumber

public int getFloorNumber()

Returns:

Floor number which the node resides on.

isTourNode

public boolean isTourNode()

Returns:

Boolean value whether the node is a tour location.

isTourRouteNode

public boolean isTourRouteNode()

Returns:

Boolean value whether the node is a part of the tour despite not being a location.

getDescription

public java.lang.String getDescription()

Returns:

Description of the tour node's location.

getImage

@DrawableRes
public int getImage()

Returns:

Image representation of this tour node's location.

getName

public java.lang.String getName()

Returns:

Tour name of this tour node's location.

getEdges

public java.util.List<Edge> getEdges()

Returns:

List of edges.

equals

public boolean equals(java.lang.Object obj)

Logical equality checking for node objects, falls back to superclass for other object types.

Overrides:

equals in class java.lang.Object

Parameters:

obj - Object to compare to this

Returns:

true if nodes are logically equivalent, or objects have the same hash, otherwise false.