org.openscada.opc.lib.da.browser

Class TreeBrowser

java.lang.Object

org.openscada.opc.lib.da.browser.BaseBrowser

org.openscada.opc.lib.da.browser.TreeBrowser

public class TreeBrowser
extends BaseBrowser

Browse through the hierarchical server namespace.
The operations on the address space browser browser are not synchronized as is the TreeBrowser itself. The user must take care of preventing simultanious access to this instance and the server address space browser.

Author:

Jens Reimann

Field Summary

Fields inherited from class org.openscada.opc.lib.da.browser.BaseBrowser

_batchSize, _browser

Constructor Summary

Constructors

Constructor and Description
TreeBrowser(OPCBrowseServerAddressSpace browser) Browse for all items without search parameters.
TreeBrowser(OPCBrowseServerAddressSpace browser, String filterCriteria, EnumSet<Access> accessMask, int variantType) Browse for items with search parameters.

Method Summary

Modifier and Type	Method and Description
Branch	browse() Browse through all levels of the tree browser.
protected void	browse(Branch branch, boolean leaves, boolean branches, boolean descend)
Branch	browseBranches() Browse the root branch for its sub-branches.
protected void	browseBranches(Branch branch, boolean leaves, boolean descend)
Branch	browseLeaves() Browse the root branch for this leaves.
protected void	browseLeaves(Branch branch) Fill the branch object with the leaves of this currently selected branch.
void	fill(Branch branch) Fill the leaves and branches of the branch provided branches including alls sub-branches.
void	fillBranches(Branch branch) Fill the branch list of the provided branch.
void	fillLeaves(Branch branch) Fill the leaf list of the provided branch.
protected void	moveToBranch(Branch branch) Move the tree browser to a branch
protected void	moveToRoot() Move the tree browser to the root folder

Methods inherited from class org.openscada.opc.lib.da.browser.BaseBrowser

browse, getAccessPaths, getBatchSize, setBatchSize

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeBrowser

public TreeBrowser(OPCBrowseServerAddressSpace browser)

Browse for all items without search parameters.
This will actually call:
TreeBrowser ( browser, "", EnumSet.noneOf ( Access.class ), JIVariant.VT_EMPTY );

Parameters:

browser - The browser to use for browsing

TreeBrowser

public TreeBrowser(OPCBrowseServerAddressSpace browser,
                   String filterCriteria,
                   EnumSet<Access> accessMask,
                   int variantType)

Browse for items with search parameters.

Parameters:

browser - The browser to use

filterCriteria - The filter criteria. It is specific to the server you use.

accessMask - The access mask (use EnumSet.noneOf ( Access.class ) for all)

variantType - The variant type (use JIVariant.VT_EMPTY for all)

Method Detail

moveToRoot

protected void moveToRoot()
                   throws JIException

Move the tree browser to the root folder

Throws:

JIException

moveToBranch

protected void moveToBranch(Branch branch)
                     throws JIException

Move the tree browser to a branch

Parameters:

branch - The branch to move to

Throws:

JIException

browseBranches

public Branch browseBranches()
                      throws JIException,
                             IllegalArgumentException,
                             UnknownHostException

Browse the root branch for its sub-branches.

Returns:

The list of sub branches

Throws:

JIException

IllegalArgumentException

UnknownHostException

browseLeaves

public Branch browseLeaves()
                    throws IllegalArgumentException,
                           UnknownHostException,
                           JIException

Browse the root branch for this leaves.

Returns:

The list of leaves

Throws:

IllegalArgumentException

UnknownHostException

JIException

fillBranches

public void fillBranches(Branch branch)
                  throws JIException,
                         IllegalArgumentException,
                         UnknownHostException

Fill the branch list of the provided branch.

Parameters:

branch - The branch to fill.

Throws:

JIException

IllegalArgumentException

UnknownHostException

fillLeaves

public void fillLeaves(Branch branch)
                throws IllegalArgumentException,
                       UnknownHostException,
                       JIException

Fill the leaf list of the provided branch.

Parameters:

branch - The branch to fill.

Throws:

IllegalArgumentException

UnknownHostException

JIException

browse

public Branch browse()
              throws JIException,
                     IllegalArgumentException,
                     UnknownHostException

Browse through all levels of the tree browser.

Returns:

The whole expanded server address space

Throws:

JIException

IllegalArgumentException

UnknownHostException

fill

public void fill(Branch branch)
          throws IllegalArgumentException,
                 UnknownHostException,
                 JIException

Fill the leaves and branches of the branch provided branches including alls sub-branches.

Parameters:

branch - The branch to fill.

Throws:

IllegalArgumentException

UnknownHostException

JIException

browseLeaves

protected void browseLeaves(Branch branch)
                     throws IllegalArgumentException,
                            UnknownHostException,
                            JIException

Fill the branch object with the leaves of this currently selected branch.
The server object is not located to the branch before browsing!

Parameters:

branch - The branch to fill

Throws:

IllegalArgumentException

UnknownHostException

JIException

browseBranches

protected void browseBranches(Branch branch,
                              boolean leaves,
                              boolean descend)
                       throws IllegalArgumentException,
                              UnknownHostException,
                              JIException

Throws:

IllegalArgumentException

UnknownHostException

JIException

browse

protected void browse(Branch branch,
                      boolean leaves,
                      boolean branches,
                      boolean descend)
               throws IllegalArgumentException,
                      UnknownHostException,
                      JIException

Throws:

IllegalArgumentException

UnknownHostException

JIException