Package org.openscada.opc.dcom.da.impl

Class OPCBrowseServerAddressSpace

java.lang.Object

org.openscada.opc.dcom.common.impl.BaseCOMObject

org.openscada.opc.dcom.da.impl.OPCBrowseServerAddressSpace

public class OPCBrowseServerAddressSpace
extends BaseCOMObject

Implementation for IOPCBrowseServerAddressSpace

Author:

Jens Reimann jens.reimann@th4-systems.com

Constructor Summary

Constructors

Constructor	Description
OPCBrowseServerAddressSpace(org.jinterop.dcom.core.IJIComObject opcServer)

Method Summary

Modifier and Type	Method	Description
EnumString	browse(OPCBROWSETYPE browseType, String filterCriteria, int accessRights, int dataType)
EnumString	browseAccessPaths(String itemID)	Return the possible access paths for an item
void	changePosition(String position, OPCBROWSEDIRECTION direction)	Direct the browser to another position
String	getItemID(String item)	Get the complete item id from an item at the local position.
OPCNAMESPACETYPE	queryOrganization()	Get the information how the namespace is organized

Methods inherited from class org.openscada.opc.dcom.common.impl.BaseCOMObject

getCOMObject

Methods inherited from class java.lang.Object

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

Constructor Details

OPCBrowseServerAddressSpace

public OPCBrowseServerAddressSpace(org.jinterop.dcom.core.IJIComObject opcServer)
                            throws IllegalArgumentException,
UnknownHostException,
org.jinterop.dcom.common.JIException

Throws:

IllegalArgumentException

UnknownHostException

org.jinterop.dcom.common.JIException

Method Details

queryOrganization

public OPCNAMESPACETYPE queryOrganization()
                                   throws org.jinterop.dcom.common.JIException

Get the information how the namespace is organized

Returns:

the organization of the namespace

Throws:

org.jinterop.dcom.common.JIException

changePosition

public void changePosition(String position,
 OPCBROWSEDIRECTION direction)
                    throws org.jinterop.dcom.common.JIException

Direct the browser to another position

Depending on the direction the new position will be set based on the provided position information. If the direction is OPCBROWSEDIRECTION.OPC_BROWSE_TO then the position is the item to go to. If the direction is OPCBROWSEDIRECTION.OPC_BROWSE_DOWN the browser will descent into the tree down (not to) the branch item in position. Passing OPCBROWSEDIRECTION.OPC_BROWSE_UP won't need a position (pass null) and will ascent in the tree one level.

Passing OPCBROWSEDIRECTION.OPC_BROWSE_TO and null as position will go to the first root entry of the namespace.

Parameters:

position - The item position reference for the direction

direction - The direction to go based on the position

Throws:

org.jinterop.dcom.common.JIException

browse

public EnumString browse(OPCBROWSETYPE browseType,
 String filterCriteria,
 int accessRights,
 int dataType)
                  throws org.jinterop.dcom.common.JIException,
IllegalArgumentException,
UnknownHostException

Throws:

org.jinterop.dcom.common.JIException

IllegalArgumentException

UnknownHostException

browseAccessPaths

public EnumString browseAccessPaths(String itemID)
                             throws org.jinterop.dcom.common.JIException,
IllegalArgumentException,
UnknownHostException

Return the possible access paths for an item

Parameters:

itemID - the item to query

Returns:

A string enumerator for the possible access paths

Throws:

org.jinterop.dcom.common.JIException

IllegalArgumentException

UnknownHostException

getItemID

public String getItemID(String item)
                 throws org.jinterop.dcom.common.JIException

Get the complete item id from an item at the local position.

Browsing a hierarchical namespace the browse method will return items based on the local level in the namespace. So actually only the last part of the item ID hierarchy is returned. In order to convert this to the full item ID one can use this method. It will only work if the browser is still at the position in question.

Parameters:

item - the local item

Returns:

the complete item ID

Throws:

org.jinterop.dcom.common.JIException