org.dmd.dmc

Class DmcClassInfo

java.lang.Object

org.dmd.dmc.DmcClassInfo

All Implemented Interfaces:

Comparable<DmcClassInfo>

public class DmcClassInfo
extends Object
implements Comparable<DmcClassInfo>

The DmcClassInfo class is a helper class that stores a small amount of information derived from a a ClassDefinition. This information is used to assist during object deserialization and may also be used in filtering.

Field Summary

Fields

Modifier and Type	Field and Description
ClassTypeEnum	classType
DataTypeEnum	dataType
DmcClassInfo	derivedFrom
String	dmoImport
int	id
String	name
DmcAttributeInfo	nameAttribute

Constructor Summary

Constructors

Constructor and Description
DmcClassInfo(String n, int i, ClassTypeEnum ct, DataTypeEnum dt, DmcClassInfo bc, DmcAttributeInfo na)
DmcClassInfo(String n, String di, int i, ClassTypeEnum ct, DataTypeEnum dt, DmcClassInfo bc, DmcAttributeInfo na)

Method Summary

Modifier and Type	Method and Description
void	addMay(DmcAttributeInfo info)
void	addMust(DmcAttributeInfo info)
boolean	allowsAttribute(DmcAttributeInfo ai)
DmcAttributeInfo	allowsAttribute(Integer id)
int	compareTo(DmcClassInfo dci)
boolean	equals(Object obj)
DmcAttributeInfo	getAttributeInfo(String an)
Iterator<DmcClassInfo>	getDerivedClasses()
Map<Integer,DmcAttributeInfoRef>	getIdToAttr()
int	hashCode()
boolean	isInstanceOf(int otherID) Checks to see if this class or any of its base classes matches the specified ID.
boolean	isInstanceOf(String className) Checks to see if this class or any of its base classes matches the specified class name.
boolean	isOptional(DmcAttributeInfo ai) Determines if the attribute is optional.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

public final String name

dmoImport

public final String dmoImport

id

public final int id

classType

public final ClassTypeEnum classType

dataType

public final DataTypeEnum dataType

derivedFrom

public final DmcClassInfo derivedFrom

nameAttribute

public final DmcAttributeInfo nameAttribute

Constructor Detail

DmcClassInfo

public DmcClassInfo(String n,
                    String di,
                    int i,
                    ClassTypeEnum ct,
                    DataTypeEnum dt,
                    DmcClassInfo bc,
                    DmcAttributeInfo na)

DmcClassInfo

public DmcClassInfo(String n,
                    int i,
                    ClassTypeEnum ct,
                    DataTypeEnum dt,
                    DmcClassInfo bc,
                    DmcAttributeInfo na)

Method Detail

addMust

public void addMust(DmcAttributeInfo info)

addMay

public void addMay(DmcAttributeInfo info)

getIdToAttr

public Map<Integer,DmcAttributeInfoRef> getIdToAttr()

isOptional

public boolean isOptional(DmcAttributeInfo ai)

Determines if the attribute is optional. If the attribute isn't in our set of attributes, we indicate that it's optional - this could happen in the case of extensible classes, or when auxiliary classes are involved. And, of course, auxiliary classes can't specify mandatory attributes.

Parameters:

ai -

Returns:

true if the attribute is optional.

allowsAttribute

public boolean allowsAttribute(DmcAttributeInfo ai)

Parameters:

ai - The info associated with the attribute we're checking.

Returns:

true if the attribute is contained in our allowed attributes map.

allowsAttribute

public DmcAttributeInfo allowsAttribute(Integer id)

Parameters:

id - The id of an attribute.

Returns:

The attribute info if the id is in our allowed attributes map.

getAttributeInfo

public DmcAttributeInfo getAttributeInfo(String an)

Parameters:

an - the attribute name

Returns:

the attribute info if the class has the attribute and null otherwise

isInstanceOf

public boolean isInstanceOf(int otherID)

Checks to see if this class or any of its base classes matches the specified ID.

Parameters:

otherID - The id to be tested.

Returns:

true if we match the ID and false otherwise.

isInstanceOf

public boolean isInstanceOf(String className)

Checks to see if this class or any of its base classes matches the specified class name.

Parameters:

className - The name to be tested.

Returns:

true if we match the name and false otherwise.

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(DmcClassInfo dci)

Specified by:

compareTo in interface Comparable<DmcClassInfo>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDerivedClasses

public Iterator<DmcClassInfo> getDerivedClasses()