org.onosproject.net.config.basics

Class BasicElementConfig<S>

java.lang.Object

org.onosproject.net.config.Config<S>

org.onosproject.net.config.basics.AllowedEntityConfig<S>

org.onosproject.net.config.basics.BasicElementConfig<S>

Direct Known Subclasses:

BasicDeviceConfig, BasicHostConfig

public abstract class BasicElementConfig<S>
extends AllowedEntityConfig<S>

Basic configuration for network elements, e.g. devices, hosts. Such elements can have a friendly name, geo-coordinates, logical rack coordinates and an owner entity.

Nested Class Summary

Nested classes/interfaces inherited from class org.onosproject.net.config.Config

Config.FieldPresence

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	LATITUDE
protected static String	LONGITUDE
protected static String	NAME
protected static String	OWNER
protected static String	RACK_ADDRESS
protected static String	UI_TYPE
protected static double	ZERO_THRESHOLD

Fields inherited from class org.onosproject.net.config.basics.AllowedEntityConfig

ALLOWED

Fields inherited from class org.onosproject.net.config.Config

array, delegate, key, mapper, node, object, subject

Constructor Summary

Constructors

Constructor and Description
BasicElementConfig()

Method Summary

Modifier and Type	Method and Description
boolean	geoCoordsSet() Returns true if the geographical coordinates (latitude and longitude) are set on this element; false otherwise.
double	latitude() Returns element latitude.
BasicElementConfig	latitude(Double latitude) Sets the element latitude.
double	longitude() Returns element longitude.
BasicElementConfig	longitude(Double longitude) Sets the element longitude.
String	name() Returns friendly label for the element.
BasicElementConfig	name(String name) Sets friendly label for the element.
String	owner() Returns owner of the element.
BasicElementConfig	owner(String owner) Sets the owner of the element.
String	rackAddress() Returns the element rack address.
BasicElementConfig	rackAddress(String address) Sets element rack address.
String	uiType() Returns the UI type (glyph image to be used) for the element in the Topology View.
BasicElementConfig	uiType(String uiType) Sets the UI type (glyph image to be used) for the element in the Topology View.

Methods inherited from class org.onosproject.net.config.basics.AllowedEntityConfig

isAllowed, isAllowed

Methods inherited from class org.onosproject.net.config.Config

apply, clear, get, get, get, get, get, get, getList, getList, hasField, hasField, hasFields, hasFields, hasOnlyFields, hasOnlyFields, init, isBoolean, isBoolean, isConnectPoint, isConnectPoint, isDecimal, isDecimal, isIntegralNumber, isIntegralNumber, isIpAddress, isIpAddress, isIpPrefix, isIpPrefix, isMacAddress, isMacAddress, isNumber, isNumber, isString, isString, isTpPort, isTpPort, isValid, key, node, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, subject

Methods inherited from class java.lang.Object

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

Field Detail

NAME

protected static final String NAME

See Also:

Constant Field Values

UI_TYPE

protected static final String UI_TYPE

See Also:

Constant Field Values

LATITUDE

protected static final String LATITUDE

See Also:

Constant Field Values

LONGITUDE

protected static final String LONGITUDE

See Also:

Constant Field Values

RACK_ADDRESS

protected static final String RACK_ADDRESS

See Also:

Constant Field Values

OWNER

protected static final String OWNER

See Also:

Constant Field Values

ZERO_THRESHOLD

protected static final double ZERO_THRESHOLD

See Also:

Constant Field Values

Constructor Detail

BasicElementConfig

public BasicElementConfig()

Method Detail

name

public String name()

Returns friendly label for the element.

Returns:

friendly label or element identifier itself if not set

name

public BasicElementConfig name(String name)

Sets friendly label for the element.

Parameters:

name - new friendly label; null to clear

Returns:

self

uiType

public String uiType()

Returns the UI type (glyph image to be used) for the element in the Topology View.

Returns:

the UI type

uiType

public BasicElementConfig uiType(String uiType)

Sets the UI type (glyph image to be used) for the element in the Topology View.

Parameters:

uiType - the UI type; null for default

Returns:

self

geoCoordsSet

public boolean geoCoordsSet()

Returns true if the geographical coordinates (latitude and longitude) are set on this element; false otherwise.

Returns:

true if geo-coordinates are set; false otherwise

latitude

public double latitude()

Returns element latitude.

Returns:

element latitude; 0.0 if (possibly) not set

See Also:

geoCoordsSet()

latitude

public BasicElementConfig latitude(Double latitude)

Sets the element latitude.

Parameters:

latitude - new latitude; null to clear

Returns:

self

longitude

public double longitude()

Returns element longitude.

Returns:

element longitude; 0 if (possibly) not set

See Also:

geoCoordsSet()

longitude

public BasicElementConfig longitude(Double longitude)

Sets the element longitude.

Parameters:

longitude - new longitude; null to clear

Returns:

self

rackAddress

public String rackAddress()

Returns the element rack address.

Returns:

rack address; null if not set

rackAddress

public BasicElementConfig rackAddress(String address)

Sets element rack address.

Parameters:

address - new rack address; null to clear

Returns:

self

owner

public String owner()

Returns owner of the element.

Returns:

owner or null if not set

owner

public BasicElementConfig owner(String owner)

Sets the owner of the element.

Parameters:

owner - new owner; null to clear

Returns:

self