Package com.inductiveautomation.factorypmi.application.binding.util

Class BindUtilities

java.lang.Object

com.inductiveautomation.factorypmi.application.binding.util.BindUtilities

public class BindUtilities
extends Object

Contains various static functions used to create bindings

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLOSE_DELIM
static final String	OPEN_DELIM
static final String	RELPATH_PARENT
static final String	RELPATH_SOURCE

Constructor Summary

Constructors

Constructor	Description
BindUtilities()

Method Summary

Modifier and Type	Method	Description
static void	addAllInteractions(Expression e, List<InteractionDescriptor> list)
static void	connectBindings(BindingRoot window, TagManager manager, Expression expr, Adapter adapter, InteractionListener interactionListener)	Recursively goes through the given expression, connecting all BoundVariableExpressions up with PropertyListenerDescriptors.
static QueryHolder	createQueryHolder(String query, TagManager manager, BindingRoot selectedWindow, PropertyAdapter adapter, String thisPath)
static QueryHolder	createQueryHolderForTagBinding(String query, TagManager manager, TagPath localPath)
static BoundValueHolder	createValueHolder(String expression, TagManager manager, BindingRoot selectedWindow, PropertyAdapter adapter, String thisPath)
static TagPath	derelativezie(TagPath tagPath, TagPath parentPath)	Deprecated.
static List<PropertyNode>	getAllProperties(Object o)
static List<PropertyNode>	getBoundProperties(Object o)
static Object	getCurrentValue(PropertyNode property)	Deprecated. Use PropertyNode.getQValue().getValue() instead
static FeatureDescriptor	getFeatureDescriptor(Component parent, String propName)	Returns the FeatureDescriptor for the given property name on the given component or null if the property is not found.
static PropertyListenerDescriptor	getPLDForPath(BindingRoot selectedWindow, String path)	Creates a new PropertyListenerDescriptor for the given path.
static PropertyNode	getPropertyNode(Component parent, FeatureDescriptor fd)	Returns a PropertyNode (Dynamic or Static) for the given feature descriptor on the given component
static PropertyNode	getPropertyNode(Component source, String propName, boolean onlyBindable)	Finds the PropertyNode for the given component+name.
static PropertyNode	getPropertyNodeForPath(BindingRoot window, String path, boolean onlyBindable)	For the given path (with or without path delimiters { and }) in the given window, returns the PropertyNode.
static PropertyNode	getPropertyNodeForRelativePath(JComponent relativeTo, String path, boolean onlyBindable)
static Class	getPropertyType(FeatureDescriptor fd)
static QualifiedValue	getQValue(Component component, FeatureDescriptor property)
static boolean	isBound(String s)
static boolean	isBound(JComponent component, String propertyName)	Checks to see if the property of the given component is bound or not.
static boolean	isDBBound(JComponent component, String propertyName)	Checks to see if the property of the given component has a database binding.
static boolean	isPath(String s)	Returns true if the string seems to be a path (absolute OR relative).
static boolean	isPropertyBindable(FeatureDescriptor fd)
static boolean	isPropertyDefined(BindingRoot window, String path)
static boolean	isRelativePath(String s)	Matches something like "{$...}"
static void	main(String[] args)
static ExpressionParseContext	newBinder(BindingRoot selectedWindow, TagManager tagManager, TagPath localPath, FunctionFactory funcFactory)
static void	pullCurrentValues(PropertyAdapter adapter)

Methods inherited from class java.lang.Object

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

Field Details

OPEN_DELIM

public static final String OPEN_DELIM

See Also:

• Constant Field Values

CLOSE_DELIM

public static final String CLOSE_DELIM

See Also:

• Constant Field Values

RELPATH_SOURCE

public static final String RELPATH_SOURCE

See Also:

• Constant Field Values

RELPATH_PARENT

public static final String RELPATH_PARENT

See Also:

• Constant Field Values

Constructor Details

BindUtilities

public BindUtilities()

Method Details

addAllInteractions

public static void addAllInteractions(Expression e,
 List<InteractionDescriptor> list)

getPropertyType

public static Class getPropertyType(FeatureDescriptor fd)

isBound

public static boolean isBound(JComponent component,
 String propertyName)

Checks to see if the property of the given component is bound or not.

isBound

public static boolean isBound(String s)

isDBBound

public static boolean isDBBound(@Nonnull
 JComponent component,
 @Nonnull
 String propertyName)

Checks to see if the property of the given component has a database binding. Used by Edge to check if db binding should show for a component.

derelativezie

@Deprecated
public static TagPath derelativezie(TagPath tagPath,
 TagPath parentPath)
                             throws RuntimeException

Deprecated.

Use TagPathParserderelativezie(TagPath, TagPath) instead (this calls through to that).

Throws:

RuntimeException

newBinder

public static ExpressionParseContext newBinder(BindingRoot selectedWindow,
 TagManager tagManager,
 TagPath localPath,
 FunctionFactory funcFactory)

getPLDForPath

public static PropertyListenerDescriptor getPLDForPath(BindingRoot selectedWindow,
 String path)
                                                throws Exception

Creates a new PropertyListenerDescriptor for the given path. Only the initial value, source component, and source property will be configured on the PLD

Throws:

Exception - if it can't pull the current value for the property.

connectBindings

public static void connectBindings(BindingRoot window,
 TagManager manager,
 Expression expr,
 Adapter adapter,
 InteractionListener interactionListener)
                            throws RuntimeException

Recursively goes through the given expression, connecting all BoundVariableExpressions up with PropertyListenerDescriptors. Multiple BVEs that share the same path will share one PLD, so that an expression isn't re-evaluated multiple times for one property change event from component.

Throws:

RuntimeException

createQueryHolderForTagBinding

public static QueryHolder createQueryHolderForTagBinding(String query,
 TagManager manager,
 TagPath localPath)
                                                  throws Exception

Throws:

Exception

createQueryHolder

public static QueryHolder createQueryHolder(String query,
 TagManager manager,
 BindingRoot selectedWindow,
 PropertyAdapter adapter,
 String thisPath)
                                     throws Exception

Throws:

Exception

createValueHolder

public static BoundValueHolder createValueHolder(String expression,
 TagManager manager,
 BindingRoot selectedWindow,
 PropertyAdapter adapter,
 String thisPath)
                                          throws Exception

Throws:

Exception

getBoundProperties

public static List<PropertyNode> getBoundProperties(Object o)

getAllProperties

public static List<PropertyNode> getAllProperties(Object o)

isPropertyBindable

public static boolean isPropertyBindable(FeatureDescriptor fd)

main

public static void main(String[] args)

isPropertyDefined

public static boolean isPropertyDefined(BindingRoot window,
 String path)

isPath

public static boolean isPath(String s)

Returns true if the string seems to be a path (absolute OR relative). Simply checks if the string starts with { and ends with }

isRelativePath

public static boolean isRelativePath(String s)

Matches something like "{$...}"

getPropertyNodeForPath

public static PropertyNode getPropertyNodeForPath(BindingRoot window,
 String path,
 boolean onlyBindable)
                                           throws RuntimeException

For the given path (with or without path delimiters { and }) in the given window, returns the PropertyNode.

Parameters:

window - The window in which the path resides. Throws a RuntimeException if the path isn't valid.

path - The path to the property

onlyBindable - If true, only bindable properties will be considered

Throws:

RuntimeException

getPropertyNodeForRelativePath

public static PropertyNode getPropertyNodeForRelativePath(JComponent relativeTo,
 String path,
 boolean onlyBindable)
                                                   throws RuntimeException

Throws:

RuntimeException

getPropertyNode

public static PropertyNode getPropertyNode(Component source,
 String propName,
 boolean onlyBindable)
                                    throws RuntimeException

Finds the PropertyNode for the given component+name. If the property doesn't exist, a RuntimeException is thrown.

Parameters:

source - The component to look for the property on.

propName - The name of the property. Can be in the format "name:path.to.subprop" for UDT sub-properties.

onlyBindable - If true, only bindable properties will be accepted.

Throws:

RuntimeException

getCurrentValue

@Deprecated
public static Object getCurrentValue(PropertyNode property)
                              throws Exception

Deprecated.

Use PropertyNode.getQValue().getValue() instead

Throws:

Exception

getQValue

public static QualifiedValue getQValue(Component component,
 FeatureDescriptor property)
                                throws Exception

Throws:

Exception

pullCurrentValues

public static void pullCurrentValues(PropertyAdapter adapter)

getFeatureDescriptor

public static FeatureDescriptor getFeatureDescriptor(Component parent,
 String propName)

Returns the FeatureDescriptor for the given property name on the given component or null if the property is not found.

getPropertyNode

public static PropertyNode getPropertyNode(Component parent,
 FeatureDescriptor fd)

Returns a PropertyNode (Dynamic or Static) for the given feature descriptor on the given component