com.inductiveautomation.xopc.driver.configuration.meta

Class AbstractDriverProperty

java.lang.Object

com.inductiveautomation.xopc.driver.configuration.meta.AbstractDriverProperty

All Implemented Interfaces:

DriverProperty, java.io.Serializable

public abstract class AbstractDriverProperty
extends java.lang.Object
implements DriverProperty

A partial implementation of DriverProperty that will automatically pull the display name and description from a properties file.

Unless overridden, the properties file should contain the following:

• Properties.$PropertyIdentifier.DisplayName
• Properties.$PropertyIdentifier.Description

where $PropertyIdentifier is String returned by getPropertyIdentifier().

The following default values are provided (and overridable):

• isRequired() = true
• getValidationType() = null (none)
• getValidationValue() = null (n/a for no validation)
• getChoices = null (none)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractDriverProperty()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	getBundlePrefix()
java.util.List<java.lang.Object>	getChoices()
java.lang.String	getDescription() Retrieves the description from the properties file using the key returned by getDescriptionKey().
protected java.lang.String	getDescriptionKey()
java.lang.String	getDisplayName() Retrieves the display name from the properties file using the key returned by getDisplayNameKey().
protected java.lang.String	getDisplayNameKey()
protected java.lang.String	getPropertyIdentifier()
java.lang.String	getValidationType() Returns the type of validation, if any, to use on this property.
java.lang.String	getValidationValue() If a validation type was specified, this is the value to use for validation.
boolean	isRequired()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.xopc.driver.configuration.meta.DriverProperty

getDefaultValue, getId, getType

Constructor Detail

AbstractDriverProperty

public AbstractDriverProperty()

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Retrieves the display name from the properties file using the key returned by getDisplayNameKey().

Specified by:

getDisplayName in interface DriverProperty

getDisplayNameKey

protected java.lang.String getDisplayNameKey()

Returns:

The key used to retrieve the display name from the properties file.

getDescription

public java.lang.String getDescription()

Retrieves the description from the properties file using the key returned by getDescriptionKey().

Specified by:

getDescription in interface DriverProperty

getDescriptionKey

protected java.lang.String getDescriptionKey()

Returns:

The key used to retrieve the description from the properties file.

isRequired

public boolean isRequired()

Specified by:

isRequired in interface DriverProperty

getValidationType

public java.lang.String getValidationType()

Description copied from interface: DriverProperty

Returns the type of validation, if any, to use on this property.

Currently available types: "regex" and "range"

Specified by:

getValidationType in interface DriverProperty

Returns:

String type of validation to use on this property.

getValidationValue

public java.lang.String getValidationValue()

Description copied from interface: DriverProperty

If a validation type was specified, this is the value to use for validation. This will currently either be a regular expression or a range, taking the format "low_value-high_value".

If you wanted to validate port ranges, for example, you might return "1-65535".

Specified by:

getValidationValue in interface DriverProperty

Returns:

String value that the chosen validation type will use.

getChoices

public java.util.List<java.lang.Object> getChoices()

Specified by:

getChoices in interface DriverProperty

getPropertyIdentifier

protected java.lang.String getPropertyIdentifier()

Returns:

The String that identifies this property. Defaults to getClass.getSimpleName().

getBundlePrefix

protected abstract java.lang.String getBundlePrefix()

Returns:

The prefix for the bundle to retrieve property keys from.