hep.graphics.heprep
Interface HepRepType

All Superinterfaces:

HepRepAttribute, HepRepConstants, HepRepDefinition

All Known Implementing Classes:

AbstractHepRepTypeAdapter, DefaultHepRepType, HepRepTypeAdapter, HepRepTypeAdapter

public interface HepRepType

extends HepRepDefinition

Source Code:

HepRepType.java

Field Summary

Fields inherited from interface hep.graphics.heprep.HepRepConstants

SHOW_DESC, SHOW_EXTRA, SHOW_NAME, SHOW_NONE, SHOW_VALUE, TYPE_BOOLEAN, TYPE_COLOR, TYPE_DOUBLE, TYPE_INT, TYPE_LONG, TYPE_STRING, TYPE_UNKNOWN

Method Summary

void	addType(HepRepType type) Adds a sub-type to this type.
HepRepType	copy(HepRepType parent) Returns a deep copy of this type.
String	getDescription() Returns the description of this type.
String	getFullName() Returns the full name of this type.
String	getInfoURL() Returns the information URL of this type.
String	getName() Returns the name of this type.
HepRepType	getSuperType() Returns the parent of this type.
List	getTypeList() Returns a collection of all the sub-types of this type.
Set	getTypes() Deprecated. use getTypeList()
void	setDescription(String description) Sets the description of this type.
void	setInfoURL(String infoURL) Sets the information URL of this type.

Methods inherited from interface hep.graphics.heprep.HepRepDefinition

addAttDef, addAttDef, getAttDef, getAttDefFromNode, getAttDefsFromNode

Methods inherited from interface hep.graphics.heprep.HepRepAttribute

addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, getAttValue, getAttValueFromNode, getAttValuesFromNode, removeAttValue

Method Detail

addType

public void addType(HepRepType type)

Adds a sub-type to this type.

Parameters:

type - sub-type to be added.

getName

public String getName()

Returns the name of this type. This is the full name if one uses flat-types, and the node name if one uses hierarchical typenames. It is the name supplied at construction of the type.

Returns:

name of type.

See Also:

getFullName()

getFullName

public String getFullName()

Returns the full name of this type. The full name is constructed from the root of the typeTree (without the typeTreeName) by concatenating all the node names separated by slashes "/". For example: Geometry/InnerDetector/Sector24/Wire20

Returns:

full name of type.

See Also:

getName()

getDescription

public String getDescription()

Returns the description of this type.

Returns:

description of type.

setDescription

public void setDescription(String description)

Sets the description of this type.

getInfoURL

public String getInfoURL()

Returns the information URL of this type.

Returns:

info URL of type.

setInfoURL

public void setInfoURL(String infoURL)

Sets the information URL of this type.

Parameters:

infoURL -

getSuperType

public HepRepType getSuperType()

Returns the parent of this type.

Returns:

parent of type, or null if top-level.

getTypes

public Set getTypes()

Deprecated. use getTypeList()

Returns a collection of all the sub-types of this type.

Returns:

collection of HepRepTypes.

getTypeList

public List getTypeList()

Returns a collection of all the sub-types of this type.

Returns:

collection of HepRepTypes.

copy

public HepRepType copy(HepRepType parent)
                throws CloneNotSupportedException

Returns a deep copy of this type.

Parameters:

parent - to which this copy is added.

Returns:

copy of this type.

Throws:

CloneNotSupportedException - if copying is not possible.