NetworkElement (net2plan-javadoc 0.6.0.1 API)

java.lang.Object
- com.net2plan.interfaces.networkDesign.NetworkElement

All Implemented Interfaces:

Comparable<NetworkElement>

Direct Known Subclasses:

Demand, Link, MulticastDemand, MulticastTree, NetPlan, NetworkLayer, Node, Resource, Route, SharedRiskGroup
```
public abstract class NetworkElement
extends Object
implements Comparable<NetworkElement>
```
Class defining a generic network element.

This class represents a network element. It contains bare minimum fields and methods to be considered the skeleton for other network elements wich extends this class; such as nodes, links, demands, etc.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTag(String tag)` Adds a tag to this network element.
`void`	`checkAttachedToNetPlanObject()` Checks whether this element (demand, node, route...) is attached to a netPlan object.
`void`	`checkAttachedToNetPlanObject(NetPlan np)` Checks whether this element (demand, node, route...) was not already removed from the `NetPlan` object.
`int`	`compareTo(NetworkElement o)`
`boolean`	`equals(Object o)` Return true if the Object o is an IdetifiedElement, with the same identifier and attached to the same NetPlan object
`String`	`getAttribute(String key)` Returns the value of a given attribute for this network element, or null if not found.
`String`	`getAttribute(String key, String defaultValue)` Returns the value of a given attribute for this network element, or the default value provided if not found
`Double`	`getAttributeAsDouble(String key, Double defaultValue)` Returns the value of a given attribute for this network element
`List<Double>`	`getAttributeAsDoubleList(String key, List<Double> defaultValue)` Returns the value of a given attribute for this network element, in form of a list of doubles, as stored using the setAttributeAsDoubleList method
`DoubleMatrix2D`	`getAttributeAsDoubleMatrix(String key, DoubleMatrix2D defaultValue)` Returns the value of a given attribute for this network element, in form of a matrix, as stored using the setAttributeAsDoubleMatrix method
`List<List<Double>>`	`getAttributeAsDoubleMatrix(String key, List<List<Double>> defaultValue)` Returns the value of a given attribute for this network element, in form of a matrix, as stored using the setAttributeAsDoubleMatrix method
`List<String>`	`getAttributeAsStringList(String key, List<String> defaultValue)` Returns the value of a given attribute for this network element, in form of a list of strings, as stored using the setAttributeAsStringList method
`List<List<String>>`	`getAttributeAsStringMatrix(String key, List<List<String>> defaultValue)` Returns the value of a given attribute for this network element, in form of a list of list of strings, as stored using the setAttributeAsStringMatrix method
`SortedMap<String,String>`	`getAttributes()` Returns the element attributes (a copy)
`String`	`getDescription()` Returns current element description String
`long`	`getId()` Returns the unique identifier
`int`	`getIndex()` Returns the index
`String`	`getName()` Returns current element name String
`NetPlan`	`getNetPlan()` Returns the `NetPlan` object to which this element is attached
`com.net2plan.internal.Constants.NetworkElementType`	`getNeType()`
`SortedSet<String>`	`getTags()` Returns the set of tags assigned to this network element
`boolean`	`hasTag(String tag)` Returns true if this network element has the given tag
`void`	`removeAllAttributes()` Removes the attribute attached to this network element.
`void`	`removeAttribute(String key)` Removes the attribute attached to this network element.
`boolean`	`removeTag(String tag)` Removes this tag from the network element.
`void`	`setAttribute(String key, Number value)` Sets an attribute for this element, so it can be read with getAttributeAsNumber method.
`void`	`setAttribute(String key, String value)` Sets an attribute for this element.
`void`	`setAttributeAsNumberList(String key, List<? extends Number> valueList)` Sets an attribute for this element, storing the values of the given value list, so it can be read with getAttributeAsNumberList method.
`void`	`setAttributeAsNumberMatrix(String key, DoubleMatrix2D vals)` Sets an attribute for this element, storing the values of the given matrix, so it can be read with setAttributeAsNumberMatrix method.
`void`	`setAttributeAsNumberMatrix(String key, List<List<Number>> vals)` Sets an attribute for this element, storing the values of the given matrix, so it can be read with setAttributeAsNumberMatrix method.
`void`	`setAttributeAsStringList(String key, List<String> vals)` Sets an attribute for this element, storing the values of the given value list, so it can be read with getAttributeAsStringList method.
`void`	`setAttributeAsStringMatrix(String key, List<List<String>> vals)` Sets an attribute for this element, storing the values of the given value list, so it can be read with getAttributeAsStringMatrix method.
`void`	`setAttributeMap(Map<String,String> map)` Sets the attributes for this network element.
`void`	`setDescription(String description)` Sets this element description
`void`	`setName(String name)` Sets this element name
`String`	`toString()` Returns a `String` representation of the network element.
`boolean`	`wasRemoved()` Return true if the element was already removed from the NetPlan object, and thus cannot be acccessed

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - addTag
```
public void addTag(String tag)
```
    Adds a tag to this network element. If the element already has this tag, nothing happens
    
    Parameters:
    
    tag - the tag
  - checkAttachedToNetPlanObject
```
public final void checkAttachedToNetPlanObject()
```
    Checks whether this element (demand, node, route...) is attached to a netPlan object. When negative, an exception will be thrown.
  - checkAttachedToNetPlanObject
```
public final void checkAttachedToNetPlanObject(NetPlan np)
```
    Checks whether this element (demand, node, route...) was not already removed from the NetPlan object. When negative, an exception will be thrown.
    
    Parameters:
    
    np - NetPlan object
  - compareTo
```
public final int compareTo(NetworkElement o)
```
    Specified by:
    
    compareTo in interface Comparable<NetworkElement>
  - equals
```
public final boolean equals(Object o)
```
    Return true if the Object o is an IdetifiedElement, with the same identifier and attached to the same NetPlan object
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - Object to compare to
    
    Returns:
    
    true if it was removed
    
    Since:
    
    0.4.0
  - getAttribute
```
public String getAttribute(String key)
```
    Returns the value of a given attribute for this network element, or null if not found.
    
    Parameters:
    
    key - Attribute name
    
    Returns:
    
    Attribute value (or null, if not defined)
  - getAttribute
```
public String getAttribute(String key,
                           String defaultValue)
```
    Returns the value of a given attribute for this network element, or the default value provided if not found
    
    Parameters:
    
    key - Attribute name
    
    defaultValue - default value to return if not found
    
    Returns:
    
    Attribute value (or null, if not defined)
  - getAttributeAsDouble
```
public Double getAttributeAsDouble(String key,
                                   Double defaultValue)
```
    Returns the value of a given attribute for this network element
    
    Parameters:
    
    key - Attribute name
    
    defaultValue - default value to return if not found, or could not be parsed
    
    Returns:
    
    see above
  - getAttributeAsDoubleList
```
public List<Double> getAttributeAsDoubleList(String key,
                                             List<Double> defaultValue)
```
    Returns the value of a given attribute for this network element, in form of a list of doubles, as stored using the setAttributeAsDoubleList method
    
    Parameters:
    
    key - Attribute name
    
    defaultValue - default value to return if not found, or could not be parsed
    
    Returns:
    
    see above
  - getAttributeAsDoubleMatrix
```
public DoubleMatrix2D getAttributeAsDoubleMatrix(String key,
                                                 DoubleMatrix2D defaultValue)
```
    Returns the value of a given attribute for this network element, in form of a matrix, as stored using the setAttributeAsDoubleMatrix method
    
    Parameters:
    
    key - Attribute name
    
    defaultValue - default value to return if not found, or could not be parsed
    
    Returns:
    
    see above
  - getAttributeAsDoubleMatrix
```
public List<List<Double>> getAttributeAsDoubleMatrix(String key,
                                                     List<List<Double>> defaultValue)
```
    Returns the value of a given attribute for this network element, in form of a matrix, as stored using the setAttributeAsDoubleMatrix method
    
    Parameters:
    
    key - Attribute name
    
    defaultValue - default value to return if not found, or could not be parsed
    
    Returns:
    
    see above
  - getAttributeAsStringList
```
public List<String> getAttributeAsStringList(String key,
                                             List<String> defaultValue)
```
    Returns the value of a given attribute for this network element, in form of a list of strings, as stored using the setAttributeAsStringList method
    
    Parameters:
    
    key - Attribute name
    
    defaultValue - default value to return if not found, or could not be parsed
    
    Returns:
    
    see above
  - getAttributeAsStringMatrix
```
public List<List<String>> getAttributeAsStringMatrix(String key,
                                                     List<List<String>> defaultValue)
```
    Returns the value of a given attribute for this network element, in form of a list of list of strings, as stored using the setAttributeAsStringMatrix method
    
    Parameters:
    
    key - Attribute name
    
    defaultValue - default value to return if not found, or could not be parsed
    
    Returns:
    
    see above
  - getAttributes
```
public final SortedMap<String,String> getAttributes()
```
    Returns the element attributes (a copy)
    
    Returns:
    
    the attribute map
    
    Since:
    
    0.4.0
  - getDescription
```
public final String getDescription()
```
    Returns current element description String
    
    Returns:
    
    see above
  - getId
```
public final long getId()
```
    Returns the unique identifier
    
    Returns:
    
    The unique id
    
    Since:
    
    0.4.0
  - getIndex
```
public int getIndex()
```
    Returns the index
    
    Returns:
    
    The index
  - getName
```
public final String getName()
```
    Returns current element name String
    
    Returns:
    
    see above
  - getNetPlan
```
public final NetPlan getNetPlan()
```
    Returns the NetPlan object to which this element is attached
    
    Returns:
    
    The NetPlan object
    
    Since:
    
    0.4.0
  - getNeType
```
public com.net2plan.internal.Constants.NetworkElementType getNeType()
```
  - getTags
```
public SortedSet<String> getTags()
```
    Returns the set of tags assigned to this network element
    
    Returns:
    
    the set (unmodifiable)
  - hasTag
```
public boolean hasTag(String tag)
```
    Returns true if this network element has the given tag
    
    Parameters:
    
    tag - the tag
    
    Returns:
    
    see above
  - removeAllAttributes
```
public final void removeAllAttributes()
```
    Removes the attribute attached to this network element. If the attribute does not exist in this network element, no action is made
    
    Since:
    
    0.4.0
  - removeAttribute
```
public final void removeAttribute(String key)
```
    Removes the attribute attached to this network element. If the attribute does not exist in this network element, no action is made
    
    Parameters:
    
    key - Attribute name
    
    Since:
    
    0.4.0
  - removeTag
```
public boolean removeTag(String tag)
```
    Removes this tag from the network element. If the element did not have the tag, nothing happens
    
    Parameters:
    
    tag - the tag
    
    Returns:
    
    true if the element had the tag before, and so it was removed from it. False, if the element did not have the tag (and thus nothing happened)
  - setAttribute
```
public void setAttribute(String key,
                         Number value)
```
    Sets an attribute for this element, so it can be read with getAttributeAsNumber method. If it already exists, previous value is lost.
    
    Parameters:
    
    key - Attribute name
    
    value - Attribute value
  - setAttribute
```
public void setAttribute(String key,
                         String value)
```
    Sets an attribute for this element. If it already exists, it will be overriden.
    
    Parameters:
    
    key - Attribute name
    
    value - Attribute value
    
    Since:
    
    0.3.0
  - setAttributeAsNumberList
```
public void setAttributeAsNumberList(String key,
                                     List<? extends Number> valueList)
```
    Sets an attribute for this element, storing the values of the given value list, so it can be read with getAttributeAsNumberList method. If it already exists, previous value is lost.
    
    Parameters:
    
    key - Attribute name
    
    valueList - Attribute value
  - setAttributeAsNumberMatrix
```
public void setAttributeAsNumberMatrix(String key,
                                       DoubleMatrix2D vals)
```
    Sets an attribute for this element, storing the values of the given matrix, so it can be read with setAttributeAsNumberMatrix method. If it already exists, previous value is lost.
    
    Parameters:
    
    key - Attribute name
    
    vals - Attribute vals
  - setAttributeAsNumberMatrix
```
public void setAttributeAsNumberMatrix(String key,
                                       List<List<Number>> vals)
```
    Sets an attribute for this element, storing the values of the given matrix, so it can be read with setAttributeAsNumberMatrix method. If it already exists, previous value is lost.
    
    Parameters:
    
    key - Attribute name
    
    vals - Attribute vals
  - setAttributeAsStringList
```
public void setAttributeAsStringList(String key,
                                     List<String> vals)
```
    Sets an attribute for this element, storing the values of the given value list, so it can be read with getAttributeAsStringList method. If it already exists, previous value is lost.
    
    Parameters:
    
    key - Attribute name
    
    vals - Attribute vals
  - setAttributeAsStringMatrix
```
public void setAttributeAsStringMatrix(String key,
                                       List<List<String>> vals)
```
    Sets an attribute for this element, storing the values of the given value list, so it can be read with getAttributeAsStringMatrix method. If it already exists, previous value is lost.
    
    Parameters:
    
    key - Attribute name
    
    vals - Attribute vals
  - setAttributeMap
```
public void setAttributeMap(Map<String,String> map)
```
    Sets the attributes for this network element. Any previous attributes will be removed.
    
    Parameters:
    
    map - Attribute where the keys are the attribute names and the values the attribute values
  - setDescription
```
public final void setDescription(String description)
```
    Sets this element description
    
    Parameters:
    
    description - see above
  - setName
```
public final void setName(String name)
```
    Sets this element name
    
    Parameters:
    
    name - see above
  - toString
```
public String toString()
```
    Returns a String representation of the network element.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of the network element
  - wasRemoved
```
public final boolean wasRemoved()
```
    Return true if the element was already removed from the NetPlan object, and thus cannot be acccessed
    
    Returns:
    
    true if it was removed
    
    Since:
    
    0.4.0

Class NetworkElement

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addTag

checkAttachedToNetPlanObject

checkAttachedToNetPlanObject

compareTo

equals

getAttribute

getAttribute

getAttributeAsDouble

getAttributeAsDoubleList

getAttributeAsDoubleMatrix

getAttributeAsDoubleMatrix

getAttributeAsStringList

getAttributeAsStringMatrix

getAttributes

getDescription

getId

getIndex

getName

getNetPlan

getNeType

getTags

hasTag

removeAllAttributes

removeAttribute

removeTag

setAttribute

setAttribute

setAttributeAsNumberList

setAttributeAsNumberMatrix

setAttributeAsNumberMatrix

setAttributeAsStringList

setAttributeAsStringMatrix

setAttributeMap

setDescription

setName

toString

wasRemoved