hep.graphics.heprep
Interface HepRep

public interface HepRep

The HepRep interface. Any of these methods may throw a UnsupportedOperationException in Java.

Author:

Mark Donszelmann

Method Summary

void	addInstanceTree(HepRepInstanceTree instanceTree) Adds an instancetree to this heprep.
void	addLayer(String layer) Add a layer to the list of layers in this heprep.
void	addTypeTree(HepRepTypeTree typeTree) Add a typetree to this heprep.
String	checkForException() Returns last exception thrown and clears it.
HepRep	copy() Returns a deep copy of the heprep, with all its attached trees, where instances are filtered using a HepRepSelectFilter.
HepRep	copy(HepRepSelectFilter filter) Returns a deep copy of the heprep, with all its attached trees, where instances are filtered using a HepRepSelectFilter.
HepRepInstanceTree	getInstances(String name, String version, String[] typeNames) Returns a named and versioned instancetree for a list of typenames.
HepRepInstanceTree	getInstancesAfterAction(String name, String version, String[] typeNames, HepRepAction[] actions, boolean getPoints, boolean getDrawAtts, boolean getNonDrawAtts, String[] invertAtts) Returns a named and versioned instancetree for a list of typenames after executing some action and for specific filters.
List	getInstanceTreeList() Returns a collection of instancetrees.
Set	getInstanceTrees() Returns a collection of instancetrees.
HepRepInstanceTree	getInstanceTreeTop(String name, String version) Returns a named and versioned instancetree.
List	getLayerOrder() Returns the list of layers.
HepRepTypeTree	getTypeTree(String name, String version) Returns a named and versioned typetree.
List	getTypeTreeList() Returns the collection of all typetrees of this heprep.
Set	getTypeTrees() Returns the collection of all typetrees of this heprep.
void	overlayInstanceTree(HepRepInstanceTree instanceTree) Overlays an instancetree to this heprep, overriding attributes and adding children.
void	removeInstanceTree(HepRepInstanceTree instanceTree) Remove an instanectree from this heprep.
void	removeTypeTree(HepRepTypeTree typeTree) Remove a typetree from this heprep.

Method Detail

addLayer

void addLayer(String layer)

Add a layer to the list of layers in this heprep. The layer is added to the back of the list.

Parameters:

layer - name of layer to be added to the back of the list.

getLayerOrder

List getLayerOrder()

Returns the list of layers.

Returns:

the known layer names, in the order back-to-front.

addTypeTree

void addTypeTree(HepRepTypeTree typeTree)

Add a typetree to this heprep.

Parameters:

typeTree - to be added.

removeTypeTree

void removeTypeTree(HepRepTypeTree typeTree)

Remove a typetree from this heprep.

Parameters:

typeTree - to be removed.

getTypeTrees

Set getTypeTrees()

Returns the collection of all typetrees of this heprep.

Returns:

collection of HepRepTypeTrees.

getTypeTreeList

List getTypeTreeList()

Returns the collection of all typetrees of this heprep.

Returns:

collection of HepRepTypeTrees.

getTypeTree

HepRepTypeTree getTypeTree(String name,
                           String version)

Returns a named and versioned typetree.

Parameters:

name - name of the typetree.

version - version of the typetree.

Returns:

named and versioned HepRepTypeTree.

addInstanceTree

void addInstanceTree(HepRepInstanceTree instanceTree)

Adds an instancetree to this heprep.

Parameters:

instanceTree - to be added.

overlayInstanceTree

void overlayInstanceTree(HepRepInstanceTree instanceTree)

Overlays an instancetree to this heprep, overriding attributes and adding children.

Parameters:

instanceTree - to be overlaid.

removeInstanceTree

void removeInstanceTree(HepRepInstanceTree instanceTree)

Remove an instanectree from this heprep.

Parameters:

instanceTree - to be removed.

getInstanceTrees

Set getInstanceTrees()

Returns a collection of instancetrees.

Returns:

collection of HepRepInstanceTrees.

getInstanceTreeList

List getInstanceTreeList()

Returns a collection of instancetrees.

Returns:

collection of HepRepInstanceTrees.

getInstanceTreeTop

HepRepInstanceTree getInstanceTreeTop(String name,
                                      String version)

Returns a named and versioned instancetree. FIXME: doc is incorrect here, should only return TOP of the tree. Filling in should be done by getInstances calls.

This tree needs to be added to the heprep afterwards.

Parameters:

name - name of the instancetree.

version - version of the instancetree.

Returns:

HepRepIntanceTree

getInstances

HepRepInstanceTree getInstances(String name,
                                String version,
                                String[] typeNames)

Returns a named and versioned instancetree for a list of typenames.

This tree needs to be added to the heprep afterwards.

Parameters:

name - name of the instancetree.

version - version of the instancetree.

typeNames - a list of typenames for which we need instancetrees.

Returns:

HepRepIntanceTree

getInstancesAfterAction

HepRepInstanceTree getInstancesAfterAction(String name,
                                           String version,
                                           String[] typeNames,
                                           HepRepAction[] actions,
                                           boolean getPoints,
                                           boolean getDrawAtts,
                                           boolean getNonDrawAtts,
                                           String[] invertAtts)

Returns a named and versioned instancetree for a list of typenames after executing some action and for specific filters. This tree needs to be added to the heprep afterwards.

The inversion effect of invertAtts depends on the values of GetDrawAtts and GetNonDrawAtts as follows:

• GetDrawAtts GetNonDrawAtts effect of InvertAtts
• FALSE FALSE all Attributes specified will be downloaded
• TRUE FALSE Draw Attributes specified will be omitted, NonDraw Attributes specified will be included
• FALSE TRUE Draw Attributes specified will be included, NonDraw Attributes specified will be omitted
• TRUE TRUE all Attributes specified will be omitted

Parameters:

name - name of the instancetree.

version - version of the instancetree.

typeNames - a list of typenames for which we need instancetrees.

actions - execute this list of actions before returning.

getPoints - include the HepRepPoints in the instance tree.

getDrawAtts - include the Draw attributes in the instance tree.

getNonDrawAtts - include the Non-Draw attributes in the instance tree.

invertAtts - list of attributes to be included or not depending on getDrawAtts and getNonDrawAtts.

Returns:

HepRepIntanceTree

checkForException

String checkForException()

Returns last exception thrown and clears it. Useful for implementations without exception handling.

Returns:

last exception and clears it.

copy

HepRep copy()
            throws CloneNotSupportedException

Returns a deep copy of the heprep, with all its attached trees, where instances are filtered using a HepRepSelectFilter.

Returns:

copy of heprep.

Throws:

CloneNotSupportedException - in case copy is not possible

copy

HepRep copy(HepRepSelectFilter filter)
            throws CloneNotSupportedException

Returns a deep copy of the heprep, with all its attached trees, where instances are filtered using a HepRepSelectFilter.

Parameters:

filter - to be used for filtering instances.

Returns:

copy of heprep.

Throws:

CloneNotSupportedException - in case copy is not possible