com.orchestranetworks.ui
Class UIContext

java.lang.Object
  com.orchestranetworks.ui.UIContext

Direct Known Subclasses:

UIRequestContext, UIResponseContext

public abstract class UIContext

extends Object

Common abstract class for UIBeanEditor contexts.

A UIBeanEditorrequest context and a response context have in common the fact that they are associated to a specific schema node and to a validation context.

Method Summary

String	displayOccurrence(Object aValue, boolean useLabels) Returns a string for displaying the value specified, according the current locale of this context.
Locale	getLocale() Returns the current locale of the user session.
SchemaNode	getNode() Returns the node to which the component is attached, as specified in the XML Schema document.
SchemaNode	getNode(Path aPath) Returns the node located at the path specified.
Path	getPathInAdaptation() Returns the path of the current node to which the component is attached.
Session	getSession() Returns the current session.
Object	getValue() Returns the current value of the current node.
Object	getValue(Path aPath) Returns the value at the path specified.
String	getWebName() Returns a string that uniquely identifies the current component in the current page.
String	getWebNameFor(String aLocalId) Returns a string that uniquely identifies the entity specified in the context of the current component in the current page.
String	getWebNameForPath(Path aPath) Returns a string that uniquely identifies the entity specified in the context of the current component in the current page.
String	getWebNameOfParent() Returns a string that uniquely identifies the entity specified in the context of the current component in the current page.

Methods inherited from class java.lang.Object

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

Method Detail

getWebNameFor

public String getWebNameFor(String aLocalId)

Returns a string that uniquely identifies the entity specified in the context of the current component in the current page.

getWebNameForPath

public String getWebNameForPath(Path aPath)

Returns a string that uniquely identifies the entity specified in the context of the current component in the current page.

Parameters:

aPath - location of the target relatively to the current node (for maximizing reusability, it is advised to use a relative path)

getWebNameOfParent

public String getWebNameOfParent()

Returns a string that uniquely identifies the entity specified in the context of the current component in the current page.

getWebName

public String getWebName()

Returns a string that uniquely identifies the current component in the current page.

getLocale

public Locale getLocale()

Returns the current locale of the user session.

getSession

public Session getSession()

Returns the current session.

getValue

public Object getValue()

Returns the current value of the current node.

displayOccurrence

public String displayOccurrence(Object aValue,
                                boolean useLabels)

Returns a string for displaying the value specified, according the current locale of this context.

Value specified must be related to the current node.

See Also:

SchemaNode.displayOccurrence(Object, boolean, ValueContext, Locale)

getValue

public Object getValue(Path aPath)

Returns the value at the path specified.

Parameters:

aPath - location of the target relatively to the current node (for maximizing reusability, it is advised to use a relative path)

getNode

public SchemaNode getNode()

Returns the node to which the component is attached, as specified in the XML Schema document.

See Also:

ValueContext.getNode()

getPathInAdaptation

public Path getPathInAdaptation()

Returns the path of the current node to which the component is attached.

The result of this method is more precise than getNode().getPathInAdaptation() because it is able to specify indexes (position predicates in XPath).

See Also:

Step.isIndexed(), getNode()

getNode

public SchemaNode getNode(Path aPath)

Returns the node located at the path specified.

See Also:

SchemaNode.getNode(Path)