org.epics.pvmanager.jca

Class JCADataSourceBuilder

java.lang.Object

org.epics.pvmanager.jca.JCADataSourceBuilder

public class JCADataSourceBuilder
extends Object

Builder for JCADataSource. Given the moderate number of configuration parameters, the builder allows to set only the ones the user needs to set.

Refer to each parameter for their meaning and default.

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
JCADataSourceBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
JCADataSource	build() Creates a new data source.
JCADataSourceBuilder	dbePropertySupported(boolean dbePropertySupported) Whether a separate monitor should be used for listening to metadata changes.
JCADataSourceBuilder	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).
JCADataSourceBuilder	jcaContext(gov.aps.jca.Context jcaContext) The jca context to use.
JCADataSourceBuilder	jcaContextClass(String className) The class name for the implementation of JCA.
JCADataSourceBuilder	monitorMask(int monitorMask) The mask used for the monitor notifications.
JCADataSourceBuilder	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.
JCADataSourceBuilder	typeSupport(JCATypeSupport typeSupport) Changes the way JCA DBR types are mapped to types supported in pvamanger.
JCADataSourceBuilder	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

JCADataSourceBuilder

public JCADataSourceBuilder()

Method Detail

jcaContextClass

public JCADataSourceBuilder 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 JCADataSourceBuilder 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 JCADataSourceBuilder 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 JCADataSourceBuilder 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 JCADataSourceBuilder 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 JCADataSourceBuilder 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 JCADataSourceBuilder 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 JCADataSourceBuilder 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

build

public JCADataSource build()

Creates a new data source.

Returns:

a new data source