org.dmd.dmw

Class DmwWrapper

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

All Implemented Interfaces:

DmcContainerIF

Direct Known Subclasses:

ActionTriggerInfoDMW, ClientCountFilterDMW, ComplexTypeTestDMW, DmgConfigDMW, DMPMessageDMW, DmwNamedObjectWrapper, ExtendedRefHSDMW, ExtendedRefMVDMW, ExtendedRefMVIDXDMW, ExtendedRefSVDMW, ExtendedRefTSDMW, NameContainerTestDMW, NamedObjHMDMW, NamedObjHSDMW, NamedObjMVDMW, NamedObjMVIDXDMW, NamedObjSVDMW, NamedObjTMDMW, NamedObjTSDMW, ParseTestDMW, PrimitiveHMDMW, PrimitiveHSDMW, PrimitiveMVDMW, PrimitiveMVIDXDMW, PrimitiveSVDMW, PrimitiveTMDMW, PrimitiveTSDMW, TestAbstractExtendedDMW, TestAbstractFixedDMW, TestBasicObjectFixedDMW, UnnamedObjHSDMW, UnnamedObjMVDMW, UnnamedObjMVIDXDMW, UnnamedObjSVDMW, UnnamedObjTSDMW, UsingIndexedAttributesDMW, UsingObjRefHMDMW

public abstract class DmwWrapper
extends DmcContainer

The DmwWrapper class provides a common base for Dark Matter Wrapper classes in a Full Java Environment and provides basic functionality beyond what's defined for a DmcContainer.

Field Summary

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DmwWrapper()
protected	DmwWrapper(DmcObject obj)
protected	DmwWrapper(DmcObject obj, ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
void	addAux(ClassDefinition cd) Adds the specified auxiliary class to the object.
boolean	applyModifier(DmcTypeModifierMV mods)
boolean	equals(Object obj)
String	getBackRefs() Returns the references to this object formatted as a String.
ClassDefinition	getConstructionClass()
DmcClassInfo	getConstructionClassInfo()
String	getConstructionClassName()
DmcObject	getDmcObject() Gets the core object.
ClassDefinitionIterableDMW	getObjectClass()
ArrayList<DmwWrapper>	getReferringObjects() Returns the objects that are referring to this object.
ArrayList<DmwWrapper>	getReferringObjectsViaAttribute(DmcAttributeInfo ai)
boolean	hasAux(ClassDefinition cd) Determines if the specified class is in our objectClass list.
boolean	isReferenced()
int	referenceCount()
void	removeAux(ClassDefinition cd) Removes the specified auxiliary class from the object.
void	resolveReferences(DmcNameResolverIF resolver) This method calls resolveReferences() on the underlying DMO.
void	resolveReferences(DmcNameResolverWithClashSupportIF rx, DmcNameClashResolverIF ncr) This method is used to resolve references in names spaces where object names can clash.
void	serializeIt(DmcOutputStreamIF dos) Serializes our underlying DMO.
void	setDmcObject(DmcObject obj) Sets the core object.
String	toJSON() The object with just the persistent attributes and none of the internal use attributes.
String	toOIF() The object with all attributes.
String	toOIF(int padding) The object with all attributes.
String	toPersistentOIF() The object with just the persistent attributes and none of the internal use attributes.
String	toString() The object with all attributes.
void	youAreDeleted() This method should be called by whatever mechanism you're using to manage a collection of DMOs.

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

Constructor Detail

DmwWrapper

protected DmwWrapper()

DmwWrapper

protected DmwWrapper(DmcObject obj)

DmwWrapper

protected DmwWrapper(DmcObject obj,
                     ClassDefinition cd)

Method Detail

applyModifier

public boolean applyModifier(DmcTypeModifierMV mods)
                      throws DmcValueExceptionSet,
                             DmcValueException

Throws:

DmcValueExceptionSet

DmcValueException

isReferenced

public boolean isReferenced()

Returns:

true if this object has any other objects referring to it. This mechanism is only valid if you've turned on back reference tracking via DmcOmni.

getBackRefs

public String getBackRefs()

Returns the references to this object formatted as a String. This will only return a value if you've turned on backref tracking via the DmcOmni.

Returns:

the references to this object formatted as a String.

referenceCount

public int referenceCount()

Returns:

the number of references to this object. This mechanism is only valid if you've turned on back reference tracking via DmcOmni.

youAreDeleted

public void youAreDeleted()

This method should be called by whatever mechanism you're using to manage a collection of DMOs. It will automatically removed references to this object that are contained in object reference attributes if you have set DmcOmni.backRefTracking(true).

getReferringObjects

public ArrayList<DmwWrapper> getReferringObjects()

Returns the objects that are referring to this object. This will only return a value if you've turned on backref tracking via the DmcOmni.

Returns:

the objects that are referring to this object

getReferringObjectsViaAttribute

public ArrayList<DmwWrapper> getReferringObjectsViaAttribute(DmcAttributeInfo ai)

Parameters:

ai - the attribute via which we're referring

Returns:

the objects that are referring to this object via the specified attribute. This will only return a value if you've turned on backref tracking via the DmcOmni.

serializeIt

public void serializeIt(DmcOutputStreamIF dos)
                 throws Exception,
                        DmcValueException

Serializes our underlying DMO.

Parameters:

dos - the output stream.

Throws:

Exception - another error occurs

DmcValueException - if values are incorrect

getConstructionClassName

public String getConstructionClassName()

getObjectClass

public ClassDefinitionIterableDMW getObjectClass()

addAux

public void addAux(ClassDefinition cd)
            throws DmcValueException

Adds the specified auxiliary class to the object.

Parameters:

cd - The auxiliary class definition.

Throws:

DmcValueException - if values are incorrect

removeAux

public void removeAux(ClassDefinition cd)

Removes the specified auxiliary class from the object.

Parameters:

cd - The auxiliary class definition.

hasAux

public boolean hasAux(ClassDefinition cd)

Determines if the specified class is in our objectClass list.

Parameters:

cd - The class definition.

Returns:

true if the definition is there.

getDmcObject

public DmcObject getDmcObject()

Description copied from class: DmcContainer

Gets the core object.

Specified by:

getDmcObject in interface DmcContainerIF

Overrides:

getDmcObject in class DmcContainer

Returns:

T The core object.

setDmcObject

public void setDmcObject(DmcObject obj)

Description copied from class: DmcContainer

Sets the core object.

Specified by:

setDmcObject in interface DmcContainerIF

Overrides:

setDmcObject in class DmcContainer

Parameters:

obj - The core object.

getConstructionClass

public ClassDefinition getConstructionClass()

Returns:

The construction class definition for this object.

getConstructionClassInfo

public DmcClassInfo getConstructionClassInfo()

Returns:

The class info of the core object if it's available

toOIF

public String toOIF()

The object with all attributes. This includes internal user attribute such as the name of the file from which it was loaded, the line number etc.

Returns:

the object's representation in Object Instance Format (OIF)

toPersistentOIF

public String toPersistentOIF()

The object with just the persistent attributes and none of the internal use attributes.

Returns:

the object's representation in Object Instance Format (OIF)

toOIF

public String toOIF(int padding)

The object with all attributes. This includes internal user attribute such as the name of the file from which it was loaded, the line number etc.

Parameters:

padding - a set padding for the attribute name.

Returns:

the object's representation in Object Instance Format (OIF)

toString

public String toString()

The object with all attributes. This includes internal user attribute such as the name of the file from which it was loaded, the line number etc.

Overrides:

toString in class Object

Returns:

the object's representation in Object Instance Format (OIF)

toJSON

public String toJSON()

The object with just the persistent attributes and none of the internal use attributes.

Returns:

a JSON representation of the object.

resolveReferences

public void resolveReferences(DmcNameResolverIF resolver)
                       throws DmcValueExceptionSet

This method calls resolveReferences() on the underlying DMO.

Parameters:

resolver - an entity that can resolve schema related references and references to other objects.

Throws:

DmcValueExceptionSet - if values are incorrect

resolveReferences

public void resolveReferences(DmcNameResolverWithClashSupportIF rx,
                              DmcNameClashResolverIF ncr)
                       throws DmcValueExceptionSet

This method is used to resolve references in names spaces where object names can clash. This includes domain specific definition sets such as the dark-matter schema, Model View Whatever (MVW) or other sets of definitions. The concept here is that it's convenient to use simple strings as names for things and only use fully qualified names when it's necessary to distinguish between ambiguous/clashing names.

Parameters:

rx - the name resolver

ncr - the clash resolver

Throws:

DmcValueExceptionSet - if values are incorrect

equals

public boolean equals(Object obj)

Overrides:

equals in class Object