org.dmd.dmc

Class DmcOmni

java.lang.Object

org.dmd.dmc.DmcOmni

All Implemented Interfaces:

DmcNameResolverIF

Direct Known Subclasses:

DmwOmni

public class DmcOmni
extends Object
implements DmcNameResolverIF

The DmcOmni (short for omnipresent) provides a single point of access to information and settings that is useful in the operational environment of Dark Matter Objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected static DmcOmni	omni

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DmcOmni() Protected constructor called when the omni singleton is required.

Method Summary

Modifier and Type	Method and Description
void	addCompactSchema(DmcCompactSchemaIF schema) Dark Matter Schema Auto Generated (DMSAGs) are generated by the DMO Generator utility and placed in the generated/dmo folder.
void	addResolver(DmcNameResolverIF res) Adds a name resolver.
boolean	autoResolution()
void	autoResolution(boolean f) Turns auto resolution on/off.
boolean	backRefTracking()
void	backRefTracking(boolean f) Turns backref tracking on/off.
DmcTypeDmcObjectName<?>	buildName(DmcObjectName name)
boolean	cleanUpDeadRefs()
void	cleanUpDeadRefs(boolean f) Turns clean up of dead references on/off.
void	dumpASAG() This method displays the currently loaded attribute schemas in dmdID order.
DmcObject	findNamedDMO(DmcObjectName name) The DmcOmni can act as a global name resolver.
DmcNamedObjectIF	findNamedObject(DmcObjectName name) The DmcOmni can act as a global name resolver.
DmcNamedObjectIF	findNamedObject(DmcObjectName name, int attributeID) Finds a named object based on its name and indicates the attribute via which the reference is being made.
DmcAttributeInfo	getAttributeInfo(String an) Tries to find the specified attribute by its name.
DmcClassInfo	getClassInfo(Integer id) Tries to find the specified class by its id.
DmcClassInfo	getClassInfo(String cn) Tries to find the specified class by its name.
DmcAttributeInfo	getInfo(Integer id) Returns the DmcAttributeInfo associate with the ID or complains bitterly that you've forgotten to prime the DmcOmni with the generated DMSchemaAG related to the identifier in question.
DmcSliceInfo	getSliceInfo(String name) Returns the slice information if it's available.
DmcTypeInfo	getTypeInfo(String tn)
static DmcOmni	instance()
boolean	lazyResolution()
void	lazyResolution(boolean f) Turns lazy resolution on/off.
TreeMap<String,DmcCompactSchemaIF>	loadedCompactSchemas()
void	logDeadReference(DmcObject referrer, DmcAttribute<?> viaAttribute, DmcObjectName referenceTo) This method is called from DmcTypeNamedObjectREF when it is unable to resolve a reference.
DmcLoggerIF	logger()
void	logger(DmcLoggerIF l) Sets the logger.
void	removeReferences(DmcTypeModifierMV mods)
void	reset() Resets the DmcOmni to its initial state.
void	ruleAdded(String info)
void	ruleExecuted(String info)
void	ruleFailed(DmcRuleExceptionSet errors)
void	ruleTracer(RuleTracerIF t)
boolean	ruleTracing()
void	ruleTracing(boolean f)
void	setCacheIF(DmcCacheIF c) Sets the implementor of the DmcCacheIF that will be notified when objects with backrefs are deleted.
void	setTrackSchemaReferences(boolean f) This method should be used with caution! Generally, we don't attempt to perform back reference tracking on schema related references, but, in certain tools/utilities, we make use of this functionality.
boolean	trackThisAttribute(int attributeID) This method is called from the DmcObject to determine whether or not are particular attribute should have its reference tracked.

Methods inherited from class java.lang.Object

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

Field Detail

omni

protected static DmcOmni omni

Constructor Detail

DmcOmni

protected DmcOmni()

Protected constructor called when the omni singleton is required.

Method Detail

reset

public void reset()

Resets the DmcOmni to its initial state.

instance

public static DmcOmni instance()

loadedCompactSchemas

public TreeMap<String,DmcCompactSchemaIF> loadedCompactSchemas()

Returns:

the loaded schemas.

setTrackSchemaReferences

public void setTrackSchemaReferences(boolean f)

This method should be used with caution! Generally, we don't attempt to perform back reference tracking on schema related references, but, in certain tools/utilities, we make use of this functionality.

Parameters:

f - Set to true if we want perform back reference tracking on schema related objects.

trackThisAttribute

public boolean trackThisAttribute(int attributeID)

This method is called from the DmcObject to determine whether or not are particular attribute should have its reference tracked.

Parameters:

attributeID -

Returns:

true if we want to reference track the attribute.

backRefTracking

public boolean backRefTracking()

Returns:

true if DMO back reference tracking should be performed.

backRefTracking

public void backRefTracking(boolean f)

Turns backref tracking on/off.

Parameters:

f - set to true to turn it on.

lazyResolution

public boolean lazyResolution()

Returns:

true if lazy resolution is turned on.

lazyResolution

public void lazyResolution(boolean f)

Turns lazy resolution on/off.

Parameters:

f - set to true to turn it on.

autoResolution

public boolean autoResolution()

Returns:

true if auto resolution is turned on.

autoResolution

public void autoResolution(boolean f)

Turns auto resolution on/off.

Parameters:

f - set to true to turn it on.

cleanUpDeadRefs

public boolean cleanUpDeadRefs()

Returns:

true if clean up of dead references is turned on.

cleanUpDeadRefs

public void cleanUpDeadRefs(boolean f)

Turns clean up of dead references on/off.

Parameters:

f - set to true to turn it on.

logger

public DmcLoggerIF logger()

Returns:

the logger if it has been set.

logger

public void logger(DmcLoggerIF l)

Sets the logger.

Parameters:

l - the logger.

logDeadReference

public void logDeadReference(DmcObject referrer,
                             DmcAttribute<?> viaAttribute,
                             DmcObjectName referenceTo)

This method is called from DmcTypeNamedObjectREF when it is unable to resolve a reference.

Parameters:

referrer - The object that had the reference.

viaAttribute - The object reference attribute.

referenceTo - The name that couldn't be resolved.

addResolver

public void addResolver(DmcNameResolverIF res)

Adds a name resolver. Any number of resolvers may be added. When resolving a name, the resolvers will be consulted in the order in which they were added. Name resolution stops after the first positive name resolution, meaning that your name resolvers should have mutually exclusive name spaces.

Parameters:

res - The name resolver.

addCompactSchema

public void addCompactSchema(DmcCompactSchemaIF schema)

Dark Matter Schema Auto Generated (DMSAGs) are generated by the DMO Generator utility and placed in the generated/dmo folder. DMSAGs contain a mapping from Dark Matter Data IDs (dmdID) to the attributes/classes they identify). Since dmdIDs are the only things stored at the DmcAttribute level, we have to be able to access the DmcAttributeInfo when it is lost in whatever communication mechanism is being used between client/server, browser/servlet etc. The DmcOmni provides access to these mappings.

Parameters:

schema -

buildName

public DmcTypeDmcObjectName<?> buildName(DmcObjectName name)

setCacheIF

public void setCacheIF(DmcCacheIF c)

Sets the implementor of the DmcCacheIF that will be notified when objects with backrefs are deleted.

Parameters:

c - The cache.

removeReferences

public void removeReferences(DmcTypeModifierMV mods)

getClassInfo

public DmcClassInfo getClassInfo(String cn)

Tries to find the specified class by its name.

Parameters:

cn - The class name.

Returns:

The class info if it's available.

getClassInfo

public DmcClassInfo getClassInfo(Integer id)

Tries to find the specified class by its id.

Parameters:

id - The class id.

Returns:

The class info if it's available.

getTypeInfo

public DmcTypeInfo getTypeInfo(String tn)

Parameters:

tn - the type name

Returns:

the type info.

getInfo

public DmcAttributeInfo getInfo(Integer id)

Returns the DmcAttributeInfo associate with the ID or complains bitterly that you've forgotten to prime the DmcOmni with the generated DMSchemaAG related to the identifier in question. This method is usually called by base classes like DmcAttribute when it's trying to dump things in OIF format.

Parameters:

id - The attribute's ID.

Returns:

the attribute info for the specified ID.

getAttributeInfo

public DmcAttributeInfo getAttributeInfo(String an)

Tries to find the specified attribute by its name.

Parameters:

an - The attribute name.

Returns:

The attribute info if it's available.

findNamedDMO

public DmcObject findNamedDMO(DmcObjectName name)

The DmcOmni can act as a global name resolver. This method will attempt to find the named object in any name resolvers that have been registered.

Specified by:

findNamedDMO in interface DmcNameResolverIF

Parameters:

name - the name of the object

Returns:

A Dark Matter Object.

findNamedObject

public DmcNamedObjectIF findNamedObject(DmcObjectName name)

The DmcOmni can act as a global name resolver. This method will attempt to find the named object in any name resolvers that have been registered.

Specified by:

findNamedObject in interface DmcNameResolverIF

Returns:

the named object.

findNamedObject

public DmcNamedObjectIF findNamedObject(DmcObjectName name,
                                        int attributeID)

Description copied from interface: DmcNameResolverIF

Finds a named object based on its name and indicates the attribute via which the reference is being made. This method is used via the DmcObject and is primarily intended to handle the situation where we must resolve internal type definitions as opposed to class definitions. This is due to the fact that we create internal type definitions for classes that have the same name as the associated classes.

Specified by:

findNamedObject in interface DmcNameResolverIF

Parameters:

name - the name of an object

attributeID - the attribute by which it is named

Returns:

the named object

dumpASAG

public void dumpASAG()

This method displays the currently loaded attribute schemas in dmdID order.

getSliceInfo

public DmcSliceInfo getSliceInfo(String name)

Returns the slice information if it's available. Slice information is generated for SliceDefinitions specified as part of your schema and indicate a subset of attributes to be returned in a GetResponse.

Parameters:

name - the name of the slice.

Returns:

The slice information if it's available.

ruleTracing

public boolean ruleTracing()

ruleTracing

public void ruleTracing(boolean f)

ruleTracer

public void ruleTracer(RuleTracerIF t)

ruleExecuted

public void ruleExecuted(String info)

ruleAdded

public void ruleAdded(String info)

ruleFailed

public void ruleFailed(DmcRuleExceptionSet errors)