public abstract class Element extends java.lang.Object implements Associatable
An interface representing a top level entity to be stored in the
DataStore
. An Element may be a device (e.g. chassis), as represented
by the NetworkDevice
implementation, or a logical entity (a top level
entity that is not a physical device), such as a cell.
Modifier and Type | Field and Description |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
customData
A map to hold any custom network data information that is not to be
included in the normal XML-RPC responses such as RAN specific data.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
extraInfo
A map to hold additional informational data to be included in XML-RPC
calls under the
extraInfo tag. |
Constructor and Description |
---|
Element() |
Modifier and Type | Method and Description |
---|---|
void |
addCustomData(java.util.Map<java.lang.String,java.lang.Object> customData)
Add custom data to the element
|
void |
addExtraInfo(java.util.Map<java.lang.String,java.lang.Object> extraInfoData)
Add extra info into the extraInfo field
|
java.util.Map<java.lang.String,java.lang.Object> |
getCustomData()
Returns a map of any custom data (e.g.
|
java.util.Map<java.lang.String,java.lang.Object> |
getExtraInfo()
Get the extra information for this element
|
abstract java.lang.String |
getId()
Return the unique identifier for this element
|
abstract java.lang.String |
getName()
Return the name of this element
|
abstract boolean |
merge(Element e)
Merge the data from two different elements
|
abstract java.lang.String |
toXMLString()
Return the "device XML" string representation of this element
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
associate
protected java.util.Map<java.lang.String,java.lang.Object> customData
RANNetworkDevice
. No data validation is
performed on this data.protected java.util.Map<java.lang.String,java.lang.Object> extraInfo
extraInfo
tag. No data validation is performed on
this data.public void addCustomData(java.util.Map<java.lang.String,java.lang.Object> customData)
customData
- The custom data to addpublic void addExtraInfo(java.util.Map<java.lang.String,java.lang.Object> extraInfoData)
extraInfoData
- The data for the extra informationpublic java.util.Map<java.lang.String,java.lang.Object> getCustomData()
public java.util.Map<java.lang.String,java.lang.Object> getExtraInfo()
public abstract java.lang.String getId()
public abstract java.lang.String getName()
public abstract boolean merge(Element e)
e
- The element from which missing data should be addedpublic abstract java.lang.String toXMLString()
<device>
<id>10.1.230.3</id>
<ip>10.1.230.3</ip>
<addressSpace></addressSpace>
</device>