org.netbeans.modules.bpel.model.spi
Interface FindHelper

All Known Implementing Classes:
FindHelperImpl

public interface FindHelper

This is helper interface for finding various elements in OM.

Author:
ads

Method Summary
 BpelEntity[] findModelElements(BpelModel model, java.lang.String xpath)
          Returns reference to element in model by xpath expression.
 Activity getParentActivity(BpelEntity entity)
          Returns nearest Activity that enclose this element.
 java.lang.String getXPath(BpelEntity entity)
          Returns XPath expression for OM element.
 java.util.Iterator<BaseScope> scopeIterator(BpelEntity entity)
          Returns iterator that iterate over hierarchical scope parents of current element.
 java.util.Iterator<VariableDeclarationScope> varaibleDeclarationScopes(BpelEntity entity)
          Returns iterator that iterate over hierarchical VariableDeclarationScope parents of current element.
 

Method Detail

getXPath

java.lang.String getXPath(BpelEntity entity)
Returns XPath expression for OM element.

Parameters:
entity - BpelEntity object.
Returns:
xpath for entity.

scopeIterator

java.util.Iterator<BaseScope> scopeIterator(BpelEntity entity)
Returns iterator that iterate over hierarchical scope parents of current element.

Parameters:
entity - BpelEntity object.
Returns:
iterator for iterate through BaseScope .

varaibleDeclarationScopes

java.util.Iterator<VariableDeclarationScope> varaibleDeclarationScopes(BpelEntity entity)
Returns iterator that iterate over hierarchical VariableDeclarationScope parents of current element.

Parameters:
entity - BpelEntity object.
Returns:
iterator for iterate through VariableDeclarationScope .

getParentActivity

Activity getParentActivity(BpelEntity entity)
Returns nearest Activity that enclose this element.

Parameters:
entity - BpelEntity object.
Returns:
nearest parent activity.

findModelElements

BpelEntity[] findModelElements(BpelModel model,
                               java.lang.String xpath)
Returns reference to element in model by xpath expression. Runtime exception can be thrown if xpath is bad XPath expression.

Parameters:
model - model which will be used for search.
xpath - XPath expression.
Returns:
array of found model elements.