se.entra.phantom.rapp

Class RAPPEnumeration

java.lang.Object

se.entra.phantom.rapp.RAPPEnumeration

Direct Known Subclasses:

RAPPGlobVars, RAPPHostCells, RAPPLines

public abstract class RAPPEnumeration
extends Object

This abstract class handles all types of enumeration replies for getField, globVar and callPanel (for list data).

Constructor Summary

Constructors

Constructor and Description
RAPPEnumeration() Creates a new instance of the class with an empty list of items.

Method Summary

Modifier and Type	Method and Description
protected void	addElement(RAPPEnumerationItem item) Appends an element.
protected abstract RAPPEnumerationItem	createItem() Creates an instance of the EnumerationItem class.
int	getCount() Gets the count of elements in the vector.
protected RAPPEnumerationItem	getElementAt(int index) Gets the element at a position.
void	serializeFromDocument(RAPPElement element, String enumName, String itemName) Initializes the enumeration and its items class instances from a reply Element.
void	serializeToDocument(RAPPElement element, String enumName, String itemName) Creates all Elements for the enumeration items.
String	toString() Converts this class into a string for testing purposes.

Methods inherited from class java.lang.Object

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

Constructor Detail

RAPPEnumeration

public RAPPEnumeration()

Creates a new instance of the class with an empty list of items.

Method Detail

getCount

public int getCount()

Gets the count of elements in the vector.

addElement

protected void addElement(RAPPEnumerationItem item)

Appends an element. This method is used by the extending class. This class should provide another suitable method (with another name) that adds an element with of correct class for its implementation.

getElementAt

protected RAPPEnumerationItem getElementAt(int index)

Gets the element at a position. This method is used by the extending class. This class should provide another suitable method (with another name) that returns the element at a certain index with of correct class.

createItem

protected abstract RAPPEnumerationItem createItem()

Creates an instance of the EnumerationItem class. This method must be overridden by any RAPPEnumeration class.

serializeToDocument

public void serializeToDocument(RAPPElement element,
                                String enumName,
                                String itemName)

Creates all Elements for the enumeration items.

This method creates the child node "enumName" and for all items in the enumeration a child node "itemName". The item is then called using the method serializeToDocument(RAPPElement element,int index).

The XML for the node looks like (replace parenthesis with less-more-than signs):

  (enumName)
    (itemName attr="123"/)
    (itemName attr="456"/)
    ... etc ...
    (itemName attr="abc"/)
  (/enumName)
 

See Also:

RAPPEnumerationItem

serializeFromDocument

public void serializeFromDocument(RAPPElement element,
                                  String enumName,
                                  String itemName)
                           throws SAXException

Initializes the enumeration and its items class instances from a reply Element.

This method creates an item for each "itemName" tag and calls the item class with the method serializeFromDocument(RAPPElement element,int index).

Throws:

SAXException - for errors in the document.

See Also:

RAPPEnumerationItem

toString

public String toString()

Converts this class into a string for testing purposes.

Overrides:

toString in class Object