org.openscada.opc.lib.da.browser

Class BaseBrowser

java.lang.Object

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

Direct Known Subclasses:

FlatBrowser, TreeBrowser

public class BaseBrowser
extends Object

A class implementing base browsing

Author:

Jens Reimann

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_batchSize The batch size is the number of entries that will be requested with one call from the server.
protected OPCBrowseServerAddressSpace	_browser

Constructor Summary

Constructors

Constructor and Description
BaseBrowser(OPCBrowseServerAddressSpace browser)
BaseBrowser(OPCBrowseServerAddressSpace browser, int batchSize)

Method Summary

Modifier and Type	Method and Description
protected Collection<String>	browse(OPCBROWSETYPE type, String filterCriteria, EnumSet<Access> accessMask, int variantType) Perform the browse operation.
Collection<String>	getAccessPaths(String itemId) Browse the access paths for one item.
int	getBatchSize() Get the batch size
void	setBatchSize(int batchSize) Set the batch size

Methods inherited from class java.lang.Object

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

Field Detail

_browser

protected OPCBrowseServerAddressSpace _browser

_batchSize

protected int _batchSize

The batch size is the number of entries that will be requested with one call from the server. Sometimes too big batch sizes will cause an exception. And smaller batch sizes degrade perfomance. The default is set by EnumString.DEFAULT_BATCH_SIZE and can be overridden by the java property openscada.dcom.enum-batch-size.

Constructor Detail

BaseBrowser

public BaseBrowser(OPCBrowseServerAddressSpace browser)

BaseBrowser

public BaseBrowser(OPCBrowseServerAddressSpace browser,
                   int batchSize)

Method Detail

setBatchSize

public void setBatchSize(int batchSize)

Set the batch size

Parameters:

batchSize - The new batch size

getBatchSize

public int getBatchSize()

Get the batch size

Returns:

the current batch size

browse

protected Collection<String> browse(OPCBROWSETYPE type,
                                    String filterCriteria,
                                    EnumSet<Access> accessMask,
                                    int variantType)
                             throws IllegalArgumentException,
                                    UnknownHostException,
                                    JIException

Perform the browse operation.

Parameters:

type -

filterCriteria -

accessMask -

variantType -

Returns:

The browse result

Throws:

IllegalArgumentException

UnknownHostException

JIException

getAccessPaths

public Collection<String> getAccessPaths(String itemId)
                                  throws IllegalArgumentException,
                                         UnknownHostException,
                                         JIException

Browse the access paths for one item.

Parameters:

itemId - The item ID to look up the access paths

Returns:

The collection of the access paths

Throws:

JIException

UnknownHostException

IllegalArgumentException