edu.wisc.trace.urcsdk.client.uisocket
Class UISocketMirror

java.lang.Object
  edu.wisc.trace.urcsdk.client.uisocket.UISocketMirror

public class UISocketMirror
extends java.lang.Object

UISocketMirror is the object representation of a Target's Socket. It provides functionality for opening new sessions and for propagating global variable changes.

Version:

$Revision: 1.21 $

Author:

Andrew Martin, Trace R&D Center Created on: Aug 31, 2004

Constructor Summary

UISocketMirror(TargetMirror parentTarget, UISocketDescription socketDescription)
Creates a new UISocket instance.

Method Summary

ClientSession	addSession(ClientSession session) addSession
java.lang.String	getAccessKey(UserPreferences prefs) Describe getAccessKey method here.
java.util.List<IInteractor>	getAllInteractors() getAllInteractors all interactors for this UISocket
IResource	getElementHelp(ElementRef ref, Constants.ResourceRole helpType, UserPreferences prefs) getElementHelp help text for the specified element
IResource	getElementLabel(ElementRef ref, java.lang.String valueRef, UserPreferences prefs) getElementLabel returns a value-specific label for an element
IResource	getElementLabel(ElementRef ref, UserPreferences prefs) getElementLabel a label for the specified element
java.lang.String	getHelpEffect() getHelpEffect gets the effect of the socket
java.lang.String	getHelpPurpose() getHelpPurpose gets the purpose of a socket
IResource	getIcon(UserPreferences prefs) getIcon returns an image
java.lang.String	getID() getID gets the socket description's id attribute
java.lang.String[]	getKeywords() getKeywords returns keywords for the socket
IResource	getLabel(UserPreferences prefs) getLabel returns a label for the UISocket
java.lang.String	getName() getName returns the name of the socket description
ClientSession	getSession(java.lang.String sessionId) getSession returns a specific session on this socket
java.util.List<ClientSession>	getSessions() getSessions returns all open sessions on this socket.
TargetMirror	getTarget() getTarget returns the associated Target
UiidDocument	getUiidDocument() getUiidDocument returns the Uiid document associated with this socket
IUISocketElement	getUISocketElementbyId(java.lang.String elementId) getUISocketElementById returns an IUISocketElement for the specified element
IUISocketElement	getUISocketElementByRef(ElementRef ref) getUISocketElementByRef returns an IUISocketElement for the specified element
java.util.List<IUISocketElement>	getUISocketElements() getSocketElements all socket elements for this socket
java.util.List<IUISocketElement>	getUISocketElementsForSession(ClientSession session) getSocketElementsForSession returns all elements needed for a new Session.
XPathImpl	getXPathParser() getXPathParser the parser used by this UISocket
ClientSession	removeSession(ClientSession session) removeSession

Methods inherited from class java.lang.Object

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

Constructor Detail

UISocketMirror

public UISocketMirror(TargetMirror parentTarget,
                      UISocketDescription socketDescription)
               throws UrcException

Creates a new UISocket instance.

Parameters:

parentTarget - a Target value

socketDescription - an UISocketDescription value

Throws:

UrcException

Method Detail

getAccessKey

public java.lang.String getAccessKey(UserPreferences prefs)

Describe getAccessKey method here.

Returns:

a String value

getXPathParser

public XPathImpl getXPathParser()

getXPathParser the parser used by this UISocket

Returns:

an instance of XPathImpl

getAllInteractors

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

getAllInteractors all interactors for this UISocket

Returns:

a List of all interactors for this UISocket

getElementHelp

public IResource getElementHelp(ElementRef ref,
                                Constants.ResourceRole helpType,
                                UserPreferences prefs)

getElementHelp help text for the specified element

Parameters:

ref - a String value

helpType - a String value

Returns:

an IResource value

getElementLabel

public IResource getElementLabel(ElementRef ref,
                                 UserPreferences prefs)

getElementLabel a label for the specified element

Parameters:

ref - a String value

Returns:

an IResource value

getElementLabel

public IResource getElementLabel(ElementRef ref,
                                 java.lang.String valueRef,
                                 UserPreferences prefs)

getElementLabel returns a value-specific label for an element

Parameters:

ref - String specifies the element ref

valueRef - String will get a value-specific label

Returns:

an IResource value

getHelpEffect

public java.lang.String getHelpEffect()

getHelpEffect gets the effect of the socket

Returns:

a String value

getHelpPurpose

public java.lang.String getHelpPurpose()

getHelpPurpose gets the purpose of a socket

Returns:

a String value

getIcon

public IResource getIcon(UserPreferences prefs)

getIcon returns an image

Returns:

an IResource value

getID

public java.lang.String getID()

getID gets the socket description's id attribute

Returns:

a String value

getKeywords

public java.lang.String[] getKeywords()

getKeywords returns keywords for the socket

Returns:

a String[] value

getLabel

public IResource getLabel(UserPreferences prefs)

getLabel returns a label for the UISocket

Returns:

an IResource value

getName

public java.lang.String getName()

getName returns the name of the socket description

Returns:

a String value

getSessions

public java.util.List<ClientSession> getSessions()

getSessions returns all open sessions on this socket.

Returns:

a List of all open sessions

getSession

public ClientSession getSession(java.lang.String sessionId)

getSession returns a specific session on this socket

Parameters:

sessionId -

Returns:

the ClientSession with the corresponding sessionID

getUISocketElementByRef

public IUISocketElement getUISocketElementByRef(ElementRef ref)

getUISocketElementByRef returns an IUISocketElement for the specified element

Parameters:

ref - a String value

Returns:

an IUISocketElement value

getUISocketElementbyId

public IUISocketElement getUISocketElementbyId(java.lang.String elementId)

getUISocketElementById returns an IUISocketElement for the specified element

Parameters:

elementId - a String value

Returns:

an IUISocketElement value

getUISocketElementsForSession

public java.util.List<IUISocketElement> getUISocketElementsForSession(ClientSession session)

getSocketElementsForSession returns all elements needed for a new Session.

Returns:

a List of all elements needed for a new Session

getTarget

public TargetMirror getTarget()

getTarget returns the associated Target

Returns:

the associate Target

getUiidDocument

public UiidDocument getUiidDocument()

getUiidDocument returns the Uiid document associated with this socket

addSession

public ClientSession addSession(ClientSession session)
                         throws UrcException

addSession

Returns:

a Session value

Throws:

UrcException

removeSession

public ClientSession removeSession(ClientSession session)

removeSession

Returns:

a Session value

Throws:

UrcException

getUISocketElements

public java.util.List<IUISocketElement> getUISocketElements()
                                                     throws UrcException

getSocketElements all socket elements for this socket

Returns:

a List of all socket elements for this socket

Throws:

UrcException