org.onosproject.ui

Class UiTopoMap

java.lang.Object

org.onosproject.ui.UiTopoMap

public class UiTopoMap
extends java.lang.Object

Represents a geographically-based map to be used in the user interface topology view. Instances of this class are immutable.

Constructor Summary

Constructors

Constructor and Description
UiTopoMap(java.lang.String id, java.lang.String desc, java.lang.String filePath, double scale) Creates a new topology map.

Method Summary

Modifier and Type	Method and Description
java.lang.String	description() Returns the description for this map.
java.lang.String	filePath() Returns the filePath for this map.
java.lang.String	id() Returns the identifier for this map.
double	scale() Returns the scale for this map.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UiTopoMap

public UiTopoMap(java.lang.String id,
                 java.lang.String desc,
                 java.lang.String filePath,
                 double scale)

Creates a new topology map.

Parameters:

id - map identifier

desc - map description

filePath - map filePath

scale - map scale

Method Detail

id

public java.lang.String id()

Returns the identifier for this map.

Returns:

the identifier

description

public java.lang.String description()

Returns the description for this map.

Returns:

the description

filePath

public java.lang.String filePath()

Returns the filePath for this map.

Returns:

the filePath

scale

public double scale()

Returns the scale for this map.

Returns:

the scale

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object