org.dmd.dmw

Class DmwHierarchicObjectWrapper

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.dmw.DmwHierarchicObjectWrapper

All Implemented Interfaces:

DmcContainerIF, DmcNamedObjectIF

public abstract class DmwHierarchicObjectWrapper
extends DmwNamedObjectWrapper

The DmwHierarchicObjectWrapper extends the named object wrapper to indicate that the wrapped object is hierarchically named. This class also provides standardized mechanisms for arranging the objects in a traversable hierarchy i.e. so that you can easily access the named children of an object or an object's parent. This is especially handy when used in conjunction with a caching mechanism.

Field Summary

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
DmwHierarchicObjectWrapper	addSubComponent(DmwHierarchicObjectWrapper subcomp) Adds a child to this node.
<E extends DmwHierarchicObjectWrapper> E	getChild(DmcHierarchicObjectName name)
abstract DmcHierarchicObjectName	getObjectName()
DmwHierarchicObjectWrapper	getParentComponent()
DmcHierarchicObjectName	getParentName()
Collection<DmwHierarchicObjectWrapper>	getSubComps()
<E extends DmwHierarchicObjectWrapper> Collection<E>	getSubComps(Class<E> clazz)
void	removeSubcomponent(DmwHierarchicObjectWrapper subcomp) Removes the specified subcomponent.
protected DmwHierarchicObjectWrapper	setParentComponent(DmwHierarchicObjectWrapper p) Sets the parent of this component.

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, equals, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getDmcObject, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, setDmcObject, 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.DmcNamedObjectIF

equals, getObjectNameAttribute

Constructor Detail

DmwHierarchicObjectWrapper

protected DmwHierarchicObjectWrapper()

DmwHierarchicObjectWrapper

protected DmwHierarchicObjectWrapper(DmcObject obj)

DmwHierarchicObjectWrapper

protected DmwHierarchicObjectWrapper(DmcObject obj,
                                     ClassDefinition cd)

Method Detail

getObjectName

public abstract DmcHierarchicObjectName getObjectName()

Returns:

The name of the object.

getParentName

public DmcHierarchicObjectName getParentName()

Returns:

The name of this component's parent or null if it has no parent.

getParentComponent

public DmwHierarchicObjectWrapper getParentComponent()

Returns:

The parent of this object or null if it hasn't been set.

setParentComponent

protected DmwHierarchicObjectWrapper setParentComponent(DmwHierarchicObjectWrapper p)

Sets the parent of this component.

Parameters:

p - The parent object.

Returns:

The previous parent if one had been set and null otherwise.

addSubComponent

public DmwHierarchicObjectWrapper addSubComponent(DmwHierarchicObjectWrapper subcomp)

Adds a child to this node.

Parameters:

subcomp -

Returns:

If a child of the same name already existed, we return it; otherwise we return null.

removeSubcomponent

public void removeSubcomponent(DmwHierarchicObjectWrapper subcomp)

Removes the specified subcomponent.

Parameters:

subcomp - the subcomponent to be removed.

getChild

public <E extends DmwHierarchicObjectWrapper> E getChild(DmcHierarchicObjectName name)

getSubComps

public Collection<DmwHierarchicObjectWrapper> getSubComps()

Returns:

The children of this component.

getSubComps

public <E extends DmwHierarchicObjectWrapper> Collection<E> getSubComps(Class<E> clazz)

Type Parameters:

E - The type of the children.

Parameters:

clazz - the class of the children required.

Returns:

the children of the specified class.