edu.wisc.trace.urcsdk.client.pret
Class Group

java.lang.Object
  edu.wisc.trace.urcsdk.client.pret.AbstractInteractor
      edu.wisc.trace.urcsdk.client.pret.Group

All Implemented Interfaces:

IInteractor, ISocketElementListener

public class Group
extends AbstractInteractor

Group represents the special-case PreT element that groups interactors. It has special methods that other interactors do not.

Version:

$Revision: 1.21 $

Author:

Andrew Martin, Trace R&D Center Created on: Sep 14, 2004

Field Summary

Fields inherited from class edu.wisc.trace.urcsdk.client.pret.AbstractInteractor

calculable, cohesion, domain, executable, id, navindex, readable, ref, rootElement, socketElement, widget, writeable

Constructor Summary

Group()
Creates a new Group instance.

Group(org.w3c.dom.Element rootElement, IUISocketElement socketElement)
Creates a new Group instance.

Method Summary

java.lang.String	getCohesion() Returns the cohesion level of this group in the form of a string.
java.util.List<IInteractor>	getInteractors() Returns the interactors grouped by this element.
ClientSession	getSession() Retreives the session that this group element belongs to.
void	parse(org.w3c.dom.Element rootElement) parse parses the <group> element of the PreT document.
void	setSession(ClientSession session) Sets the session this group element belongs to.

Methods inherited from class edu.wisc.trace.urcsdk.client.pret.AbstractInteractor

getDomain, getID, getNavindex, getPretDomain, getRef, getSelfRef, getSocketElement, getUIComponent, parse, setCalculable, setID, setNavindex, setRootElement, setSocketElement, setWidget, updateExecutable, updateReadable, updateResources, updateValue, updateWriteable

Methods inherited from class java.lang.Object

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

Constructor Detail

Group

public Group()

Creates a new Group instance.

Group

public Group(org.w3c.dom.Element rootElement,
             IUISocketElement socketElement)
      throws UrcException

Creates a new Group instance.

Parameters:

rootElement - an Element value

socketElement - an IUISocketElement value

Throws:

UrcException

Method Detail

parse

public void parse(org.w3c.dom.Element rootElement)
           throws UrcException

parse parses the <group> element of the PreT document. It gets the interactors grouped by this element and makes them accessible by the method getInteractors.

Overrides:

parse in class AbstractInteractor

Parameters:

rootElement - an Element value

Throws:

UrcException

getInteractors

public java.util.List<IInteractor> getInteractors()

Returns the interactors grouped by this element.

Returns:

a List<IInteractor> collection containing all interactors grouped by this element.

setSession

public void setSession(ClientSession session)

Sets the session this group element belongs to.

Parameters:

session - a Session object.

getSession

public ClientSession getSession()

Retreives the session that this group element belongs to.

Returns:

a Session object.

getCohesion

public java.lang.String getCohesion()

Returns the cohesion level of this group in the form of a string.

Returns:

a String value.