org.diirt.support.ca

Class JCADataSourceConfiguration

java.lang.Object

org.diirt.datasource.DataSourceConfiguration<JCADataSource>

org.diirt.support.ca.JCADataSourceConfiguration

public final class JCADataSourceConfiguration
extends DataSourceConfiguration<JCADataSource>

Configuration for JCADataSource. This object is mutable and not thread-safe.

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
JCADataSourceConfiguration()

Method Summary

Modifier and Type	Method and Description
JCADataSourceConfiguration	addContextProperty(String name, String value) Adds a new property that is passed directly to the JCALibrary when creating the context.
JCADataSource	create() Creates a new JCADataSource with the current configuration.
JCADataSourceConfiguration	dbePropertySupported(boolean dbePropertySupported) Whether a separate monitor should be used for listening to metadata changes.
JCADataSourceConfiguration	honorZeroPrecision(boolean honorZeroPrecision) If true, the formatter returned by the VType will show no decimal digits (assumes it was configured); if false, it will return all the digit (assumes it wasn't configured).
JCADataSourceConfiguration	jcaContext(gov.aps.jca.Context jcaContext) The jca context to use.
JCADataSourceConfiguration	jcaContextClass(String className) The class name for the implementation of JCA.
JCADataSourceConfiguration	monitorMask(int monitorMask) The mask used for the monitor notifications.
JCADataSourceConfiguration	read(InputStream input) Reads the configuration from the given stream and returns an object with the new configuration.
JCADataSourceConfiguration	rtypValueOnly(boolean rtypValueOnly) If true, for fields that match ".*\.RTYP.*" only the value will be read; alarm and time will be created at client side.
JCADataSourceConfiguration	typeSupport(JCATypeSupport typeSupport) Changes the way JCA DBR types are mapped to types supported in pvamanger.
JCADataSourceConfiguration	varArraySupported(boolean varArraySupported) If true, monitors will setup using "0" length, which will make the server a variable length array in return (if supported) or a "0" length array (if not supported).

Methods inherited from class java.lang.Object

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

Constructor Detail

JCADataSourceConfiguration

public JCADataSourceConfiguration()

Method Detail

read

public JCADataSourceConfiguration read(InputStream input)

Description copied from class: DataSourceConfiguration

Reads the configuration from the given stream and returns an object with the new configuration.

NOTE: whether this object is modified and returned, or a new object is returned, is currently unspecified.

Specified by:

read in class DataSourceConfiguration<JCADataSource>

Parameters:

input - the configuration file to be read

Returns:

the object with the new configuration

jcaContextClass

public JCADataSourceConfiguration jcaContextClass(String className)

The class name for the implementation of JCA.

Default is JCALibrary.CHANNEL_ACCESS_JAVA.

Parameters:

className - the class name of the jca implementation

Returns:

this

jcaContext

public JCADataSourceConfiguration jcaContext(gov.aps.jca.Context jcaContext)

The jca context to use. This allows complete customization of the jca context.

By default, will be automatically created from the jcaContextClass(java.lang.String).

Parameters:

jcaContext - the context

Returns:

this

monitorMask

public JCADataSourceConfiguration monitorMask(int monitorMask)

The mask used for the monitor notifications. This should be a combination of Monitor.VALUE, Monitor.ALARM, ...

Default is Monitor.VALUE | Monitor.ALARM .

Parameters:

monitorMask - the monitor mask

Returns:

this

typeSupport

public JCADataSourceConfiguration typeSupport(JCATypeSupport typeSupport)

Changes the way JCA DBR types are mapped to types supported in pvamanger.

Default includes support for the VTypes (i.e. JCAVTypeAdapterSet).

Parameters:

typeSupport - the custom type support

Returns:

this

dbePropertySupported

public JCADataSourceConfiguration dbePropertySupported(boolean dbePropertySupported)

Whether a separate monitor should be used for listening to metadata changes.

Default is false.

Parameters:

dbePropertySupported - if true, metadata changes will trigger notification

Returns:

this

varArraySupported

public JCADataSourceConfiguration varArraySupported(boolean varArraySupported)

If true, monitors will setup using "0" length, which will make the server a variable length array in return (if supported) or a "0" length array (if not supported). Variable array support was added to EPICS 3.14.12.2 and to CAJ 1.1.10.

By default it tries to auto-detected whether the client library implements the proper checks.

Parameters:

varArraySupported - true will enable

Returns:

this

rtypValueOnly

public JCADataSourceConfiguration rtypValueOnly(boolean rtypValueOnly)

If true, for fields that match ".*\.RTYP.*" only the value will be read; alarm and time will be created at client side. Version of EPICS before 3.14.11 do not send correct data (would send only the value), which would make the client behave incorrectly.

Default is false.

Parameters:

rtypValueOnly - true will enable

Returns:

this

honorZeroPrecision

public JCADataSourceConfiguration honorZeroPrecision(boolean honorZeroPrecision)

If true, the formatter returned by the VType will show no decimal digits (assumes it was configured); if false, it will return all the digit (assumes it wasn't configured).

Default is true.

Parameters:

honorZeroPrecision - whether the formatter should treat 0 precision as meaningful

Returns:

this

addContextProperty

public JCADataSourceConfiguration addContextProperty(String name,
                                                     String value)

Adds a new property that is passed directly to the JCALibrary when creating the context.

Parameters:

name - the name of the property

value - the value of the property

Returns:

this

create

public JCADataSource create()

Creates a new JCADataSource with the current configuration.

Specified by:

create in class DataSourceConfiguration<JCADataSource>

Returns:

a new data source