org.dmd.dms

Class SchemaDefinition

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.dms.generated.dmw.DSDefinitionDMW

org.dmd.dms.DSDefinition

org.dmd.dms.generated.dmw.DmsDefinitionDMW

org.dmd.dms.DmsDefinition

org.dmd.dms.generated.dmw.SchemaDefinitionDMW

org.dmd.dms.SchemaDefinition

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

DmconcinnitySchemaAG, DmgSchemaAG, DmpSchemaAG, DmrbaseSchemaAG, DmrldapSchemaAG, DmtdlSchemaAG, DmtSchemaAG, DmuSchemaAG, DmvSchemaAG, DsdASchemaAG, DsdBSchemaAG, DsdCSchemaAG, MetaSchemaAG

public class SchemaDefinition
extends SchemaDefinitionDMW

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	defsCompleteV
protected TreeMap<String,String>	dependsOnSchemaClasses
protected boolean	generatedSchema
protected String	staticRefName
protected String	version

Fields inherited from class org.dmd.dms.DmsDefinition

metaname

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
	SchemaDefinition() Default constructor.
protected	SchemaDefinition(String mn)

Method Summary

Modifier and Type	Method and Description
void	addDefinition(DmsDefinition def) Attempts to add the specified definition to the schema.
void	addParsedRule(DmcUncheckedObject uco) Add the parsed rules
int	attributeChanges(SchemaDefinition pred, StringBuffer sb, SchemaManager currManager) Determines if this version of the schema contains different attributes compared to its predecessor.
int	classChanges(SchemaDefinition pred, StringBuffer sb) Determines if this version of the schema contains different classes compared to its predecessor.
boolean	defsComplete()
void	dumpInfo()
DynamicCompactSchema	getCompactSchema()
String	getDependsOnClass(String schemaName)
String	getDMSASGImport()
String	getDMSASGName()
String	getDmwPackage(String context)
SchemaDefinition	getInstance() Generated schemas overload this method to provide access to their initialized information.
Iterator<DmcUncheckedObject>	getParsedRules()
Iterator<RuleDataDMO>	getParsedRulesDMOs(SchemaManager sm) This method will return the parsed rules translated into DMOs.
TreeMap<RuleName,RuleIF>	getResolvedRules() Called when we're formatting the compact schema rule data.
TreeMap<RuleName,RuleIF>	getRuleInstances(SchemaManager sm) Get the rule instances
String	getStaticRefName() Returns the name of this schema as it would be referred to in a static reference.
String	getVersion() The version at which something was introduced.
boolean	hasParsedRules()
boolean	isGeneratedSchema() Indicates if this schema definition exists as code of has been read on the fly.
void	setResolvedRules(TreeMap<RuleName,RuleIF> rr) Called when resolveReferences is performed on a schema manager being used by the DmsSchemaParser.
void	setVersion(String v)
int	typeChanges(SchemaDefinition pred, StringBuffer sb) Determines if this version of the schema contains different types compared to its predecessor.

Methods inherited from class org.dmd.dms.generated.dmw.SchemaDefinitionDMW

addActionDefList, addAttributeDefList, addClassDefList, addComplexTypeDefList, addDefFiles, addDependsOn, addDependsOnRef, addDmwTypeToPackage, addDsdModuleList, addEnumDefList, addExtendedReferenceTypeDefList, addInternalTypeDefList, addRuleCategoryList, addRuleDataList, addRuleDefinitionList, addSchemaExtension, addSliceDefList, addTypeDefList, getActionDefList, getActionDefListSize, getAttributeDefList, getAttributeDefListSize, getClassDefList, getClassDefListSize, getComplexTypeDefList, getComplexTypeDefListSize, getCreateAttributeFactory, getDefFiles, getDefFilesSize, getDependsOn, getDependsOnRef, getDependsOnRefSize, getDependsOnSize, getDMO, getDmwPackage, getDmwTypeToPackage, getDmwTypeToPackageSize, getDsdModuleList, getDsdModuleListSize, getEnumDefList, getEnumDefListSize, getExtendedReferenceTypeDefList, getExtendedReferenceTypeDefListSize, getGeneratedFileHeader, getInternalTypeDefList, getInternalTypeDefListSize, getName, getObjectName, getObjectNameAttribute, getRuleCategoryList, getRuleCategoryListSize, getRuleDataList, getRuleDataListSize, getRuleDefinitionList, getRuleDefinitionListSize, getSchemaBaseID, getSchemaExtension, getSchemaExtensionSize, getSchemaIDRange, getSchemaPackage, getSliceDefList, getSliceDefListSize, getTypeDefList, getTypeDefListSize, setCreateAttributeFactory, setDmcObject, setDmwPackage, setGeneratedFileHeader, setName, setSchemaBaseID, setSchemaIDRange, setSchemaPackage

Methods inherited from class org.dmd.dms.DmsDefinition

getDmcObject

Methods inherited from class org.dmd.dms.generated.dmw.DmsDefinitionDMW

addRelatedToConcept, getRelatedToConcept, getRelatedToConceptSize

Methods inherited from class org.dmd.dms.DSDefinition

equals, getFullDotName, getNameOfModuleWhereThisCameFrom

Methods inherited from class org.dmd.dms.generated.dmw.DSDefinitionDMW

addComment, addDescription, addExample, addNvp, addOptimize, addQuestion, addSkip, addTags, getComment, getCommentSize, getDefinedIn, getDescription, getDescriptionSize, getDescriptionWithNewlines, getDmoFromModule, getDotName, getExample, getExampleSize, getFile, getHint, getLineNumber, getNvp, getNvpSize, getObsolete, getOptimize, getOptimizeSize, getQuestion, getQuestionSize, getRelationship, getSearchable, getSkip, getSkipSize, getSortName, getTags, getTagsSize, getWhy, setDefinedIn, setDmoFromModule, setDotName, setFile, setHint, setLineNumber, setObsolete, setRelationship, setSearchable, setSortName, setVersion, setWhy

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, equals, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, toJSON, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer

getDeleted, getModifier, setDeleted, setModifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dmd.dmc.DmcNamedObjectIF

equals

Methods inherited from interface org.dmd.dmc.definitions.DmcDefinitionIF

getDefinedIn, getDotName, toOIF

Field Detail

staticRefName

protected String staticRefName

defsCompleteV

protected boolean defsCompleteV

version

protected String version

dependsOnSchemaClasses

protected TreeMap<String,String> dependsOnSchemaClasses

generatedSchema

protected boolean generatedSchema

Constructor Detail

SchemaDefinition

public SchemaDefinition()

Default constructor.

SchemaDefinition

protected SchemaDefinition(String mn)
                    throws DmcValueException

Throws:

DmcValueException

Method Detail

getDependsOnClass

public String getDependsOnClass(String schemaName)

getInstance

public SchemaDefinition getInstance()
                             throws DmcValueException

Generated schemas overload this method to provide access to their initialized information.

Returns:

The schema instance.

Throws:

DmcValueException - if problems with instantiation values

getDmwPackage

public String getDmwPackage(String context)

Parameters:

context - the generation context

Returns:

the wrapper package for the specified DMW type if it has been specified via the dmwTypeToPackage attribute on a schema.

getDMSASGName

public String getDMSASGName()

getDMSASGImport

public String getDMSASGImport()

isGeneratedSchema

public boolean isGeneratedSchema()

Indicates if this schema definition exists as code of has been read on the fly.

Returns:

true if it's generated.

getStaticRefName

public String getStaticRefName()

Returns the name of this schema as it would be referred to in a static reference. For example org.dmd.dmr.server.ldap.generated.DmrLdapSchemaAG

Returns:

The name of the schema when used in a static context.

defsComplete

public boolean defsComplete()

Returns:

true if our initializeDefs() function has been called.

setVersion

public void setVersion(String v)

getVersion

public String getVersion()

Description copied from class: DSDefinitionDMW

The version at which something was introduced. Version names\n are assumed to be lexicographically sortable i.e. the name of a version must have a nautral\n sort order that increases.

Overrides:

getVersion in class DSDefinitionDMW

Returns:

the String

dumpInfo

public void dumpInfo()

classChanges

public int classChanges(SchemaDefinition pred,
                        StringBuffer sb)

Determines if this version of the schema contains different classes compared to its predecessor.

Parameters:

pred - the predecessor

sb - place to store class changes

Returns:

the number of class changes

attributeChanges

public int attributeChanges(SchemaDefinition pred,
                            StringBuffer sb,
                            SchemaManager currManager)

Determines if this version of the schema contains different attributes compared to its predecessor.

Parameters:

pred - the prdecessor

sb - place to store changes

currManager - the current schema manager

Returns:

the number of attribute changes

typeChanges

public int typeChanges(SchemaDefinition pred,
                       StringBuffer sb)

Determines if this version of the schema contains different types compared to its predecessor.

Parameters:

pred - the prdecessor

sb - place to store changes

Returns:

the number of type changes

addDefinition

public void addDefinition(DmsDefinition def)
                   throws ResultException,
                          DmcValueException

Attempts to add the specified definition to the schema. This method is generally only used by code that reads schemas such at the DmsSchemaParser.

Parameters:

def - the definition to be added

Throws:

ResultException - if something goes wrong

DmcValueException - if values are incorrect

getParsedRules

public Iterator<DmcUncheckedObject> getParsedRules()

Returns:

the parsed rules

hasParsedRules

public boolean hasParsedRules()

Returns:

true if there are rules

getParsedRulesDMOs

public Iterator<RuleDataDMO> getParsedRulesDMOs(SchemaManager sm)
                                         throws DmcNameClashException

This method will return the parsed rules translated into DMOs.

Parameters:

sm - the schema manager used by our Dmo

Returns:

the rule data

Throws:

DmcNameClashException - if rule names clash

setResolvedRules

public void setResolvedRules(TreeMap<RuleName,RuleIF> rr)

Called when resolveReferences is performed on a schema manager being used by the DmsSchemaParser.

Parameters:

rr - the rules

getResolvedRules

public TreeMap<RuleName,RuleIF> getResolvedRules()

Called when we're formatting the compact schema rule data.

Returns:

the resolved rules

getRuleInstances

public TreeMap<RuleName,RuleIF> getRuleInstances(SchemaManager sm)
                                          throws DmcNameClashException

Get the rule instances

Parameters:

sm - the schema manager

Returns:

the rule by name

Throws:

DmcNameClashException - if name clashes occur

addParsedRule

public void addParsedRule(DmcUncheckedObject uco)
                   throws ResultException,
                          DmcValueException

Add the parsed rules

Parameters:

uco - an unchecked object that represents rule data

Throws:

ResultException - if anything goes wrong

DmcValueException - if values are incorrect

getCompactSchema

public DynamicCompactSchema getCompactSchema()

Returns:

the compact schema representation