org.eclipse.scada.da.server.common.exporter

Class AbstractObjectExporter

java.lang.Object

org.eclipse.scada.da.server.common.exporter.AbstractObjectExporter

All Implemented Interfaces:

Disposable

Direct Known Subclasses:

ObjectExporter, StaticObjectExporter

public abstract class AbstractObjectExporter
extends Object
implements Disposable

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Map<String,Variant>>	attributes
protected ItemFactory	factory
protected Map<String,DataItem>	items

Constructor Summary

Constructors

Constructor and Description
AbstractObjectExporter(ItemFactory itemFactory, boolean readOnly, boolean nullIsError, String prefix) Create a new object factory

Method Summary

Methods

Modifier and Type	Method and Description
protected void	createDataItems(Class<?> targetClazz) create data items from the properties
void	dispose()
protected void	fillAttributes(PropertyDescriptor pd, Map<String,Variant> attributes)
protected <T extends Annotation> T	findAnnotation(PropertyDescriptor pd, Class<?> clazz, Class<T> annotationClazz) Find the annotation
protected Map<String,Variant>	getAdditionalAttributes()
protected ItemOptions	getOptions(PropertyDescriptor pd, Class<?> clazz)
protected abstract Object	getTarget() Get the current target or null if there is none
protected void	initAttribute(PropertyDescriptor pd) read the initial value of the property
protected String	makeItemName(PropertyDescriptor pd, Class<?> clazz)
protected void	updateAttribute(String propertyName, Object newValue, Throwable e, Map<String,Variant> additionalAttributes)
protected void	updateItemsFromTarget()
protected void	writeAttribute(PropertyDescriptor pd, Variant value)

Methods inherited from class java.lang.Object

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

Field Detail

factory

protected ItemFactory factory

items

protected final Map<String,DataItem> items

attributes

protected final Map<String,Map<String,Variant>> attributes

Constructor Detail

AbstractObjectExporter

public AbstractObjectExporter(ItemFactory itemFactory,
                      boolean readOnly,
                      boolean nullIsError,
                      String prefix)

Create a new object factory

Parameters:

itemFactory - the item factory to use

readOnly - flag if all properties should be created read-only

nullIsError - flag whether controls if null mean error

prefix - a local item prefix

Method Detail

dispose

public void dispose()

Specified by:

dispose in interface Disposable

createDataItems

protected void createDataItems(Class<?> targetClazz)

create data items from the properties

updateItemsFromTarget

protected void updateItemsFromTarget()

getAdditionalAttributes

protected Map<String,Variant> getAdditionalAttributes()

initAttribute

protected void initAttribute(PropertyDescriptor pd)

read the initial value of the property

Parameters:

pd -

fillAttributes

protected void fillAttributes(PropertyDescriptor pd,
                  Map<String,Variant> attributes)

findAnnotation

protected <T extends Annotation> T findAnnotation(PropertyDescriptor pd,
                                      Class<?> clazz,
                                      Class<T> annotationClazz)

Find the annotation

The following search order processed

1. Check the field with the same name as the property, process through all superclasses
2. Check the read method
3. Check the write method

Parameters:

pd - the property descriptor to check

clazz - class instance

Returns:

the annotation or null if none was found

getOptions

protected ItemOptions getOptions(PropertyDescriptor pd,
                     Class<?> clazz)

makeItemName

protected String makeItemName(PropertyDescriptor pd,
                  Class<?> clazz)

updateAttribute

protected void updateAttribute(String propertyName,
                   Object newValue,
                   Throwable e,
                   Map<String,Variant> additionalAttributes)

getTarget

protected abstract Object getTarget()

Get the current target or null if there is none

Returns:

the current target

writeAttribute

protected void writeAttribute(PropertyDescriptor pd,
                  Variant value)
                       throws Exception

Throws:

Exception