hep.graphics.heprep
Interface HepRepInstanceTree

All Superinterfaces:

HepRepTreeID

All Known Implementing Classes:

DefaultHepRepInstanceTree, HepRepInstanceTreeAdapter, HepRepInstanceTreeAdapter

public interface HepRepInstanceTree

extends HepRepTreeID

HepRepInstanceTree interface.

Author:

Mark Donszelmann

Method Summary

void	addInstance(HepRepInstance instance) Adds an instance to this instancetree.
void	addInstanceTree(HepRepTreeID instanceTree) Adds a related instance tree to this instancetree.
HepRepInstanceTree	copy(HepRepTypeTree typeTree) Returns a deep copy of this instancetree.
HepRepInstanceTree	copy(HepRepTypeTree typeTree, HepRepSelectFilter filter) Returns a deep copy of this instancetree.
List	getInstances() Returns a collection of instances.
Set	getInstanceTrees() Returns a collection of associated instance trees.
HepRepTreeID	getTypeTree() Returns the associated typetree.
void	overlay(HepRepInstanceTree instanceTree) Overlays the instance tree on the current tree.
void	removeInstance(HepRepInstance instance) Removes an instance from this instancetree.

Methods inherited from interface hep.graphics.heprep.HepRepTreeID

getName, getQualifier, getVersion, setQualifier

Method Detail

overlay

public void overlay(HepRepInstanceTree instanceTree)

Overlays the instance tree on the current tree. The list of instances of the instanceTree has to be the same as the current tree.

addInstance

public void addInstance(HepRepInstance instance)
                 throws IOException

Adds an instance to this instancetree.

Parameters:

instance - to be added.

Throws:

IOException - only if written immediately to a stream.

removeInstance

public void removeInstance(HepRepInstance instance)

Removes an instance from this instancetree.

Parameters:

instance - to be removed.

getInstances

public List getInstances()

Returns a collection of instances.

Returns:

collection of HepRepInstances.

addInstanceTree

public void addInstanceTree(HepRepTreeID instanceTree)
                     throws IOException

Adds a related instance tree to this instancetree.

Parameters:

instanceTree - related instancetree.

Throws:

IOException - only if written immediately to a stream.

getInstanceTrees

public Set getInstanceTrees()

Returns a collection of associated instance trees.

Returns:

collection of HepRepTreeIDs.

getTypeTree

public HepRepTreeID getTypeTree()

Returns the associated typetree.

Returns:

TreeID of the associated typetree.

copy

public HepRepInstanceTree copy(HepRepTypeTree typeTree)
                        throws CloneNotSupportedException

Returns a deep copy of this instancetree.

Returns:

copy of this instancetree.

Throws:

CloneNotSupportedException - if copying is not possible.

copy

public HepRepInstanceTree copy(HepRepTypeTree typeTree,
                               HepRepSelectFilter filter)
                        throws CloneNotSupportedException

Returns a deep copy of this instancetree.

Parameters:

filter - to filter the instances.

Returns:

copy of this instancetree.

Throws:

CloneNotSupportedException - if copying is not possible.