hep.aida
Interface IAnnotation

public interface IAnnotation

The annotation holds arbitrary information represented with (key,value) pairs of strings. A sticky bit is associated to every item to protect it (or not) from a reset operation. The following is the list of the default keys (they are stycky): "Title" for the title. The order of the default keys is not specified.

Author:

The AIDA team (http://aida.freehep.org/)

Method Summary

void	addItem(String key, String value) Add a key/value pair with a given sticky flag.
void	addItem(String key, String value, boolean sticky) Add a key/value pair with a given sticky flag.
int	findKey(String key) Find the index of a key.
boolean	hasKey(String key) Check if a given key exists in IAnnotation
boolean	isSticky(String key) Get the stickyness for a given key.
String	key(int index) Get the key at a given position within the IAnnotation.
void	removeItem(String key) Remove the item indicated by a given key.
void	reset() Remove all the non-sticky items.
void	setSticky(String key, boolean sticky) Set the sticky flag for a given key.
void	setValue(String key, String value) Set the value for a given key.
int	size() Get the size of the IAnnotation, i.e. the number of keys contained in it.
String	value(int index) Get the value at a given position within the IAnnotation.
String	value(String key) Retrieve the value for a given key.

Method Detail

addItem

public void addItem(String key,
                    String value)
             throws IllegalArgumentException

Add a key/value pair with a given sticky flag. If key alredy exists, its value is overwritten.

Parameters:

key - The key to be added.

value - The key's value. not be removed when the method reset or removeItem are invoked. The default value for the sticky flag is false.

Throws:

IllegalArgumentException - If the key already exists.

addItem

public void addItem(String key,
                    String value,
                    boolean sticky)
             throws IllegalArgumentException

Add a key/value pair with a given sticky flag. If key alredy exists, its value is overwritten.

Parameters:

key - The key to be added.

value - The key's value.

sticky - The key's sticky flag. If true the item will not be removed when the method reset or removeItem are invoked. The default value for the sticky flag is false.

Throws:

IllegalArgumentException - If the key already exists.

removeItem

public void removeItem(String key)
                throws IllegalArgumentException

Remove the item indicated by a given key.

Parameters:

key - The key to be removed. If the key is flagged as "sticky" it will not be removed.

Throws:

IllegalArgumentException - If the key is sticky.

value

public String value(String key)

Retrieve the value for a given key.

Parameters:

key - The key.

Returns:

The corresponding value.

setValue

public void setValue(String key,
                     String value)

Set the value for a given key.

Parameters:

key - The key whose vale is to be changed.

value - The new value.

setSticky

public void setSticky(String key,
                      boolean sticky)

Set the sticky flag for a given key.

Parameters:

key - The key whose stick flag is to be set.

sticky - The new sticky flag.

isSticky

public boolean isSticky(String key)

Get the stickyness for a given key.

Parameters:

key - The item's key.

Returns:

The stickyness for the corresponding item.

hasKey

public boolean hasKey(String key)

Check if a given key exists in IAnnotation

Parameters:

key - The item's key.

Returns:

true if the key exists.

size

public int size()

Get the size of the IAnnotation, i.e. the number of keys contained in it.

Returns:

The size of the IAnnotation.

findKey

public int findKey(String key)

Find the index of a key.

Parameters:

key - The key to find.

Returns:

The key index. Return -1 if not found.

key

public String key(int index)

Get the key at a given position within the IAnnotation.

Parameters:

index - The key's position within the IAnnotation.

Returns:

The corresponding key.

value

public String value(int index)

Get the value at a given position within the IAnnotation.

Parameters:

index - The value's position within the IAnnotation.

Returns:

The corresponding value.

reset

public void reset()

Remove all the non-sticky items.