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

Class LogicalElement

java.lang.Object

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

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

All Implemented Interfaces:

Associatable

Direct Known Subclasses:

RANLogicalElement

public class LogicalElement
extends Element

A class representing a non-device, logical element, such as a cell. The logical element will be returned as a "device" from a GetDeviceInfo ( Collector.GetDeviceInfo(int, String)) or GetDeviceList ( Collector.GetDeviceList(int, int, String, String)) XML-RPC call but does not necessarily have all the attributes typically found on a device, such as an address or a set of interfaces.

Author:

Emlyn Whittick

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	id The unique identifier for this logical element
protected java.lang.String	name The name for this logical element

Fields inherited from class com.ibm.tivoli.nm.collectors.framework.store.Element

customData, extraInfo

Constructor Summary

Constructors

Constructor and Description
LogicalElement(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
void	associate(Associatable a) Associate this object with the given object.
java.lang.String	getId() Return the unique identifier for this element
java.lang.String	getName() Return the name of this element
boolean	merge(Element e) Merge the data from two different elements
void	setId(java.lang.String id) Set the unique ID for this logical element
void	setName(java.lang.String name) Set the name of this logical element
java.lang.String	toXMLString() Return the "device XML" string representation of this element

Methods inherited from class com.ibm.tivoli.nm.collectors.framework.store.Element

addCustomData, addExtraInfo, getCustomData, getExtraInfo

Methods inherited from class java.lang.Object

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

Field Detail

id

protected java.lang.String id

The unique identifier for this logical element

name

protected java.lang.String name

The name for this logical element

Constructor Detail

LogicalElement

public LogicalElement(java.lang.String id)

Method Detail

getId

public java.lang.String getId()

Description copied from class: Element

Return the unique identifier for this element

Specified by:

getId in class Element

Returns:

The unique identifier for this element

getName

public java.lang.String getName()

Description copied from class: Element

Return the name of this element

Specified by:

getName in class Element

Returns:

The name of this element

merge

public boolean merge(Element e)

Description copied from class: Element

Merge the data from two different elements

Specified by:

merge in class Element

Parameters:

e - The element from which missing data should be added

Returns:

Whether or not any data was merged

setId

public void setId(java.lang.String id)

Set the unique ID for this logical element

Parameters:

id - The unique ID for this logical element

setName

public void setName(java.lang.String name)

Set the name of this logical element

Parameters:

name - The name of this logical element

toXMLString

public java.lang.String toXMLString()

Description copied from class: Element

Return the "device XML" string representation of this element

Specified by:

toXMLString in class 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>
 

associate

public void associate(Associatable a)

Description copied from interface: Associatable

Associate this object with the given object. Define an associative relationship between this object and the given Associatable object. This is to say that object a is associated with this object. The nature of this association is up to the implementing class.

Parameters:

a - The object to associate with this object.