org.dmd.dms

Class ClassDefinition

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.ClassDefinitionDMW

org.dmd.dms.ClassDefinition

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

public class ClassDefinition
extends ClassDefinitionDMW

Field Summary

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
	ClassDefinition() Default constructor.
	ClassDefinition(ClassDefinitionDMO obj)
	ClassDefinition(ClassDefinitionDMO obj, DmcClassInfo dci)
protected	ClassDefinition(String mn) Default constructor used in creating the meta schema.

Method Summary

Modifier and Type	Method and Description
void	addImportsForAdditionalAttributes(SchemaManager sm, ImportManager imports, DmcUncheckedObject uco) This method is used in conjunction with the rule instantiation mechanisms.
void	adjustJavaClass() Complicated stuff to handle generation of wrapper classes in packages other than where the DMOs are generated.
void	adjustJavaClass(String genContext, String genSuffix) Complicated stuff to handle generation of wrapper classes in packages other than where the DMOs are generated for different generation contexts.
boolean	allowsParent(ClassDefinition parent) Checks if the specified class of object is a valid parent for this class of object.
int	derivationDepth()
boolean	generateWrapper(String context) Determines whether or not we want to generate a wrapper for this class of object in the specified context.
TreeMap<DefinitionName,AttributeDefinition>	getAllAttributesAtThisLevel()
TreeMap<DefinitionName,ClassDefinition>	getAllDerived() Returns the allderived variable which holds a Hashmap of all classes that derive from this class
ArrayList<ClassDefinition>	getAllImplemented() Returns all implemented interfaces.
ArrayList<ClassDefinition>	getAllImplementors()
TreeMap<DefinitionName,AttributeDefinition>	getAllMay()
TreeMap<DefinitionName,AttributeDefinition>	getAllMust()
TreeMap<DefinitionName,ClassDefinition>	getAllowedSubcomps() Returns the set of allowed subcomponents for this class.
ArrayList<ClassDefinition>	getBaseClasses() Returns the complete set of base classes from which this class is derived.
DmcClassInfo	getClassInfo()
Iterator<RuleDataDMO>	getClassRules()
void	getDerivedClassesDepthFirst(ArrayList<ClassDefinition> classes) This method will add this class to the classes array and then be called recursively for all derived classes.
String	getDMWPackage() If the schema in which this class is defined has a dmwPackage attribute defined, this function returns that value.
String	getDmwPackage(String context)
WrapperTypeEnum	getDmwWrapperType(String context)
DmcClassInfo	getDynamicClassInfo()
TreeMap<DefinitionName,AttributeDefinition>	getFullAttrMap()
String	getShortestName() Returns the shortest possible name for this class definition.
AttributeDefinition	hasAttribute(DefinitionName attrName) Returns the attribute definition is this class uses the specified attribute.
AttributeDefinition	hasAttribute(String name)
boolean	hasRules()
boolean	isAllowedAttribute(DefinitionName name)
boolean	isInstanceOfThis(ClassDefinition cd)
boolean	isMust(DefinitionName name)
DmcObject	newDMOInstance() This function instantiates a new instance of the object type defined by this class definition.
DmwWrapper	newInstance() This function instantiates a new instance of the object type defined by this class definition.

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

addActions, addAllowedParents, addDerivedClasses, addDescription, addDmwWrapperType, addExcludeFromContext, addIntendedToExtend, addMay, addMust, addUsesWrapperInterface, getAbbrev, getActions, getActionsSize, getAllowedParents, getAllowedParentsSize, getClassType, getCreateIndex, getDataType, getDerivedClasses, getDerivedClassesSize, getDerivedFrom, getDescription, getDescriptionSize, getDescriptionWithNewlines, getDmdID, getDmeClass, getDmeImport, getDMO, getDmoAuxClass, getDmoAuxClassImport, getDmoClass, getDmoImport, getDmtClass, getDmtImport, getDmtREFImport, getDmwAuxClass, getDmwAuxClassImport, getDmwClass, getDmwImport, getDmwIteratorClass, getDmwIteratorImport, getDmwWrapperType, getDmwWrapperTypeSize, getDsdModuleDefinition, getExcludeFromContext, getExcludeFromContextSize, getIntendedToExtend, getIntendedToExtendSize, getInternallyGenerated, getInternalTypeRef, getIsDSDefinition, getIsNamedBy, getJavaClass, getMay, getMaySize, getMust, getMustSize, getName, getObjectName, getObjectNameAttribute, getObsoleteVersion, getPartOfDefinitionModule, getRuleDefinition, getSubpackage, getSupportsBackrefTracking, getUsesInterface, getUsesWrapperInterface, getUsesWrapperInterfaceSize, getUseWrapperType, setAbbrev, setClassType, setCreateIndex, setDataType, setDerivedFrom, setDmcObject, setDmdID, setDmeClass, setDmeImport, setDmoAuxClass, setDmoAuxClassImport, setDmoClass, setDmoImport, setDmtClass, setDmtImport, setDmtREFImport, setDmwAuxClass, setDmwAuxClassImport, setDmwClass, setDmwImport, setDmwIteratorClass, setDmwIteratorImport, setDsdModuleDefinition, setInternallyGenerated, setInternalTypeRef, setIsDSDefinition, setIsNamedBy, setJavaClass, setName, setObsoleteVersion, setPartOfDefinitionModule, setRuleDefinition, setSubpackage, setSupportsBackrefTracking, setUsesInterface, setUseWrapperType

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, addExample, addNvp, addOptimize, addQuestion, addSkip, addTags, getComment, getCommentSize, getDefinedIn, getDmoFromModule, getDotName, getExample, getExampleSize, getFile, getHint, getLineNumber, getNvp, getNvpSize, getObsolete, getOptimize, getOptimizeSize, getQuestion, getQuestionSize, getRelationship, getSearchable, getSkip, getSkipSize, getSortName, getTags, getTagsSize, getVersion, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getDefinedIn, getDotName, toOIF

Methods inherited from interface org.dmd.dmc.DmcNamedObjectIF

equals

Constructor Detail

ClassDefinition

public ClassDefinition()

Default constructor.

ClassDefinition

public ClassDefinition(ClassDefinitionDMO obj)

ClassDefinition

public ClassDefinition(ClassDefinitionDMO obj,
                       DmcClassInfo dci)

ClassDefinition

protected ClassDefinition(String mn)
                   throws DmcValueException

Default constructor used in creating the meta schema.

Parameters:

mn - The meta name of the definition.

Throws:

DmcValueException

Method Detail

getClassInfo

public DmcClassInfo getClassInfo()

Returns:

the DmcClassInfo that was associated with this definition when it was constructed as part of the SchemaAG.

getDynamicClassInfo

public DmcClassInfo getDynamicClassInfo()

Returns:

the DmcClassInfo that was associated with this definition when it was constructed as part of the SchemaAG.

allowsParent

public boolean allowsParent(ClassDefinition parent)

Checks if the specified class of object is a valid parent for this class of object.

Parameters:

parent - The parent class.

Returns:

true if it's an allowed parent.

hasAttribute

public AttributeDefinition hasAttribute(String name)

isMust

public boolean isMust(DefinitionName name)

Parameters:

name - the name of an attribute.

Returns:

true if the attribute is a must have attribute in this class and false otherwise.

isAllowedAttribute

public boolean isAllowedAttribute(DefinitionName name)

hasAttribute

public AttributeDefinition hasAttribute(DefinitionName attrName)

Returns the attribute definition is this class uses the specified attribute.

Parameters:

attrName - The attribute name.

Returns:

The attribute definition or null if we don't have the attribute for this class.

getAllMust

public TreeMap<DefinitionName,AttributeDefinition> getAllMust()

getAllMay

public TreeMap<DefinitionName,AttributeDefinition> getAllMay()

getAllAttributesAtThisLevel

public TreeMap<DefinitionName,AttributeDefinition> getAllAttributesAtThisLevel()

Returns:

all must/may attributes just for this class

getFullAttrMap

public TreeMap<DefinitionName,AttributeDefinition> getFullAttrMap()

Returns:

the complete set of attributes for this class and all of its parent classes.

getAllImplemented

public ArrayList<ClassDefinition> getAllImplemented()

Returns all implemented interfaces.

Returns:

A list of all implemented interfaces.

getAllDerived

public TreeMap<DefinitionName,ClassDefinition> getAllDerived()

Returns the allderived variable which holds a Hashmap of all classes that derive from this class

getAllImplementors

public ArrayList<ClassDefinition> getAllImplementors()

getAllowedSubcomps

public TreeMap<DefinitionName,ClassDefinition> getAllowedSubcomps()

Returns the set of allowed subcomponents for this class.

newInstance

public DmwWrapper newInstance()
                       throws ResultException

This function instantiates a new instance of the object type defined by this class definition.

Throws:

ResultException

newDMOInstance

public DmcObject newDMOInstance()
                         throws ResultException

This function instantiates a new instance of the object type defined by this class definition.

Throws:

ResultException

isInstanceOfThis

public boolean isInstanceOfThis(ClassDefinition cd)

Parameters:

cd - the class against which we're testing

Returns:

true if we are the specific class or we're derived from it.

getBaseClasses

public ArrayList<ClassDefinition> getBaseClasses()

Returns the complete set of base classes from which this class is derived.

Returns:

The array of base classes or null if this class isn't derived from any class.

adjustJavaClass

public void adjustJavaClass()

Complicated stuff to handle generation of wrapper classes in packages other than where the DMOs are generated. This should only be used on internally generated type ref classes.

Throws:

DmcValueException

getDMWPackage

public String getDMWPackage()

If the schema in which this class is defined has a dmwPackage attribute defined, this function returns that value.

Returns:

The dmwPackage or null is it isn't defined.

adjustJavaClass

public void adjustJavaClass(String genContext,
                            String genSuffix)

Complicated stuff to handle generation of wrapper classes in packages other than where the DMOs are generated for different generation contexts.

Throws:

DmcValueException

getDmwPackage

public String getDmwPackage(String context)

getDmwWrapperType

public WrapperTypeEnum getDmwWrapperType(String context)

generateWrapper

public boolean generateWrapper(String context)

Determines whether or not we want to generate a wrapper for this class of object in the specified context. We ascend the class hierarchy and return false if any of our base classes are excluded.

Parameters:

context - The context

Returns:

true if we want to generate and false otherwise.

getShortestName

public String getShortestName()

Returns the shortest possible name for this class definition.

addImportsForAdditionalAttributes

public void addImportsForAdditionalAttributes(SchemaManager sm,
                                              ImportManager imports,
                                              DmcUncheckedObject uco)
                                       throws ResultException

This method is used in conjunction with the rule instantiation mechanisms. It will determine whether or not additional type imports are required for an extensible rule class, for example, the InitRule. These imports are required because we have to use the basic DmcObject mechanisms to add the values for the attributes to the extensible object.

This method also provides basic must/may checking of the specified attributes and will throw an exception for unknown attributes on a structural class.

Parameters:

imports - where we'll add the required imports.

uco - the rule data object.

Throws:

ResultException

hasRules

public boolean hasRules()

getClassRules

public Iterator<RuleDataDMO> getClassRules()

derivationDepth

public int derivationDepth()

Returns:

the depth of this class in a derivation hierarchy.

getDerivedClassesDepthFirst

public void getDerivedClassesDepthFirst(ArrayList<ClassDefinition> classes)

This method will add this class to the classes array and then be called recursively for all derived classes. This provides an ordered hierarchy of classes from the specified root.

Parameters:

classes - place to return the results