hep.graphics.heprep
Interface HepRepAttribute

All Superinterfaces:

HepRepConstants

All Known Subinterfaces:

HepRepDefinition, HepRepInstance, HepRepPoint, HepRepType

All Known Implementing Classes:

CORBAHepRepAttribute, CORBAHepRepDefinition, DefaultHepRepAttribute, DefaultHepRepDefinition, DefaultHepRepInstance, DefaultHepRepPoint, DefaultHepRepType, HepRepAttributeAdapter, HepRepDefinitionAdapter, HepRepInstanceAdapter, HepRepInstanceAdapter, HepRepPointAdapter, HepRepPointAdapter, HepRepTypeAdapter, HepRepTypeAdapter, StreamerHepRepAttribute, StreamerHepRepDefinition, StreamerHepRepInstance, StreamerHepRepPoint, StreamerHepRepType

public interface HepRepAttribute

extends HepRepConstants

HepRepAttribute interface.

Author:

Mark Donszelmann

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	addAttValue(HepRepAttValue attValue) Adds an attValue.
void	addAttValue(String key, boolean value) Adds an attValue.
void	addAttValue(String key, boolean value, int showLabel) Adds an attValue.
void	addAttValue(String key, Color value) Adds a Color attValue.
void	addAttValue(String key, Color value, int showLabel) Adds a Color attValue.
void	addAttValue(String key, double value) Adds an attValue.
void	addAttValue(String key, double value, int showLabel) Adds an attValue.
void	addAttValue(String key, int value) Adds an attValue.
void	addAttValue(String key, int value, int showLabel) Adds an attValue.
void	addAttValue(String key, String value) Adds an attValue.
void	addAttValue(String key, String value, int showLabel) Adds an attValue.
HepRepAttValue	getAttValue(String name) Returns the attValue specified by name.
HepRepAttValue	getAttValueFromNode(String lowerCaseName) Returns a named attribute value from this node.
Collection	getAttValuesFromNode() Returns a collection of all attribute values from this node.
HepRepAttValue	removeAttValue(String key) Remove the attvalue named by key.

Method Detail

addAttValue

public void addAttValue(HepRepAttValue attValue)
                 throws IOException

Adds an attValue.

Parameters:

attValue - to be added.

Throws:

IOException - only if the value is immediately written to a stream.

addAttValue

public void addAttValue(String key,
                        String value)
                 throws IOException

Adds an attValue.

Parameters:

key - name of attValue

value - value of attValue

Throws:

IOException - only if the value is immediately written to a stream.

addAttValue

public void addAttValue(String key,
                        String value,
                        int showLabel)
                 throws IOException

Adds an attValue.

Parameters:

key - name of attValue

value - value of attValue

showLabel - show this as label

Throws:

IOException - only if the value is immediately written to a stream.

addAttValue

public void addAttValue(String key,
                        int value)
                 throws IOException

Adds an attValue.

Parameters:

key - name of attValue

value - value of attValue

Throws:

IOException - only if the value is immediately written to a stream.

addAttValue

public void addAttValue(String key,
                        int value,
                        int showLabel)
                 throws IOException

Adds an attValue.

Parameters:

key - name of attValue

value - value of attValue

showLabel - show this as label

Throws:

IOException - only if the value is immediately written to a stream.

addAttValue

public void addAttValue(String key,
                        double value)
                 throws IOException

Adds an attValue.

Parameters:

key - name of attValue

value - value of attValue

Throws:

IOException - only if the value is immediately written to a stream.

addAttValue

public void addAttValue(String key,
                        double value,
                        int showLabel)
                 throws IOException

Adds an attValue.

Parameters:

key - name of attValue

value - value of attValue

showLabel - show this as label

Throws:

IOException - only if the value is immediately written to a stream.

addAttValue

public void addAttValue(String key,
                        boolean value)
                 throws IOException

Adds an attValue.

Parameters:

key - name of attValue

value - value of attValue

Throws:

IOException - only if the value is immediately written to a stream.

addAttValue

public void addAttValue(String key,
                        boolean value,
                        int showLabel)
                 throws IOException

Adds an attValue.

Parameters:

key - name of attValue

value - value of attValue

showLabel - show this as label

Throws:

IOException - only if the value is immediately written to a stream.

addAttValue

public void addAttValue(String key,
                        Color value)
                 throws IOException

Adds a Color attValue.

Parameters:

key - name of attValue

value - value of attValue

Throws:

IOException - only if the value is immediately written to a stream.

addAttValue

public void addAttValue(String key,
                        Color value,
                        int showLabel)
                 throws IOException

Adds a Color attValue.

Parameters:

key - name of attValue

value - value of attValue

showLabel - show this as label

Throws:

IOException - only if the value is immediately written to a stream.

removeAttValue

public HepRepAttValue removeAttValue(String key)

Remove the attvalue named by key.

Parameters:

key - name of the attValue to be removed.

Returns:

removed HepRepAttValue, or null if not removed.

getAttValue

public HepRepAttValue getAttValue(String name)

Returns the attValue specified by name. This attValue is normally searched on the node itself and then on its type, moving up the typetree.

Parameters:

name - of attribute value.

Returns:

attribute value.

getAttValuesFromNode

public Collection getAttValuesFromNode()

Returns a collection of all attribute values from this node.

Returns:

collection of HepRepAttValues.

getAttValueFromNode

public HepRepAttValue getAttValueFromNode(String lowerCaseName)

Returns a named attribute value from this node.

Parameters:

lowerCaseName - name in all lowercase.

Returns:

corresponding HepRepAttValue.