de.desy.tine.queryUtils.TQuery Class Reference

TQuery: Utility with many standard query routines. More...

List of all members.

Static Public Member Functions
static boolean	isStockProperty (String property)
static short	setMaximumQueryBufferSize (int size)
	Sets the maximum size for use in tine queries.
static String[]	getContexts ()
	Returns a list of Contexts (obtained from the name services)
static String[]	getContexts (String serverName)
	Returns a list of Contexts (obtained from the name services) which offer a server with the name specified.
static String[]	getContexts (String serverName, String importance)
	Returns a list of Contexts (obtained from the name services) which offer a server with the name and importance specified.
static String[]	getDeviceServers (String context)
	Returns a list of device servers associated with the specified context (obtained from the name services)
static String[]	getDeviceServers (String context, String subsys)
	Returns a list of device servers associated with the specified context and subsystem (obtained from the name services)
static ServerQuery[]	getDeviceServersEx (String context, String subsys, String importance)
	Returns a list of device servers associated with the specified context, subsystem, and importance level (obtained from the name services)
static ServerQuery[]	getDeviceServersEx (String context, String subsys, String importance, int timeout)
	Returns a list of device servers associated with the specified context, subsystem, and importance level (obtained from the name services)
static String[]	getDeviceSubsystems ()
	Returns a list of registered subsystems (obtained from the name services)
static String[]	getDeviceSubsystems (String context)
	Returns a list of registered subsystems in a given context (obtained from the name services)
static String[]	getServers (String context)
	Returns a list of front end computers (FECs) associated with the specified context (obtained from the name services)
static String[]	getServers (String context, String subsys)
	Returns a list of front end computers (FECs) associated with the specified context and sub system (obtained from the name services)
static ServerQuery[]	getServersEx (String context, String subsys, String importance)
	Returns a list of front end computers (FECs) associated with the specified context, subsystem, and importance level (obtained from the name services)
static ServerQuery[]	getServersEx (String context, String subsys, String importance, int timeout)
	Returns a list of front end computers (FECs) associated with the specified context, subsystem, and importance level (obtained from the name services)
static TClientStruct[]	getServerClients (String fullServerName)
static FECInfo	getServerInformation (String frontEndComputer)
	Retrieves information about the specified front-end computer.
static String[]	getDeviceProperties (String context, String server, String device)
	Returns a list of properties associated with the specified context and device server and device (obtained from the device server)
static String[]	getDeviceProperties (String context, String server, String device, String property)
	Returns a list of properties associated with the specified context and device server, device, and property (sub)string (obtained from the device server)
static String[]	getDeviceProperties (String context, String server, String device, String property, int timeout)
	Returns a list of properties associated with the specified context and device server, device, and property (sub)string (obtained from the device server)
static String[]	getPropertiesWithPattern (String context, String server, String device, String propertyPattern, int timeout) throws IOException
	Returns an array of properties matching the pattern input.
static String	getTineVersion (String context, String server)
	Retrieves the TINE version of the input server.
static String	getAppVersion (String context, String server)
	Retrieves the application version of the input server.
static String	getAppDate (String context, String server)
	Retrieves the application compile date.
static String[]	getStockProperties (String context, String server)
	Returns a list of stock properties associated with the specified context and device server (obtained from the device server).
static String[]	getStockProperties (String context, String server, String device, String property)
	Returns a list of stock properties associated with the specified context and device server, device, and property (sub)string (obtained from the device server).
static String[]	getDeviceNames (String context, String server)
	Returns a list of device names associated with the specified context and device server (obtained from the device server)
static String[]	getDeviceNames (String context, String server, String property)
	Returns a list of device names associated with the specified context, device server and property (obtained from the device server)
static String[]	getDeviceNames (String context, String server, String property, String filter)
	Returns a list of device names associated with the specified context, device server and property (obtained from the device server)
static String[]	getDeviceNames (String context, String server, String property, int timeout)
	Returns a list of device names associated with the specified context, device server and property (obtained from the device server)
static String[]	getDeviceNames (String context, String server, String property, String filter, int timeout)
	Returns a list of device names associated with the specified context, device server and property (obtained from the device server)
static int	getNumberOfDevices (String context, String server, String property, int timeout) throws IOException
	Returns the number of registered devices for the server and context (and property if non null) given.
static int	getNumberOfDevices (String context, String server, String property, String filter, int timeout) throws IOException
	Returns the number of registered devices for the server and context (and property if non null) given.
static PropertyQueryEx[]	getDevicePropertyInformation (String context, String server, String device, String property)
static synchronized PropertyQueryEx[]	getDevicePropertyInformation (String context, String server, String device, String property, int timeout)
static XPropertyQuery[]	getDevicePropertyInformationX (String context, String server, String device, String property)
static XPropertyQuery[]	getDevicePropertyInformationX (String context, String server, String device, String property, int timeout)
static TPropertyQuery[]	getPropertyInformation (String context, String server, String device, String property)
	Returns a list of property query information objects associated with the specified context, device server, device.
static TPropertyQuery[]	getPropertyInformation (String context, String server, String device, String property, int timeout)
	Returns a list of property query information objects associated with the specified context, device server, device.
static int	getNumberOfProperties (String context, String server, int timeout) throws IOException
	Returns the number of registered properties for the give server and context.
static TPropertyQuery[]	getStockPropertyInformation (String context, String server, String device, String property)
	Returns a list of extended property query information objects associated with the specified context, device server, device.
static TPropertyQuery[]	getStockPropertyInformation (String context, String server, String device, String property, int timeout)
	Returns a list of extended property query information objects associated with the specified context, device server, device.
static synchronized XPropertyQuery[]	getStockPropertyInformationX (String context, String server, String device, String property)
static int	setAccessLock (String context, String server, AccessLockType lockType, int lockDuration)
	Establishes an access lock on the device server specified.
static String[]	getAccessLockInformation (String context, String server)
	Retrieves the access lock information on the device server specified.
static void	removeAccessLock (String context, String server)
	Removes an access lock on the server specified.

---

Detailed Description

TQuery: Utility with many standard query routines.

This is a static class which can be used to make system queries without the need for instantiating a TQuery object.

Author:

duval

---

Member Function Documentation

static String [] de.desy.tine.queryUtils.TQuery.getAccessLockInformation	(	String	context,
		String	server
	)		[static]

Retrieves the access lock information on the device server specified.

Parameters:

context	is the context containing the device server
server	is the targeted device server

Returns:

a string array containing the user and address of the owner of the current access lock. If there is no access lock, the strings are empty.

static String de.desy.tine.queryUtils.TQuery.getAppDate	(	String	context,
		String	server
	)		[static]

Retrieves the application compile date.

Parameters:

context	is the desired context
server	is the targeted server

Returns:

the current application compile data of the specified server. If this information is not supplied by the server developer, then "January 1, 1970" will be the likely result.

static String de.desy.tine.queryUtils.TQuery.getAppVersion	(	String	context,
		String	server
	)		[static]

Retrieves the application version of the input server.

Parameters:

context	is the desired context
server	is the targeted server

Returns:

the current application version of the specified server. If this information is not supplied by the server developer, then "1.0.0" will be the likely result.

static String [] de.desy.tine.queryUtils.TQuery.getContexts	(	String	serverName,
		String	importance
	)		[static]

Returns a list of Contexts (obtained from the name services) which offer a server with the name and importance specified.

Parameters:

serverName	is the targeted server name
imporance	is the desired server importance (one of "ALL", "IMPORTANT", "CRITICAL", "ESSENTIAL")

Returns:

A string array containing a list of available contexts which have the named server or a null pointer if the call could not complete successfully. If no contexts were found a string array of zero length is returned.

static String [] de.desy.tine.queryUtils.TQuery.getContexts

(

String

serverName

)

[static]

Returns a list of Contexts (obtained from the name services) which offer a server with the name specified.

Parameters:

serverName

is the targeted server name

Returns:

A string array containing a list of available contexts which have the named server or a null pointer if the call could not complete successfully. If no contexts were found a string array of zero length is returned.

static String [] de.desy.tine.queryUtils.TQuery.getContexts

(

)

[static]

Returns a list of Contexts (obtained from the name services)

Returns:

A string array containing a list of available contexts as obtained from the Equipment Name Server (ENS) or a null pointer if the call could not complete successfully. If no contexts were found a string array of zero length is returned.

static String [] de.desy.tine.queryUtils.TQuery.getDeviceNames	(	String	context,
		String	server
	)		[static]

Returns a list of device names associated with the specified context and device server (obtained from the device server)

As the call is directed to the device server, it assumes the return list applies to all properties

Parameters:

context	Is the context of the device server for which the property list is desired.
server	Is the device server for which the property list is desired.

Returns:

A string array containing a list of devices as obtained from the given device server. A null pointer is returned if the call fails for any reason.

static String [] de.desy.tine.queryUtils.TQuery.getDeviceNames	(	String	context,
		String	server,
		String	property
	)		[static]

Returns a list of device names associated with the specified context, device server and property (obtained from the device server)

Parameters:

context	Is the context of the device server for which the device list is desired.
server	Is the device server for which the device list is desired.
property	Is the property for which the device list is desired.

Returns:

A string array containing a list of devices as obtained from the given device server A null pointer is returned if the call fails for any reason.

static String [] de.desy.tine.queryUtils.TQuery.getDeviceNames	(	String	context,
		String	server,
		String	property,
		String	filter
	)		[static]

Returns a list of device names associated with the specified context, device server and property (obtained from the device server)

Parameters:

context	Is the context of the device server for which the device list is desired.
server	Is the device server for which the device list is desired.
property	Is the property for which the device list is desired.
filter	is a device name filter containing the wildcard character '*'

Returns:

A string array containing a list of devices as obtained from the given device server A null pointer is returned if the call fails for any reason.

static String [] de.desy.tine.queryUtils.TQuery.getDeviceNames	(	String	context,
		String	server,
		String	property,
		int	timeout
	)		[static]

Returns a list of device names associated with the specified context, device server and property (obtained from the device server)

Parameters:

context	is the context of the device server for which the device list is desired.
server	is the device server for which the device list is desired.
property	is the property for which the device list is desired.
timeout	is the time in milliseconds to wait for the call to complete

Returns:

A string array containing a list of devices as obtained from the given device server A null pointer is returned if the call fails for any reason.

static String [] de.desy.tine.queryUtils.TQuery.getDeviceNames	(	String	context,
		String	server,
		String	property,
		String	filter,
		int	timeout
	)		[static]

Returns a list of device names associated with the specified context, device server and property (obtained from the device server)

Parameters:

context	is the context of the device server for which the device list is desired.
server	is the device server for which the device list is desired.
property	is the property for which the device list is desired.
filter	is a device name filter containing the wildcard character '*'
timeout	is the time in milliseconds to wait for the call to complete

Returns:

A string array containing a list of devices as obtained from the given device server A null pointer is returned if the call fails for any reason.

static String [] de.desy.tine.queryUtils.TQuery.getDeviceProperties	(	String	context,
		String	server,
		String	device
	)		[static]

Returns a list of properties associated with the specified context and device server and device (obtained from the device server)

Parameters:

context	Is the context of the device server for which the property list is desired.
server	Is the device server for which the property list is desired.
device	Is the device name (module name) for which the property list is desired.

Returns:

A string array containing a list of properties as obtained from the given device server

static String [] de.desy.tine.queryUtils.TQuery.getDeviceProperties	(	String	context,
		String	server,
		String	device,
		String	property
	)		[static]

Returns a list of properties associated with the specified context and device server, device, and property (sub)string (obtained from the device server)

Parameters:

context	Is the context of the device server for which the property list is desired.
server	Is the device server for which the property list is desired.
device	Is the device name (module name) for which the property list is desired.
property	Can be a queriable string with wildcard parameter '*'. e.g. property = 'P*' will return all properties whose first letter begins with 'P'.

Returns:

A string array containing a list of properties as obtained from the given device server A null pointer is returned if the call fails for any reason.

static String [] de.desy.tine.queryUtils.TQuery.getDeviceProperties	(	String	context,
		String	server,
		String	device,
		String	property,
		int	timeout
	)		[static]

Returns a list of properties associated with the specified context and device server, device, and property (sub)string (obtained from the device server)

Parameters:

context	Is the context of the device server for which the property list is desired.
server	Is the device server for which the property list is desired.
device	Is the device name (module name) for which the property list is desired.
property	Can be a queriable string with wildcard parameter '*'. e.g. property = 'P*' will return all properties whose first letter begins with 'P'.
timeout	is the time in milliseconds to allow the call to complete

Returns:

A string array containing a list of properties as obtained from the given device server A null pointer is returned if the call fails for any reason.

static synchronized PropertyQueryEx [] de.desy.tine.queryUtils.TQuery.getDevicePropertyInformation	(	String	context,
		String	server,
		String	device,
		String	property,
		int	timeout
	)		[static]

Deprecated:

See also:

getPropertyInformation

static PropertyQueryEx [] de.desy.tine.queryUtils.TQuery.getDevicePropertyInformation	(	String	context,
		String	server,
		String	device,
		String	property
	)		[static]

Deprecated:

See also:

getPropertyInformation

Returns a list of extended property query information objects associated with the specified context, device server, device. and target property (obtained from the device server).

Usually a call to getDeviceProperties() returns a property list A secondary call to getDevicePropertyInformation() returns a list of all property information pertaining to the specified property including all property overloads (maximum 10). If 'property' is null then the call returns information for the first 10 items.

Parameters:

context	Is the context of the device server for which the property information is desired.
server	Is the device server for which the property information is desired.
device	Is the device name (module name) for which the property information is desired.
property	Is the property for which the property information is desired.

Returns:

An array of PropertyQueryEx (extended Property Query) objects, as obtained from the given device server

static XPropertyQuery [] de.desy.tine.queryUtils.TQuery.getDevicePropertyInformationX	(	String	context,
		String	server,
		String	device,
		String	property
	)		[static]

Deprecated:

See also:

getPropertyInformation

Returns a list of extended property query information objects associated with the specified context, device server, device. and target property (obtained from the device server).

Usually a call to getDeviceProperties() returns a property list A secondary call to getDevicePropertyInformationX() returns a list of all property information pertaining to the specified property including all property overloads (maximum 10). If 'property' is null then the call returns information for the first 10 items. This is an extended method call which returns information as to the array 'type' if the property returns an array, as well as the horizontal axis engineering units and range if the property returns a spectrum and the row size and number or rows if the property returns a double array (matrix).

Parameters:

context	Is the context of the device server for which the property information is desired.
server	Is the device server for which the property information is desired.
device	Is the device name (module name) for which the property information is desired.
property	Is the property for which the property information is desired.

Returns:

An array of XPropertyQuery (extended Property Query) objects, as obtained from the given device server

static XPropertyQuery [] de.desy.tine.queryUtils.TQuery.getDevicePropertyInformationX	(	String	context,
		String	server,
		String	device,
		String	property,
		int	timeout
	)		[static]

Deprecated:

See also:

getPropertyInformation

static String [] de.desy.tine.queryUtils.TQuery.getDeviceServers	(	String	context,
		String	subsys
	)		[static]

Returns a list of device servers associated with the specified context and subsystem (obtained from the name services)

Parameters:

context	Is the context for which the device server name list is desired
subsys	Is the subsystem for which the device server name list is desired

Returns:

A string array containing a list of device servers associated with the given context and subsystem as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

static String [] de.desy.tine.queryUtils.TQuery.getDeviceServers

(

String

context

)

[static]

Returns a list of device servers associated with the specified context (obtained from the name services)

Parameters:

context

Is the context for which the device server name list is desired

Returns:

A string array containing a list of device servers associated with the given context as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

static ServerQuery [] de.desy.tine.queryUtils.TQuery.getDeviceServersEx	(	String	context,
		String	subsys,
		String	importance
	)		[static]

Returns a list of device servers associated with the specified context, subsystem, and importance level (obtained from the name services)

Parameters:

context	Is the context for which the device server name list is desired
subsys	Is the subsystem for which the device server name list is desired
imporance	Is the importance level for which the device server name list is desired (one of "ALL", "IMPORTANT", "ESSENTIAL", or "CRITICAL")

Returns:

A ServerQuery array containing a list of device servers associated with the given context, subsystem, and importance as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

static ServerQuery [] de.desy.tine.queryUtils.TQuery.getDeviceServersEx	(	String	context,
		String	subsys,
		String	importance,
		int	timeout
	)		[static]

Returns a list of device servers associated with the specified context, subsystem, and importance level (obtained from the name services)

Parameters:

context	Is the context for which the device server name list is desired
subsys	Is the subsystem for which the device server name list is desired
imporance	Is the importance level for which the device server name list is desired (one of "ALL", "IMPORTANT", "ESSENTIAL", or "CRITICAL")
timeout	is the time in milliseconds to wait for the call to complete

Returns:

A ServerQuery array containing a list of device servers associated with the given context, subsystem, and importance as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

static String [] de.desy.tine.queryUtils.TQuery.getDeviceSubsystems

(

)

[static]

Returns a list of registered subsystems (obtained from the name services)

Returns:

A string array containing a list of subsystems. The subsystem is itself not part of the TINE name space, but can be used to refine queries to the Equipment Name Servers (ENS). A null pointer is returned if the call fails for any reason.

static String [] de.desy.tine.queryUtils.TQuery.getDeviceSubsystems

(

String

context

)

[static]

Returns a list of registered subsystems in a given context (obtained from the name services)

Parameters:

context

Is the context for which the subsystem list is desired

Returns:

A string array containing a list of available subsystems in the given context. The subsystem is itself not part of the name space, but can be used to refine queries to the Equipment Name Servers (ENS). A null pointer is returned if the call fails for any reason.

static int de.desy.tine.queryUtils.TQuery.getNumberOfDevices	(	String	context,
		String	server,
		String	property,
		int	timeout
	)		throws IOException [static]

Returns the number of registered devices for the server and context (and property if non null) given.

Parameters:

context	is the requested context
server	is the requested device server
property	is the desired property (if null or an empty string) the call returns the number of registered devices, else it returns the number of property-specific devices.
timeout	in milliseconds

Returns:

the number of devices

Exceptions:

IOException

static int de.desy.tine.queryUtils.TQuery.getNumberOfDevices	(	String	context,
		String	server,
		String	property,
		String	filter,
		int	timeout
	)		throws IOException [static]

Returns the number of registered devices for the server and context (and property if non null) given.

Parameters:

context	is the requested context
server	is the requested device server
property	is the desired property (if null or an empty string) the call returns the number of registered devices, else it returns the number of property-specific devices.
filter	is a device name filter containing a wildcard character '*'
timeout	in milliseconds

Returns:

the number of devices

Exceptions:

IOException

static int de.desy.tine.queryUtils.TQuery.getNumberOfProperties	(	String	context,
		String	server,
		int	timeout
	)		throws IOException [static]

Returns the number of registered properties for the give server and context.

Parameters:

context	is the requested context
server	is the requested device server
timeout	in milliseconds

Returns:

the number of properties

Exceptions:

IOException

static String [] de.desy.tine.queryUtils.TQuery.getPropertiesWithPattern	(	String	context,
		String	server,
		String	device,
		String	propertyPattern,
		int	timeout
	)		throws IOException [static]

Returns an array of properties matching the pattern input.

Parameters:

context	is the desired server context
server	is the targeted device server
device	is the targeted device name
propertyPattern	is the property pattern (using the wild card character '*') for which a match is desired.
timeout	is the time in milliseconds to allow the call to complete.

Returns:

a string array containing those properties which match the pattern given.

Exceptions:

IOException

static TPropertyQuery [] de.desy.tine.queryUtils.TQuery.getPropertyInformation	(	String	context,
		String	server,
		String	device,
		String	property
	)		[static]

Returns a list of property query information objects associated with the specified context, device server, device.

and target property (obtained from the device server).

Usually a call to getDeviceProperties() returns a property list A secondary call to getPropertyInformation() returns a list of all property information pertaining to the specified property including all property overloads (maximum 10). If 'property' is null then the call returns information for the first 10 items. This is an extended method call which returns information as to the array 'type' if the property returns an array, as well as the horizontal axis engineering units and range if the property returns a spectrum and the row size and number or rows if the property returns a double array (matrix).

Parameters:

context	is the context of the device server for which the property information is desired.
server	is the device server for which the property information is desired.
device	is the device name (module name) for which the property information is desired.
property	is the property for which the property information is desired.

Returns:

An array of TPropertyQuery objects, as obtained from the given device server A null pointer is returned if the call fails for any reason.

static TPropertyQuery [] de.desy.tine.queryUtils.TQuery.getPropertyInformation	(	String	context,
		String	server,
		String	device,
		String	property,
		int	timeout
	)		[static]

Returns a list of property query information objects associated with the specified context, device server, device.

and target property (obtained from the device server).

Usually a call to getDeviceProperties() returns a property list A secondary call to getPropertyInformation() returns a list of all property information pertaining to the specified property including all property overloads (maximum 10). If 'property' is null then the call returns information for the first 10 items. This is an extended method call which returns information as to the array 'type' if the property returns an array, as well as the horizontal axis engineering units and range if the property returns a spectrum and the row size and number or rows if the property returns a double array (matrix).

Parameters:

context	is the context of the device server for which the property information is desired.
server	is the device server for which the property information is desired.
device	is the device name (module name) for which the property information is desired.
property	Is the property for which the property information is desired.
timeout	is the time in milliseconds to wait for the call to complete

Returns:

An array of TPropertyQuery objects, as obtained from the given device server. A null pointer is returned if the call fails for any reason.

static TClientStruct [] de.desy.tine.queryUtils.TQuery.getServerClients

(

String

fullServerName

)

[static]

Parameters:

fullServerName

is the fully specified device server for which the information is requested (/<context>/<server>).

Returns:

an array of TClientStruct objects containing information about each of the clients attached to the targeted server. Returns null if the information cannot be obtained.

static FECInfo de.desy.tine.queryUtils.TQuery.getServerInformation

(

String

frontEndComputer

)

[static]

Retrieves information about the specified front-end computer.

Parameters:

frontEndComputer

Returns:

a FECInfo object containing the front end computer information. If the information cannot be obtained for what ever reason, the FECInfo object will contain nothing but "unknown" strings.

static String [] de.desy.tine.queryUtils.TQuery.getServers

(

String

context

)

[static]

Returns a list of front end computers (FECs) associated with the specified context (obtained from the name services)

Parameters:

context

Is the context for which the FEC name list is desired

Returns:

A string array containing a list of front end computers associated with the given context as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

static String [] de.desy.tine.queryUtils.TQuery.getServers	(	String	context,
		String	subsys
	)		[static]

Returns a list of front end computers (FECs) associated with the specified context and sub system (obtained from the name services)

Parameters:

context	Is the context for which the FEC name list is desired
subsys	Is the subsystem for which the device server name list is desired

Returns:

A string array containing a list of front end computers associated with the given context and subsystem as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

static ServerQuery [] de.desy.tine.queryUtils.TQuery.getServersEx	(	String	context,
		String	subsys,
		String	importance
	)		[static]

Returns a list of front end computers (FECs) associated with the specified context, subsystem, and importance level (obtained from the name services)

Parameters:

context	Is the context for which the device server name list is desired
subsys	Is the subsystem for which the device server name list is desired
imporance	Is the importance level for which the device server name list is desired (one of "ALL", "IMPORTANT", "ESSENTIAL", or "CRITICAL")

Returns:

A ServerQuery array containing a list of device servers associated with the given context, subsystem, and importance as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

static ServerQuery [] de.desy.tine.queryUtils.TQuery.getServersEx	(	String	context,
		String	subsys,
		String	importance,
		int	timeout
	)		[static]

Returns a list of front end computers (FECs) associated with the specified context, subsystem, and importance level (obtained from the name services)

Parameters:

context	Is the context for which the device server name list is desired
subsys	Is the subsystem for which the device server name list is desired
imporance	Is the importance level for which the device server name list is desired (one of "ALL", "IMPORTANT", "ESSENTIAL", or "CRITICAL")
timeout	is the time in milliseconds to wait for completion.

Returns:

A ServerQuery array containing a list of device servers associated with the given context, subsystem, and importance as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

static String [] de.desy.tine.queryUtils.TQuery.getStockProperties	(	String	context,
		String	server,
		String	device,
		String	property
	)		[static]

Returns a list of stock properties associated with the specified context and device server, device, and property (sub)string (obtained from the device server).

Typically, the device parameter does not play a role in this query.

Parameters:

context	Is the context of the device server for which the property list is desired.
server	Is the device server for which the property list is desired.
device	Is the device name (module name) for which the property list is desired.
property	Can be a queriable string with wildcard parameter '*'. e.g. property = 'P*' will return all stock properties whose first letter begins with 'P'.

Returns:

A string array containing a list of stock properties as obtained from the given device server

static String [] de.desy.tine.queryUtils.TQuery.getStockProperties	(	String	context,
		String	server
	)		[static]

Returns a list of stock properties associated with the specified context and device server (obtained from the device server).

Parameters:

context	Is the context of the device server for which the property list is desired.
server	Is the device server for which the property list is desired.

Returns:

A string array containing a list of stock properties as obtained from the given device server

static TPropertyQuery [] de.desy.tine.queryUtils.TQuery.getStockPropertyInformation	(	String	context,
		String	server,
		String	device,
		String	property
	)		[static]

Returns a list of extended property query information objects associated with the specified context, device server, device.

and target property (obtained from the device server). Typically, the device name is ignored in this query.

Usually a call to getStockProperties() returns a property list A secondary call to getStockPropertyInformationX() returns a list of all property information pertaining to the specified property including all property overloads (maximum 10). If 'property' is null then the call returns information for the first 10 items. This is an extended method call which returns information as to the array 'type' if the property returns an array, as well as the horizontal axis engineering units and range if the property returns a spectrum and the row size and number or rows if the property returns a double array (matrix).

Parameters:

context	Is the context of the device server for which the property information is desired.
server	Is the device server for which the property information is desired.
device	Is the device name (module name) for which the property information is desired.
property	Is the property for which the property information is desired.

Returns:

An array of XPropertyQuery (extended Property Query) objects, as obtained from the given device server A null pointer is returned if the call fails for any reason.

static TPropertyQuery [] de.desy.tine.queryUtils.TQuery.getStockPropertyInformation	(	String	context,
		String	server,
		String	device,
		String	property,
		int	timeout
	)		[static]

Returns a list of extended property query information objects associated with the specified context, device server, device.

and target property (obtained from the device server). Typically, the device name is ignored in this query.

Usually a call to getStockProperties() returns a property list A secondary call to getStockPropertyInformationX() returns a list of all property information pertaining to the specified property including all property overloads (maximum 10). If 'property' is null then the call returns information for the first 10 items. This is an extended method call which returns information as to the array 'type' if the property returns an array, as well as the horizontal axis engineering units and range if the property returns a spectrum and the row size and number or rows if the property returns a double array (matrix).

Parameters:

context	is the context of the device server for which the property information is desired.
server	is the device server for which the property information is desired.
device	is the device name (module name) for which the property information is desired.
property	is the property for which the property information is desired.
timeout	is the amount of time in milliseconds to wait for the call to complete

Returns:

An array of XPropertyQuery (extended Property Query) objects, as obtained from the given device server A null pointer is returned if the call fails for any reason.

static synchronized XPropertyQuery [] de.desy.tine.queryUtils.TQuery.getStockPropertyInformationX	(	String	context,
		String	server,
		String	device,
		String	property
	)		[static]

Deprecated:

See also:

getStockPropertyInformation

static String de.desy.tine.queryUtils.TQuery.getTineVersion	(	String	context,
		String	server
	)		[static]

Retrieves the TINE version of the input server.

Parameters:

context	is the desired context
server	is the targeted server

Returns:

the current TINE version of the specified server

static boolean de.desy.tine.queryUtils.TQuery.isStockProperty

(

String

property

)

[static]

Parameters:

property

is the targeted property

Returns:

true if the input property represents a stock property of the server

static void de.desy.tine.queryUtils.TQuery.removeAccessLock	(	String	context,
		String	server
	)		[static]

Removes an access lock on the server specified.

Parameters:

context	is the targeted context of the server
server	is the targeted device server

Returns:

a tine return code

static int de.desy.tine.queryUtils.TQuery.setAccessLock	(	String	context,
		String	server,
		AccessLockType	lockType,
		int	lockDuration
	)		[static]

Establishes an access lock on the device server specified.

Parameters:

context	is the context containing the device server
server	is the targeted device server
lockType	is the lock type requested
lockDuration	is the duration of the access lock (in seconds)

Returns:

0 upon success or a TINE error code.

static short de.desy.tine.queryUtils.TQuery.setMaximumQueryBufferSize

(

int

size

)

[static]

Sets the maximum size for use in tine queries.

Parameters:

size	is the size in bytes of the buffer used to hold the query information (65000 bytes is the default)

Returns:

0 if successful

---

The documentation for this class was generated from the following file:

• TQuery.java