com.streambase.sb.operator.parameter

Class ConfigurationChooserPropertyDescriptor

java.lang.Object

java.beans.FeatureDescriptor

java.beans.PropertyDescriptor

com.streambase.sb.operator.parameter.SBPropertyDescriptor

com.streambase.sb.operator.parameter.ConfigurationChooserPropertyDescriptor

public class ConfigurationChooserPropertyDescriptor
extends SBPropertyDescriptor

A property descriptor for use by a String-typed Java Operator or Adapter property, for cases that wish to present to the user a chooser (typically a combo box) that allows identifying some data out of the server configuration file's adapter-configurations area.

At runtime, the Operator/Adapter may use Operator.getOperatorConfigurationAccessor() along with the property value to retrieve the data.

Specifically, this descriptor is to be created with an XPath expression that selects XPathConstants.NODESET, and more specifically, that is expected to return a list of Attribute nodes, whose values will be presented to the user to select from. The value selected (or entered) is then set to a String property type.

The XPath expression supports the use of variables (using the $var syntax as specified by the JAXP API); you may use other property names as variable names, and you must declare these variables using ConfigurationChooserPropertyDescriptor.setLinkedPropertyNames(String...).

For example, given this as the contents of the adapter-configurations element in the server's configuration file:

 <adapter-configuration type="myop">
   <section name="section1">
   ...
   </section>
   <section name="section2">
   ...
   </section>
 </adapter-configuration>
 

then this xpath: adapter-configuration[@type="myop"]/section/@name

would let the user select from:

section1 and section2

An example XPath expression using a parameter might look like: adapter-configuration[@type="myop"]/sections/[@name=$section]/@name

Note that UIHints proposals are ignored for this descriptor.

Since:

7.5

See Also:

Operator.getOperatorConfigurationAccessor()

Nested Class Summary

Nested classes/interfaces inherited from class com.streambase.sb.operator.parameter.SBPropertyDescriptor

SBPropertyDescriptor.SingleValueSetter

Field Summary

Fields inherited from class com.streambase.sb.operator.parameter.SBPropertyDescriptor

_expressionInputPort, NOT_AN_EXPRESSION

Constructor Summary

Constructors

Constructor and Description
ConfigurationChooserPropertyDescriptor(java.lang.String xpath, java.beans.PropertyDescriptor pd, java.lang.Class<?> beanClass) Copy a property descriptor
ConfigurationChooserPropertyDescriptor(java.lang.String propertyName, java.lang.String xpath, java.lang.Class<?> beanClass) Standard constructor
ConfigurationChooserPropertyDescriptor(java.lang.String propertyName, java.lang.String xpath, java.lang.Class<?> beanClass, java.lang.String readMethodName, java.lang.String writeMethodName) Construct a property descriptor with non-standard read/write method names

Method Summary

Modifier and Type	Method and Description
javax.xml.xpath.XPathExpression	getExpression()
java.lang.String[]	getLinkedPropertyNames()
ConfigurationChooserPropertyDescriptor	setLinkedPropertyNames(java.lang.String... propertyNames) Declare property names that are being used in the XPath expression as variables

Methods inherited from class com.streambase.sb.operator.parameter.SBPropertyDescriptor

deprecated, description, displayName, getExpressionInputPort, getMaskDisplay, getMultiLine, getUIHints, isDeprecated, isExpression, isRequired, mask, multiline, optional, setDeprecated, setMaskStringDisplay, setMultiLine, setRequired, setUIHints

Methods inherited from class java.beans.PropertyDescriptor

createPropertyEditor, equals, getPropertyEditorClass, getPropertyType, getReadMethod, getWriteMethod, hashCode, isBound, isConstrained, setBound, setConstrained, setPropertyEditorClass, setReadMethod, setWriteMethod

Methods inherited from class java.beans.FeatureDescriptor

attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigurationChooserPropertyDescriptor

public ConfigurationChooserPropertyDescriptor(java.lang.String propertyName,
                                              java.lang.String xpath,
                                              java.lang.Class<?> beanClass)
                                       throws java.beans.IntrospectionException,
                                              javax.xml.xpath.XPathExpressionException

Standard constructor

Parameters:

propertyName - the name of the property

xpath - an XPath expression string that will select attributes whose values are to be displayed to the user

beanClass - the operator class containing the property

Throws:

java.beans.IntrospectionException - if introspection fails

javax.xml.xpath.XPathExpressionException - invalid xpath expression

ConfigurationChooserPropertyDescriptor

public ConfigurationChooserPropertyDescriptor(java.lang.String propertyName,
                                              java.lang.String xpath,
                                              java.lang.Class<?> beanClass,
                                              java.lang.String readMethodName,
                                              java.lang.String writeMethodName)
                                       throws java.beans.IntrospectionException,
                                              javax.xml.xpath.XPathExpressionException

Construct a property descriptor with non-standard read/write method names

Parameters:

propertyName - the name of the property

xpath - an XPath expression string that will select attributes whose values are to be displayed to the user

beanClass - the operator class containing the property

readMethodName - the name of the method used to read the property

writeMethodName - the name of the method used to write the property

Throws:

java.beans.IntrospectionException - if introspection fails

javax.xml.xpath.XPathExpressionException - invalid XPath expression

ConfigurationChooserPropertyDescriptor

public ConfigurationChooserPropertyDescriptor(java.lang.String xpath,
                                              java.beans.PropertyDescriptor pd,
                                              java.lang.Class<?> beanClass)
                                       throws java.beans.IntrospectionException,
                                              javax.xml.xpath.XPathExpressionException

Copy a property descriptor

Parameters:

xpath - an XPath expression string that will select attributes whose values are to be displayed to the user

pd - a property descriptor to copy from

beanClass - the operator class containing the property

Throws:

java.beans.IntrospectionException - if introspection fails

javax.xml.xpath.XPathExpressionException - on XPath error

Method Detail

getExpression

public javax.xml.xpath.XPathExpression getExpression()

Returns:

the XPathExpression this property descriptor was created with

setLinkedPropertyNames

public ConfigurationChooserPropertyDescriptor setLinkedPropertyNames(java.lang.String... propertyNames)

Declare property names that are being used in the XPath expression as variables

Parameters:

propertyNames - names of the other properties to link to

Returns:

this object to allow method chaining

getLinkedPropertyNames

public java.lang.String[] getLinkedPropertyNames()

Returns:

a never-null array of property names used as variables in this descriptor's XPath expression