com.inductiveautomation.xopc.driver.configuration.meta

Class AbstractDriverMeta

java.lang.Object

com.inductiveautomation.xopc.driver.configuration.meta.AbstractDriverMeta

All Implemented Interfaces:

DriverMeta, java.io.Serializable

public abstract class AbstractDriverMeta
extends java.lang.Object
implements DriverMeta

A partial implementation of DriverMeta that will pull strings from a properties file that resides next to the Driver implementation this DriverMeta is describing.

Assumes a bundle has been loaded with a prefix equal to the simple name of driverClass by default; if your drivers class was named "MyDriver", the properties file would be "MyDriver.properties".

Unless overridden to provide different keys, the properties file should include the following properties:

• Meta.DisplayName
• Meta.ReleaseDate
• Meta.DateFormat
• Meta.Version
• Meta.CompanyName
• Meta.WebsiteUrl
• Meta.PhoneNumber

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
AbstractDriverMeta(java.lang.Class<?> driverClass) Assumes a bundle has been loaded with a prefix equal to the simple name of driverClass by default.

Method Summary

Modifier and Type	Method and Description
DriverAuthorInfo	getAuthorInfo() The DriverAuthorInfo is built from three strings from the properties file: company name, web site URL, and phone number.
protected java.lang.String	getBundlePrefix()
java.lang.ClassLoader	getClassLoader()
java.lang.String	getClassName()
protected java.lang.String	getCompanyNameKey()
protected java.lang.String	getDateFormatKey()
java.lang.String	getDisplayName() Retrieves the display name from the properties file using the key returned by getDisplayNameKey().
protected java.lang.String	getDisplayNameKey()
java.util.List<LinkEntry>	getLinks() Don't use anonymous inner classes for LinkEntrys.
protected java.lang.String	getPhoneNumberKey()
java.util.Date	getReleaseDate() Retrieves the release date from the properties file using the key returned by getReleaseDateKey().
protected java.lang.String	getReleaseDateKey()
Version	getVersion() Retrieves the version from the properties file using the key returned by getVersionKey().
protected java.lang.String	getVersionKey()
protected java.lang.String	getWebsiteUrlKey()

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.DriverMeta

getCategoryList, getDisplayPath

Field Detail

log

protected final transient org.apache.log4j.Logger log

Constructor Detail

AbstractDriverMeta

public AbstractDriverMeta(java.lang.Class<?> driverClass)

Assumes a bundle has been loaded with a prefix equal to the simple name of driverClass by default.

Parameters:

driverClass - The Driver implementation this DriverMeta describes.

Method Detail

getClassName

public java.lang.String getClassName()

Specified by:

getClassName in interface DriverMeta

getClassLoader

public java.lang.ClassLoader getClassLoader()

Specified by:

getClassLoader in interface DriverMeta

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 DriverMeta

getDisplayNameKey

protected java.lang.String getDisplayNameKey()

Returns:

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

getReleaseDate

public java.util.Date getReleaseDate()

Retrieves the release date from the properties file using the key returned by getReleaseDateKey().

The date format string must be specified in the properties file under the key returned by getDateFormatKey().

If the date cannot be parsed, the current date is returned.

Specified by:

getReleaseDate in interface DriverMeta

getReleaseDateKey

protected java.lang.String getReleaseDateKey()

Returns:

The key used to retrieve the release date from the properties file.

getDateFormatKey

protected java.lang.String getDateFormatKey()

Returns:

The key used to retrieve date format string from the properties file.

getVersion

public Version getVersion()

Retrieves the version from the properties file using the key returned by getVersionKey().

The String returned must be one that was generated by Version.getParsableString(). If it does not parse, a "dev" Version will be returned instead.

Specified by:

getVersion in interface DriverMeta

getVersionKey

protected java.lang.String getVersionKey()

Returns:

The key used to retrieve the version string from the properties file.

getAuthorInfo

public DriverAuthorInfo getAuthorInfo()

The DriverAuthorInfo is built from three strings from the properties file: company name, web site URL, and phone number.

These are retrieved using the following keys, respectively: getCompanyNameKey(), getWebsiteUrlKey(), getPhoneNumberKey().

Specified by:

getAuthorInfo in interface DriverMeta

getCompanyNameKey

protected java.lang.String getCompanyNameKey()

Returns:

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

getWebsiteUrlKey

protected java.lang.String getWebsiteUrlKey()

Returns:

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

getPhoneNumberKey

protected java.lang.String getPhoneNumberKey()

Returns:

The key used to retrieve phone number from the properties file.

getBundlePrefix

protected java.lang.String getBundlePrefix()

Returns:

The prefix for the bundle to retrieve property keys from.

getLinks

public java.util.List<LinkEntry> getLinks()

Description copied from interface: DriverMeta

Don't use anonymous inner classes for LinkEntrys.

Specified by:

getLinks in interface DriverMeta