com.ibm.tivoli.nm.collectors.framework.store

Class Element

java.lang.Object

com.ibm.tivoli.nm.collectors.framework.store.Element

All Implemented Interfaces:

Associatable

Direct Known Subclasses:

LogicalElement, NetworkDevice

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.

Author:

Emlyn Whittick

Field Summary

Fields

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 Summary

Constructors

Constructor and Description
Element()

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.tivoli.nm.collectors.framework.store.Associatable

associate

Field Detail

customData

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. This is heavily utilised in RANNetworkDevice. No data validation is performed on this data.

extraInfo

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. No data validation is performed on this data.

Constructor Detail

Element

public Element()

Method Detail

addCustomData

public void addCustomData(java.util.Map<java.lang.String,java.lang.Object> customData)

Add custom data to the element

Parameters:

customData - The custom data to add

addExtraInfo

public void addExtraInfo(java.util.Map<java.lang.String,java.lang.Object> extraInfoData)

Add extra info into the extraInfo field

Parameters:

extraInfoData - The data for the extra information

getCustomData

public java.util.Map<java.lang.String,java.lang.Object> getCustomData()

Returns a map of any custom data (e.g. RAN data, relationship data) for an element

Returns:

a map of any custom data for an element

getExtraInfo

public java.util.Map<java.lang.String,java.lang.Object> getExtraInfo()

Get the extra information for this element

Returns:

The map that holds all extraInfo data for this element

getId

public abstract java.lang.String getId()

Return the unique identifier for this element

Returns:

The unique identifier for this element

getName

public abstract java.lang.String getName()

Return the name of this element

Returns:

The name of this element

merge

public abstract boolean merge(Element e)

Merge the data from two different elements

Parameters:

e - The element from which missing data should be added

Returns:

Whether or not any data was merged

toXMLString

public abstract java.lang.String toXMLString()

Return the "device XML" string representation of this element

Returns:

An XML representation of the element (treated as a "device") e.g.

 
 <device>
   <id>10.1.230.3</id>
   <ip>10.1.230.3</ip>
   <addressSpace></addressSpace>
 </device>