org.dmd.dms.util

Class DmsSchemaParser

java.lang.Object

org.dmd.dms.util.DmsSchemaParser

All Implemented Interfaces:

DmcNameClashResolverIF, SchemaDefinitionListenerIF, DmcUncheckedOIFHandlerIF

public class DmsSchemaParser
extends Object
implements DmcUncheckedOIFHandlerIF, SchemaDefinitionListenerIF, DmcNameClashResolverIF

This class parses files that conform to the Information Model Definition (IMD) schema and stores them in an SchemaManager.

Constructor Summary

Constructors

Constructor and Description
DmsSchemaParser(SchemaManager sm, ConfigFinder f) Creates a new schema parser.

Method Summary

Modifier and Type	Method and Description
void	checkRules(SchemaDefinition sd)
void	definitionAdded(DmsDefinitionDMO def)
void	handleObject(DmcUncheckedObject uco, String infile, int lineNumber) We handle the various schema related objects.
SchemaDefinition	parseSchema(SchemaManager am, String schemaName, boolean terse) Parses the specified DMS file and any other schemas on which it depends.
DmcNamedObjectIF	resolveClash(DmcObject obj, DmcAttributeInfo ai, DmcNameClashObjectSet<?> ncos) The clash resolver will overload this method to attempt to resolve the name clash.

Methods inherited from class java.lang.Object

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

Constructor Detail

DmsSchemaParser

public DmsSchemaParser(SchemaManager sm,
                       ConfigFinder f)
                throws ResultException

Creates a new schema parser.

Parameters:

sm - A base level schema manager i.e. a newly created SchemaManager.

f - A schema finder that has already been called up to find schemas.

Throws:

ResultException

Method Detail

parseSchema

public SchemaDefinition parseSchema(SchemaManager am,
                                    String schemaName,
                                    boolean terse)
                             throws ResultException,
                                    DmcValueException,
                                    DmcRuleExceptionSet,
                                    DmcNameClashException

Parses the specified DMS file and any other schemas on which it depends.

If the checkRules flag is true, we also dynamically instantiate and validate the defined rules against themselves, which is tricky. The other aspect of this which is tricky has to do with the fact that the class path must be configured properly for this to work in situations where there are other code packages beyond the base dark-matter ones i.e. in situations where you're building a code base using just the dark-matter JARs. Code generation/compilation has to take place first and then the rules have to be checked separately. See the DmoGenUtility on how to accomplish this.

Parameters:

am - A base level manager that will be populated with the schemas we parse. This should be a newly constructed schema manager.

schemaName - The name of the schema. Schema specifications are found in files with a .dms extension that have been found by the DmsSchemaFinder.

terse - If true, only the name of the schema being parsed is displayed on System.out otherwise, the name of each file being read is printed.

Returns:

The requested schema is returned if all goes well, otherwise null is returned. NOTE: If WARNINGs are encountered, we still the schema - just check for the presence of WARNINGs on the result set when parsing is complete.

Throws:

ResultException

DmcValueException

DmcValueExceptionSet

DmcRuleExceptionSet

DmcNameClashException

checkRules

public void checkRules(SchemaDefinition sd)
                throws DmcRuleExceptionSet,
                       DmcNameClashException,
                       DmcValueException

Throws:

DmcRuleExceptionSet

DmcNameClashException

DmcValueException

handleObject

public void handleObject(DmcUncheckedObject uco,
                         String infile,
                         int lineNumber)
                  throws ResultException,
                         DmcValueException,
                         DmcRuleExceptionSet,
                         DmcNameClashException

We handle the various schema related objects.

Specified by:

handleObject in interface DmcUncheckedOIFHandlerIF

Parameters:

uco - The object to be handled.

infile - Name of the file from which the object was loaded.

lineNumber - The line in the file where the object ended.

Throws:

ResultException

DmcValueException

DmcRuleExceptionSet

DmcNameClashException

DmcValueExceptionSet

definitionAdded

public void definitionAdded(DmsDefinitionDMO def)

Specified by:

definitionAdded in interface SchemaDefinitionListenerIF

resolveClash

public DmcNamedObjectIF resolveClash(DmcObject obj,
                                     DmcAttributeInfo ai,
                                     DmcNameClashObjectSet<?> ncos)
                              throws DmcValueException

Description copied from interface: DmcNameClashResolverIF

The clash resolver will overload this method to attempt to resolve the name clash.

Specified by:

resolveClash in interface DmcNameClashResolverIF

Parameters:

obj - the object on which resolveReferences() has been called

ai - the info for the attribute being resolved

ncos - the objects whose names clash

Returns:

the appropriate object

Throws:

DmcValueException - if the appropriate can't be determined