org.xngr
Interface NodeMarker

All Superinterfaces:

Marker

public interface NodeMarker
extends Marker

Identifies and presents a node in the system.

Version:

$Revision: 51 $, $Date: 2009-03-24 22:37:03 +0000 (Tue, 24 Mar 2009) $

Author:

Edwin Dankert

Method Summary

java.lang.String	getDescription(org.w3c.dom.Node node) The description is normally used to provide more information for the object or the nature of the object, this information is generally not readily available but will appear after a user-action, like moving the mouse over a representation of the object, for instance as a tool-tip
javax.swing.Icon	getIcon(org.w3c.dom.Node node) The icon is normally used to identify the object type and state.
java.lang.String	getName(org.w3c.dom.Node node) The name is normally used to (uniquely) identify the object in a view.
java.util.List<javax.xml.namespace.QName>	getRootElementNames() Return the document root element names, since it is deemed too 'expensive' to execute an XPath for every document these root-element-names are used to 'quickly' identify the XML documents the XPathExpression should be executed on, this method is not allowed to return null.
javax.xml.xpath.XPathExpression	getXPathExpression() Return a XPath expression which associates the Service with the specific XML Node(s).

Methods inherited from interface org.xngr.Marker

getIdentifier

Method Detail

getRootElementNames

java.util.List<javax.xml.namespace.QName> getRootElementNames()

Return the document root element names, since it is deemed too 'expensive' to execute an XPath for every document these root-element-names are used to 'quickly' identify the XML documents the XPathExpression should be executed on, this method is not allowed to return null. Note: only the namespace-URI and local name of the QName are used for comparison, the prefix is always ignored.

Returns:

the names of the document root element.

getXPathExpression

javax.xml.xpath.XPathExpression getXPathExpression()

Return a XPath expression which associates the Service with the specific XML Node(s). This method is not allowed to return null. Note: the return-type for the XPath Expression is always considered to be of type XPathConstants.NODESET.

Returns:

an XPath expression.

getIcon

javax.swing.Icon getIcon(org.w3c.dom.Node node)

The icon is normally used to identify the object type and state.

Parameters:

object - the object to return the icon for. Note: the provided object should not be modified.

Returns:

the icon for the object.

getName

java.lang.String getName(org.w3c.dom.Node node)

The name is normally used to (uniquely) identify the object in a view.

Parameters:

object - the object to return the name for. Note: the provided object should not be modified.

Returns:

the name for the object.

getDescription

java.lang.String getDescription(org.w3c.dom.Node node)

The description is normally used to provide more information for the object or the nature of the object, this information is generally not readily available but will appear after a user-action, like moving the mouse over a representation of the object, for instance as a tool-tip

Parameters:

object - the object to return the description for. Note: the provided object should not be modified.

Returns:

the description for the object.