org.eclipse.scada.da.server.browser.common

Class FolderCommon

java.lang.Object

org.eclipse.scada.da.server.browser.common.FolderCommon

All Implemented Interfaces:

Folder

public class FolderCommon
extends Object
implements Folder

A common folder implementation which can be used to easily implement folders.

Author:

Jens Reimann

Constructor Summary

Constructors

Constructor and Description
FolderCommon()

Method Summary

Modifier and Type	Method and Description
int	add(Map<String,Folder> folders, Map<String,DataItemInformation> items) Bulk add items
boolean	add(String name, DataItemInformation itemInformation, Map<String,Variant> attributes)
boolean	add(String name, DataItem dataItem, Map<String,Variant> attributes)
boolean	add(String name, Folder folder, Map<String,Variant> attributes)
void	added() Called when the folder was added to the browser space
void	clear() clear all folder content at once
void	clearListeners()
String	findEntry(DataItem item)
String	findEntry(Folder folder)
boolean	hasSubscribers() Check if there are subscribers
Entry[]	list(Stack<String> path)
boolean	remove(DataItem item)
boolean	remove(Folder folder)
boolean	remove(String name)
void	removed() Called when the folder was removed from the browser space
int	size() Get the number of entries in this folder
void	subscribe(Stack<String> path, FolderListener listener, Object tag)
void	unsubscribe(Stack<String> path, Object tag)

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderCommon

public FolderCommon()

Method Detail

list

public Entry[] list(Stack<String> path)
             throws NoSuchFolderException

Specified by:

list in interface Folder

Throws:

NoSuchFolderException

add

public int add(Map<String,Folder> folders,
               Map<String,DataItemInformation> items)

Bulk add items

Parameters:

folders - folders to register or null if no folders should be registered

items - items to register or null if no item should be registered

Returns:

number of items added

add

public boolean add(String name,
                   Folder folder,
                   Map<String,Variant> attributes)

add

public boolean add(String name,
                   DataItem dataItem,
                   Map<String,Variant> attributes)

add

public boolean add(String name,
                   DataItemInformation itemInformation,
                   Map<String,Variant> attributes)

remove

public boolean remove(String name)

findEntry

public String findEntry(DataItem item)

findEntry

public String findEntry(Folder folder)

remove

public boolean remove(Folder folder)

remove

public boolean remove(DataItem item)

subscribe

public void subscribe(Stack<String> path,
                      FolderListener listener,
                      Object tag)
               throws NoSuchFolderException

Specified by:

subscribe in interface Folder

Throws:

NoSuchFolderException

unsubscribe

public void unsubscribe(Stack<String> path,
                        Object tag)
                 throws NoSuchFolderException

Specified by:

unsubscribe in interface Folder

Throws:

NoSuchFolderException

clearListeners

public void clearListeners()

hasSubscribers

public boolean hasSubscribers()

Check if there are subscribers

Returns:

true if there are active subscribers

size

public int size()

Get the number of entries in this folder

Returns:

the number of entries in this folder

added

public void added()

Description copied from interface: Folder

Called when the folder was added to the browser space

Specified by:

added in interface Folder

removed

public void removed()

Description copied from interface: Folder

Called when the folder was removed from the browser space

Specified by:

removed in interface Folder

clear

public void clear()

clear all folder content at once