org.netbeans.modules.schema2beans

Class DDRegistry

java.lang.Object

org.netbeans.modules.schema2beans.DDRegistry

public class DDRegistry
extends Object

The intent of this class is to provide a schema2beans graph registry, where the graphs are stored by unique name and type. Combined with the DDRegistryParser, the DDRegistry provides a sort of meta-schema2beans graph where we can ask for all the graphs of one type and ask for a parser on any set of graphs. These are the two main goals of this class. 1. provide a common and central place where we can keep track of all the graphs that we have created. Naming the graphs by unique name and type allows to get either one specific graph or a set of graphs. 2. provide a meta-schema2beans graph view for parsing any set of graphs. For example, to get a parser on all the graphs of type 'ejb' (assuming we registered graphs of this type). Therefore, this class provides two kind of methods: to add/remove graphs to the registry and to create a DDRegistry parser. A DDRegistryParser is an Iterator that returns all the elements described a schema2beans tree path. The registry also provides a convenient class (DDChangeMarker) that helps keeping track of any change.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DDRegistry.ChangeTracer
static class	DDRegistry.DDChangeMarker The goal of this class is to provide a simple way to know if a graph or a set of graphs had their content changed.

Constructor Summary

Constructors

Constructor and Description
DDRegistry()

Method Summary

Modifier and Type	Method and Description
void	addType(BaseBean bean, String type) Add a type to the entry (the type doesn't have to be unique)
void	clearCache() Reset the change timestamp of all the registered graphs.
void	clearCache(BaseBean bean) Reset the change timestamp of the specified graph.
DDRegistry.DDChangeMarker	createChangeMarker() This return a new change marker instance, that can be used to know if any graph of the registry has changed.
void	createEntry(BaseBean bean, String ID, String name) Create a new entry in the DD graph registry.
static String	createGraphName(String s)
String	dump() Trace/debug method.
String	dumpAll() Trace/debug method.
static String	getGraphName(String s)
String	getID(BaseBean bean) Having a schema2beans graph, this method return its unique ID.
String	getID(DDRegistryParser.DDCursor c) Return the unique ID of the graph where the cursor points to.
String	getName(DDRegistryParser.DDCursor c) Same as getID but return the non unique name.
String	getName(String ID) Return the name of the unique graph ID
BaseBean	getRoot(String s) Return the bean root for this name (either unique name or scope)
BaseBean[]	getRoots(String s) Return all the bean roots for this name (either unique name or scope)
long	getTimestamp(BaseBean bean)
boolean	hasGraph(String str)
boolean	hasGraph(String str, DDRegistryParser.DDCursor c)
boolean	hasType(BaseBean bean, String type) Return true of the specified schema2beans graph is registered with the specified type.
DDRegistryParser.DDCursor	newCursor(BaseBean bean) Create a cursor location
DDRegistryParser.DDCursor	newCursor(DDRegistryParser.DDCursor c, String path) Create a cursor location
DDRegistryParser.DDCursor	newCursor(String path) Create a cursor location
DDRegistryParser	newParser(DDRegistryParser.DDCursor cursor, String path) Create a new DDRegistryParser based on a current position in a graph and a schema2beans path.
DDRegistryParser	newParser(DDRegistryParser parser, String path) Create a new DDRegistryParser (parser on a set of graph), based on another parser current location and schema2beans path.
DDRegistryParser	newParser(String scope) Create a DDRegistryParser based on a scope value.
void	removeEntry(BaseBean bean) Remove an entry in the registry.
void	removeEntry(String ID) Remove a registry entry.
void	renameEntry(String oldID, String newID) Rename a graph unique ID to a new unique ID.
void	renameEntry(String oldID, String newID, String newName) Rename a graph entry unique ID to a new unique ID entry and new non unique name.
void	setTimestamp(BaseBean bean)
void	updateEntry(String ID, BaseBean bean) Change the schema2beans graph for the unique entry ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

DDRegistry

public DDRegistry()

Method Detail

createEntry

public void createEntry(BaseBean bean,
                        String ID,
                        String name)

Create a new entry in the DD graph registry. The schema2beans graph bean is added to registry using a unique name (ID), such as a unique internal identifier, and a non unique name (name), such as a display name. Any number of non unique type can also be associated to a graph entry, see the method addType.

updateEntry

public void updateEntry(String ID,
                        BaseBean bean)

Change the schema2beans graph for the unique entry ID. This method might be used if another graph should replace an existing entry.

removeEntry

public void removeEntry(BaseBean bean)

Remove an entry in the registry.

renameEntry

public void renameEntry(String oldID,
                        String newID,
                        String newName)

Rename a graph entry unique ID to a new unique ID entry and new non unique name.

renameEntry

public void renameEntry(String oldID,
                        String newID)

Rename a graph unique ID to a new unique ID.

removeEntry

public void removeEntry(String ID)

Remove a registry entry.

createChangeMarker

public DDRegistry.DDChangeMarker createChangeMarker()

This return a new change marker instance, that can be used to know if any graph of the registry has changed.

hasType

public boolean hasType(BaseBean bean,
                       String type)

Return true of the specified schema2beans graph is registered with the specified type.

clearCache

public void clearCache()

Reset the change timestamp of all the registered graphs.

clearCache

public void clearCache(BaseBean bean)

Reset the change timestamp of the specified graph.

setTimestamp

public void setTimestamp(BaseBean bean)

getTimestamp

public long getTimestamp(BaseBean bean)

getID

public String getID(BaseBean bean)

Having a schema2beans graph, this method return its unique ID.

getID

public String getID(DDRegistryParser.DDCursor c)

Return the unique ID of the graph where the cursor points to. Note that a DDCursor is a location reference (pointer to any schema2beans graph) in any graph of the registry.

getName

public String getName(DDRegistryParser.DDCursor c)

Same as getID but return the non unique name.

newParser

public DDRegistryParser newParser(DDRegistryParser parser,
                                  String path)

Create a new DDRegistryParser (parser on a set of graph), based on another parser current location and schema2beans path.

newParser

public DDRegistryParser newParser(DDRegistryParser.DDCursor cursor,
                                  String path)

Create a new DDRegistryParser based on a current position in a graph and a schema2beans path.

newParser

public DDRegistryParser newParser(String scope)

Create a DDRegistryParser based on a scope value. A scope value is either a unique graph name or a type value. If more than one graph are registered under the type specified, the parser will go through all the graphs. If the ID is specified or the scope is a one graph type, the the parser will go through only the specified graph. The scope syntax is: [name]

newCursor

public DDRegistryParser.DDCursor newCursor(DDRegistryParser.DDCursor c,
                                           String path)

Create a cursor location

newCursor

public DDRegistryParser.DDCursor newCursor(String path)

Create a cursor location

newCursor

public DDRegistryParser.DDCursor newCursor(BaseBean bean)

Create a cursor location

addType

public void addType(BaseBean bean,
                    String type)

Add a type to the entry (the type doesn't have to be unique)

getName

public String getName(String ID)

Return the name of the unique graph ID

dump

public String dump()

Trace/debug method. Return the list of all the registered graphs

dumpAll

public String dumpAll()

Trace/debug method. Return the XML content of all the registered graphs.

getGraphName

public static String getGraphName(String s)

hasGraph

public boolean hasGraph(String str)

hasGraph

public boolean hasGraph(String str,
                        DDRegistryParser.DDCursor c)

createGraphName

public static String createGraphName(String s)

getRoot

public BaseBean getRoot(String s)

Return the bean root for this name (either unique name or scope)

getRoots

public BaseBean[] getRoots(String s)

Return all the bean roots for this name (either unique name or scope)