Module platform.core

Package de.grogra.pf.registry

Class Registry

java.lang.Object

de.grogra.pf.registry.Registry

All Implemented Interfaces:

GraphTransaction.Consumer, SharedObjectProvider, SharedObjectProvider.Binding, Transaction.Consumer, XAListener, RegistryContext, TypeLoader, TreeDiff.NodeModel, TreeModel

public final class Registry
extends Object
implements Transaction.Consumer, GraphTransaction.Consumer, XAListener, SharedObjectProvider, SharedObjectProvider.Binding, TreeModel, RegistryContext, TreeDiff.NodeModel, TypeLoader

The registry consists of a tree of items. Each item has a name and can be referenced like in a file system. The path for selecting an item is similar to a unix path (i. e. /ui/commands).

Author:

nmi

Nested Class Summary

Nested classes/interfaces inherited from interface de.grogra.graph.impl.GraphTransaction.Consumer

GraphTransaction.Consumer.Adapter, GraphTransaction.Consumer.Multicaster

Nested classes/interfaces inherited from interface de.grogra.persistence.SharedObjectProvider

SharedObjectProvider.Binding

Nested classes/interfaces inherited from interface de.grogra.persistence.Transaction.Consumer

Transaction.Consumer.Adapter, Transaction.Consumer.Multicaster

Nested classes/interfaces inherited from interface de.grogra.persistence.XAListener

XAListener.WeakDelegate

Field Summary

Fields

Modifier and Type	Field	Description
static final JoinedFileSystem	ALL_FILE_SYSTEMS
static final MimeType	MIME_TYPE
static final String	NAMESPACE
static final JoinedFileSystem	PLUGIN_FILE_SYSTEMS
static final String	PROJECT_GRAPH
static final String	REGISTRY_GRAPH

Constructor Summary

Constructors

Constructor	Description
Registry(Registry parentRegistry)

Method Summary

Modifier and Type	Method	Description
final boolean	activateItems()
void	addContentDescription(HashMap<String,ContentDescriptionType[]> contents)	Add the ContentDescriptionTypes to the registry.
void	addEdgeBits(Node source, Node target, int mask)
void	addFileSystemListener(TreeModelListener l)
SONodeReference	addSharedObject(String directory, Shareable object, String name, boolean objDescribes)	Adds a SharedObjectNode for object to the meta-graph (see GraphManager.META_GRAPH) of the project graph (see getProjectGraph()), and creates a reference to this node in the specified directory of this registry.
void	addTreeModelListener(TreeModelListener l)
static int	allocatePropertyId()
void	begin()
final void	beginXA()
Class	classForName(String name)
final void	commitXA(boolean activateItems)
static Registry	create(Registry parentRegistry)
void	createGraphs(PersistenceConnection conn)
ContentHandler	createXMLReader()
SAXSource	createXMLSource(Collection requiredPlugins, XMLSerializer.Filter filter)
static Registry	current()
void	dispose()
void	end()
boolean	equals(Object a, Object b)
Item[]	findAll(ItemCriterion c, Object info, boolean resolve)
Item	findFirst(ItemCriterion c, Object info, boolean resolve)
Item	findMax(ItemComparator c, Object info, boolean resolve)
void	forAll(ItemCriterion c, Object info, ItemVisitor cb, Object cbInfo, boolean resolve)
int	getActivationStamp()
Object	getChild(Object parent, int index)
int	getChildCount(Object parent)
ClassLoader	getClassLoader()
TreeDiff.DiffInfo	getDiffInfo(Object node)
Item	getDirectory(String path, PluginDescriptor plugin)	Return the item specified by its absolute path or create such an item if does not yet exist.
Collection	getFiles()
FileSystem	getFileSystem()
final String	getFileSystemName()
Object	getImportAttribute(String key)
int	getIndexOfChild(Object parent, Object child)
Item	getItem(String key)
Object	getLock()
Logger	getLogger()
final Object	getOrCreateProjectFile(String systemId, Item[] path, boolean isDirectory)
Registry	getParentRegistry()
PluginDescriptor	getPluginDescriptor(String pluginId)
final Item	getPluginDirectory()
final Object	getProjectFile(String systemId)
GraphManager	getProjectGraph()
String	getProjectName()
String	getProviderName()
Registry	getRegistry()	Returns the Registry which is linked with this instance.
GraphManager	getRegistryGraph()
Object	getRoot()
Registry	getRootRegistry()
final Item	getStaticsDirectory()	The static Directory contains the statics import that are added in RGG classes by defaults.
final Transaction	getTransaction()
Object	getUserProperty(int id)
Object	getWriteLock()
void	initFileSystem(FileSystem fileSystem)
void	initialize()
void	insertComponent(PersistenceCapable o, PersistenceField field, int[] indices, Transaction.Reader reader)
final void	invokeAfterCommit(Runnable r)
boolean	isActive()
boolean	isLeaf(Object node)
final boolean	isRootRegistry()
SharedObjectProvider	lookup(String name)
void	makePersistent(long id, ManageableType type)
void	makeTransient(PersistenceCapable o, ManageableType type)
void	readData(PersistenceCapable o, Transaction.Reader reader)
ResolvableReference	readReference(PersistenceInput in)
void	removeComponent(PersistenceCapable o, PersistenceField field, int[] indices, Transaction.Reader reader)
void	removeEdgeBits(Node source, Node target, int mask)
void	removeFileSystemListener(TreeModelListener l)
void	removeTreeModelListener(TreeModelListener l)
static void	setCurrent(RegistryContext current)
void	setEmptyGraph()
void	setField(PersistenceCapable o, PersistenceField field, int[] indices, Transaction.Reader reader)
void	setProjectName(String projectName)
Object	setUserProperty(int id, Object value)
void	startup()
void	substituteFileSystem(FileSystem newfs)
void	transactionApplied(Transaction.Data xa, boolean rollback)
Type	typeForName(String name)
void	valueForPathChanged(TreePath path, Object newValue)
void	writeObject(Shareable object, PersistenceOutput out)

Methods inherited from class java.lang.Object

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

Field Details

NAMESPACE

public static final String NAMESPACE

See Also:

• Constant Field Values

MIME_TYPE

public static final MimeType MIME_TYPE

PROJECT_GRAPH

public static final String PROJECT_GRAPH

See Also:

• Constant Field Values

REGISTRY_GRAPH

public static final String REGISTRY_GRAPH

See Also:

• Constant Field Values

PLUGIN_FILE_SYSTEMS

public static final JoinedFileSystem PLUGIN_FILE_SYSTEMS

ALL_FILE_SYSTEMS

public static final JoinedFileSystem ALL_FILE_SYSTEMS

Constructor Details

Registry

public Registry(Registry parentRegistry)

Method Details

allocatePropertyId

public static int allocatePropertyId()

addTreeModelListener

public void addTreeModelListener(TreeModelListener l)

Specified by:

addTreeModelListener in interface TreeModel

removeTreeModelListener

public void removeTreeModelListener(TreeModelListener l)

Specified by:

removeTreeModelListener in interface TreeModel

valueForPathChanged

public void valueForPathChanged(TreePath path,
 Object newValue)

Specified by:

valueForPathChanged in interface TreeModel

getChild

public Object getChild(Object parent,
 int index)

Specified by:

getChild in interface TreeModel

getChildCount

public int getChildCount(Object parent)

Specified by:

getChildCount in interface TreeModel

getIndexOfChild

public int getIndexOfChild(Object parent,
 Object child)

Specified by:

getIndexOfChild in interface TreeModel

isLeaf

public boolean isLeaf(Object node)

Specified by:

isLeaf in interface TreeModel

getRoot

public Object getRoot()

Specified by:

getRoot in interface TreeModel

create

public static Registry create(Registry parentRegistry)

createGraphs

public void createGraphs(PersistenceConnection conn)

initialize

public void initialize()

getRegistry

public Registry getRegistry()

Description copied from interface: RegistryContext

Returns the Registry which is linked with this instance.

Specified by:

getRegistry in interface RegistryContext

Returns:

the registry linked with this instance

getLogger

public Logger getLogger()

addFileSystemListener

public void addFileSystemListener(TreeModelListener l)

removeFileSystemListener

public void removeFileSystemListener(TreeModelListener l)

initFileSystem

public void initFileSystem(FileSystem fileSystem)

substituteFileSystem

public void substituteFileSystem(FileSystem newfs)
                          throws IOException

Throws:

IOException

getFiles

public Collection getFiles()

getFileSystem

public FileSystem getFileSystem()

getProjectFile

public final Object getProjectFile(String systemId)

getOrCreateProjectFile

public final Object getOrCreateProjectFile(String systemId,
 Item[] path,
 boolean isDirectory)
                                    throws IOException

Throws:

IOException

getFileSystemName

public final String getFileSystemName()

setProjectName

public void setProjectName(String projectName)

getProjectName

public String getProjectName()

getImportAttribute

public Object getImportAttribute(String key)

findFirst

public Item findFirst(ItemCriterion c,
 Object info,
 boolean resolve)

forAll

public void forAll(ItemCriterion c,
 Object info,
 ItemVisitor cb,
 Object cbInfo,
 boolean resolve)

findAll

public Item[] findAll(ItemCriterion c,
 Object info,
 boolean resolve)

findMax

public Item findMax(ItemComparator c,
 Object info,
 boolean resolve)

setEmptyGraph

public void setEmptyGraph()

getProjectGraph

public GraphManager getProjectGraph()

getRegistryGraph

public GraphManager getRegistryGraph()

getParentRegistry

public Registry getParentRegistry()

getRootRegistry

public Registry getRootRegistry()

isRootRegistry

public final boolean isRootRegistry()

getLock

public Object getLock()

getWriteLock

public Object getWriteLock()

beginXA

public final void beginXA()

getTransaction

public final Transaction getTransaction()

invokeAfterCommit

public final void invokeAfterCommit(Runnable r)

commitXA

public final void commitXA(boolean activateItems)

getItem

public Item getItem(String key)

getDirectory

public Item getDirectory(String path,
 PluginDescriptor plugin)

Return the item specified by its absolute path or create such an item if does not yet exist. plugin is stored as the plugin that was responsible for creating the item (only if an item was created). plugin may be null to signal that there is no responsible instance.

Parameters:

path - absolute path

plugin - descriptor of responsible plugin

Returns:

item specified by path

addSharedObject

public SONodeReference addSharedObject(String directory,
 Shareable object,
 String name,
 boolean objDescribes)

Adds a SharedObjectNode for object to the meta-graph (see GraphManager.META_GRAPH) of the project graph (see getProjectGraph()), and creates a reference to this node in the specified directory of this registry. The name is chosen based on name in the same way as in Item.addUserItemWithUniqueName(Item, String).

Parameters:

directory - absolute path where to insert reference item

object - object for which references shall be created

name - base name to use

objDescribes - true iff object shall be queried for descriptions (e.g., for the icon)

Returns:

reference item to object in registry

getPluginDirectory

public final Item getPluginDirectory()

getPluginDescriptor

public PluginDescriptor getPluginDescriptor(String pluginId)

activateItems

public final boolean activateItems()

getActivationStamp

public int getActivationStamp()

startup

public void startup()

isActive

public boolean isActive()

dispose

public void dispose()

setUserProperty

public Object setUserProperty(int id,
 Object value)

getUserProperty

public Object getUserProperty(int id)

transactionApplied

public void transactionApplied(Transaction.Data xa,
 boolean rollback)

Specified by:

transactionApplied in interface XAListener

setField

public void setField(PersistenceCapable o,
 PersistenceField field,
 int[] indices,
 Transaction.Reader reader)

Specified by:

setField in interface Transaction.Consumer

insertComponent

public void insertComponent(PersistenceCapable o,
 PersistenceField field,
 int[] indices,
 Transaction.Reader reader)

Specified by:

insertComponent in interface Transaction.Consumer

removeComponent

public void removeComponent(PersistenceCapable o,
 PersistenceField field,
 int[] indices,
 Transaction.Reader reader)

Specified by:

removeComponent in interface Transaction.Consumer

addEdgeBits

public void addEdgeBits(Node source,
 Node target,
 int mask)

Specified by:

addEdgeBits in interface GraphTransaction.Consumer

removeEdgeBits

public void removeEdgeBits(Node source,
 Node target,
 int mask)

Specified by:

removeEdgeBits in interface GraphTransaction.Consumer

makePersistent

public void makePersistent(long id,
 ManageableType type)

Specified by:

makePersistent in interface Transaction.Consumer

makeTransient

public void makeTransient(PersistenceCapable o,
 ManageableType type)

Specified by:

makeTransient in interface Transaction.Consumer

readData

public void readData(PersistenceCapable o,
 Transaction.Reader reader)

Specified by:

readData in interface Transaction.Consumer

begin

public void begin()

Specified by:

begin in interface Transaction.Consumer

end

public void end()

Specified by:

end in interface Transaction.Consumer

lookup

public SharedObjectProvider lookup(String name)

Specified by:

lookup in interface SharedObjectProvider.Binding

getProviderName

public String getProviderName()

Specified by:

getProviderName in interface SharedObjectProvider

readReference

public ResolvableReference readReference(PersistenceInput in)
                                  throws IOException

Specified by:

readReference in interface SharedObjectProvider

Throws:

IOException

writeObject

public void writeObject(Shareable object,
 PersistenceOutput out)
                 throws IOException

Specified by:

writeObject in interface SharedObjectProvider

Throws:

IOException

createXMLSource

public SAXSource createXMLSource(Collection requiredPlugins,
 XMLSerializer.Filter filter)

createXMLReader

public ContentHandler createXMLReader()

equals

public boolean equals(Object a,
 Object b)

Specified by:

equals in interface TreeDiff.NodeModel

getDiffInfo

public TreeDiff.DiffInfo getDiffInfo(Object node)

Specified by:

getDiffInfo in interface TreeDiff.NodeModel

getClassLoader

public ClassLoader getClassLoader()

Specified by:

getClassLoader in interface TypeLoader

classForName

public Class classForName(String name)
                   throws ClassNotFoundException

Specified by:

classForName in interface TypeLoader

Throws:

ClassNotFoundException

typeForName

public Type typeForName(String name)
                 throws ClassNotFoundException

Specified by:

typeForName in interface TypeLoader

Throws:

ClassNotFoundException

setCurrent

public static void setCurrent(RegistryContext current)

current

public static Registry current()

getStaticsDirectory

public final Item getStaticsDirectory()

The static Directory contains the statics import that are added in RGG classes by defaults. This directory contains the sub directories /methods , /variables , and /classes. The elements from that directory are used for the function browser, and the autocompletion.

Returns:

addContentDescription

public void addContentDescription(HashMap<String,ContentDescriptionType[]> contents)

Add the ContentDescriptionTypes to the registry. These types are loaded into every rgg model by default. These elements can be used for the display in the FunctionBrowser and the AutoCompletors.

Parameters:

methods -