org.dmd.dmr.server.base.extended

Class HierarchicObject

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.dmr.server.base.generated.dmw.HierarchicObjectDMW

org.dmd.dmr.server.base.extended.HierarchicObject

All Implemented Interfaces:

Comparable<HierarchicObject>, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

DotNamedObjectDMW, LDAPHierarchicObjectDMW

public class HierarchicObject
extends HierarchicObjectDMW
implements Comparable<HierarchicObject>

The extended HierarchicObject class provides a variety of functionality that makes using hierarchic objects convenient.

Field Summary

Fields

Modifier and Type	Field and Description
protected HierarchicObject	parent

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
	HierarchicObject() This constructor is used to create a "root" object that has no data and acts merely as the root of a tree of objects.
protected	HierarchicObject(HierarchicObjectDMO obj, ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
void	addSubComponent(HierarchicObject ce) Adds a subcomponent to this entry.
int	compareTo(HierarchicObject o) Implementation of the Comparable interface so that we can sort our children easily.
boolean	equals(Object obj) If the object is a HierarchicObject and has the same FQN as this object, they're equal.
HierarchicObject	get(int i) Returns the subcomp at the specified index or null if there are no subcomps or if the index is out of bounds.
String	getName() We're overloading this to facilitate the way our JSON implementation will work.
HierarchicObject	getParentObject()
Iterator<HierarchicObject>	getSubComps()
void	removeSubComponent(HierarchicObject ho)
void	removeSubcomponents() This method removes all entries in our subcomponents Vector.
void	resetParent(HierarchicObject newParent) This method rehomes a branch of hierarchic objects to sit beneath the specified parent.
void	saveToBuffer(StringBuffer sb, int padding) This method saves the entire hierarchy from this point to the string buffer.
void	saveToBuffer(StringBuffer sb, int padding, boolean persistentOnly) This method saves the entire hierarchy from this point to the string buffer.
void	saveToFile(BufferedWriter out, int padding) This method will save an entire hierarchy of objects to the file attached to the specified writer.
void	saveToFile(BufferedWriter out, int padding, boolean persistentOnly) This method will save an entire hierarchy of objects to the file attached to the specified writer.
void	setParentObject(HierarchicObject p) This method sets the parent object for this object and reconstructs the FQN as appropriate.
void	setParentObject(HierarchicObject p, boolean buildFQN) This method sets the parent object for this object and reconstructs the FQN as appropriate.
static void	setSort(boolean f) Sets the global flag that indicates whether or not we sort our subcomponents by their FQN or not.
int	size() Returns the number of sub components.

Methods inherited from class org.dmd.dmr.server.base.generated.dmw.HierarchicObjectDMW

cloneIt, getDMO, getFile, getFQN, getLineNumber, getModificationRecorder, getObjectName, getObjectNameAttribute, hashCode, remFile, remFQN, remLineNumber, setFile, setFile, setFQN, setFQN, setLineNumber, setLineNumber

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, 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, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

parent

protected HierarchicObject parent

Constructor Detail

HierarchicObject

public HierarchicObject()

This constructor is used to create a "root" object that has no data and acts merely as the root of a tree of objects.

HierarchicObject

protected HierarchicObject(HierarchicObjectDMO obj,
                           ClassDefinition cd)

Method Detail

getSubComps

public Iterator<HierarchicObject> getSubComps()

Returns:

an iterator over a COPY of the subcomps vector.

setSort

public static void setSort(boolean f)

Sets the global flag that indicates whether or not we sort our subcomponents by their FQN or not.

Parameters:

f - True to sort and false to leave the subcomps in the order they are added.

setParentObject

public void setParentObject(HierarchicObject p)
                     throws ResultException,
                            DmcValueException

This method sets the parent object for this object and reconstructs the FQN as appropriate.

Parameters:

p - the parent object.

Throws:

ResultException - if there's no value for the naming attribute.

DmcValueException

setParentObject

public void setParentObject(HierarchicObject p,
                            boolean buildFQN)
                     throws ResultException,
                            DmcValueException

This method sets the parent object for this object and reconstructs the FQN as appropriate. Set the buildFQN flag to false if the object already has its FQNs set e.g. when it has been retrieved from the repository.

Parameters:

p - the parent object.

buildFQN - Indicates if we need to reset this object's FQNs based on the parent.

Throws:

ResultException - if there's no value for the naming attribute.

DmcValueException

resetParent

public void resetParent(HierarchicObject newParent)
                 throws ResultException,
                        DmcValueException

This method rehomes a branch of hierarchic objects to sit beneath the specified parent. The method recurses through the entire subtree and renames the objects based on the new parent.

Parameters:

newParent -

Throws:

DmcValueException

ResultException

getParentObject

public HierarchicObject getParentObject()

size

public int size()

Returns the number of sub components.

Returns:

The number of subcomponents.

get

public HierarchicObject get(int i)

Returns the subcomp at the specified index or null if there are no subcomps or if the index is out of bounds.

Parameters:

i - Index of the desired subcomp.

removeSubcomponents

public void removeSubcomponents()

This method removes all entries in our subcomponents Vector. Note it doesn't do anything beyond that - the subcomponents are not deleted or affected in any way.

removeSubComponent

public void removeSubComponent(HierarchicObject ho)
                        throws ResultException,
                               DmcValueException

Throws:

ResultException

DmcValueException

addSubComponent

public void addSubComponent(HierarchicObject ce)

Adds a subcomponent to this entry.

Parameters:

ce -

compareTo

public int compareTo(HierarchicObject o)

Implementation of the Comparable interface so that we can sort our children easily.

Specified by:

compareTo in interface Comparable<HierarchicObject>

getName

public String getName()

We're overloading this to facilitate the way our JSON implementation will work. When objects are referenced (e.g. in a GetResponse) we'll using the FQN as the object name.

Returns:

String

saveToFile

public void saveToFile(BufferedWriter out,
                       int padding)
                throws IOException

This method will save an entire hierarchy of objects to the file attached to the specified writer.

Parameters:

out - Writer to the file you want to save in.

padding - The padding to be used when formatting the object..

Throws:

IOException

saveToFile

public void saveToFile(BufferedWriter out,
                       int padding,
                       boolean persistentOnly)
                throws IOException

This method will save an entire hierarchy of objects to the file attached to the specified writer.

Parameters:

out - Writer to the file you want to save in.

padding - The padding to be used when formatting the object..

persistentOnly - If true, only persistent objects will be saved. We stop recursing down a branch when we hit a TRANSIENT object.

Throws:

IOException

saveToBuffer

public void saveToBuffer(StringBuffer sb,
                         int padding)

This method saves the entire hierarchy from this point to the string buffer.

Parameters:

sb - The buffer to which we append the object.

padding - The padding to be used when formatting the object.

saveToBuffer

public void saveToBuffer(StringBuffer sb,
                         int padding,
                         boolean persistentOnly)

This method saves the entire hierarchy from this point to the string buffer.

Parameters:

sb - The buffer to which we append the object.

padding - The padding to be used when formatting the object.

persistentOnly - If true, only persistent objects will be saved. We stop recursing down a branch when we hit a TRANSIENT object.

equals

public boolean equals(Object obj)

If the object is a HierarchicObject and has the same FQN as this object, they're equal.

Specified by:

equals in interface DmcNamedObjectIF

Overrides:

equals in class HierarchicObjectDMW

Parameters:

obj - The comparison object.

Returns:

True if the names match.