org.eclipse.scada.da.server.common.item.factory

Class CommonItemFactory

java.lang.Object

org.eclipse.scada.da.server.common.item.factory.CommonItemFactory

All Implemented Interfaces:

ItemFactory

Direct Known Subclasses:

HiveItemFactory

public class CommonItemFactory
extends Object
implements ItemFactory

This item factory only creates the items but does not register them anywhere

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_ID_DELIMITER
protected Map<String,DataItem>	itemMap

Constructor Summary

Constructors

Constructor and Description
CommonItemFactory(Executor executor)
CommonItemFactory(Executor executor, CommonItemFactory parentItemFactory, String baseId, String idDelimiter)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addSubFactory(ItemFactory itemFactory)
protected DataItemCommand	constructCommand(String localId)
protected DataItemInputChained	constructInput(String localId)
protected WriteHandlerItem	constructInputOutput(String localId, WriteHandler writeHandler)
protected WriteHandlerItem	constructWriteHandler(String localId, WriteHandler writeHandler)
DataItemCommand	createCommand(String localId, Map<String,Variant> properties)
DataItemInputChained	createInput(String localId, Map<String,Variant> properties)
WriteHandlerItem	createInputOutput(String localId, Map<String,Variant> properties, WriteHandler writeHandler)
WriteHandlerItem	createOutput(String localId, Map<String,Variant> properties, WriteHandler writeHandler)
void	dispose() Dispose the factory
void	disposeAllItems() Dispose all items but not the factory itself
void	disposeItem(DataItem item) Dispose an item if it was created by this factory
protected String	generateId(String localId) Generate a global Id by using the base id and the local id
String	getBaseId()
boolean	isDisposed()
boolean	removeSubFactory(ItemFactory itemFactory)
void	setIdDelimiter(String idDelimiter) Change the ID delimiter.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ID_DELIMITER

protected static final String DEFAULT_ID_DELIMITER

See Also:

Constant Field Values

itemMap

protected Map<String,DataItem> itemMap

Constructor Detail

CommonItemFactory

public CommonItemFactory(Executor executor)

CommonItemFactory

public CommonItemFactory(Executor executor,
                 CommonItemFactory parentItemFactory,
                 String baseId,
                 String idDelimiter)

Method Detail

setIdDelimiter

public void setIdDelimiter(String idDelimiter)

Change the ID delimiter.

Note that items which have already been created will not but updated to use the new delimiter

Parameters:

idDelimiter - the new delimiter to use

isDisposed

public boolean isDisposed()

generateId

protected String generateId(String localId)

Generate a global Id by using the base id and the local id

Parameters:

localId - the local id

Returns:

the global id

constructCommand

protected DataItemCommand constructCommand(String localId)

constructInput

protected DataItemInputChained constructInput(String localId)

constructInputOutput

protected WriteHandlerItem constructInputOutput(String localId,
                                    WriteHandler writeHandler)

constructWriteHandler

protected WriteHandlerItem constructWriteHandler(String localId,
                                     WriteHandler writeHandler)

dispose

public void dispose()

Description copied from interface: ItemFactory

Dispose the factory

All items that where created by this factory and where not disposed up to now are being disposed

After a call to this method it is not possible to create new items. Multiple calls to ItemFactory.dispose() or calls to ItemFactory.disposeAllItems() are possible.

Specified by:

dispose in interface ItemFactory

disposeAllItems

public void disposeAllItems()

Dispose all items but not the factory itself

Specified by:

disposeAllItems in interface ItemFactory

disposeItem

public void disposeItem(DataItem item)

Description copied from interface: ItemFactory

Dispose an item if it was created by this factory

If the item was not created by this factory or was already disposed this is no error and no exception is thrown

Specified by:

disposeItem in interface ItemFactory

Parameters:

item - data item to dispose

createCommand

public DataItemCommand createCommand(String localId,
                            Map<String,Variant> properties)

Specified by:

createCommand in interface ItemFactory

createInput

public DataItemInputChained createInput(String localId,
                               Map<String,Variant> properties)

Specified by:

createInput in interface ItemFactory

createOutput

public WriteHandlerItem createOutput(String localId,
                            Map<String,Variant> properties,
                            WriteHandler writeHandler)

Specified by:

createOutput in interface ItemFactory

createInputOutput

public WriteHandlerItem createInputOutput(String localId,
                                 Map<String,Variant> properties,
                                 WriteHandler writeHandler)

Specified by:

createInputOutput in interface ItemFactory

getBaseId

public String getBaseId()

addSubFactory

public boolean addSubFactory(ItemFactory itemFactory)

removeSubFactory

public boolean removeSubFactory(ItemFactory itemFactory)