AbstractElement (The GraphStream 1.3 API)

java.lang.Object
- org.graphstream.graph.implementations.AbstractElement

All Implemented Interfaces:

Element

Direct Known Subclasses:

AbstractEdge, AbstractGraph, AbstractNode, GraphicElement, GraphicGraph
```
public abstract class AbstractElement
extends Object
implements Element
```
A base implementation of an element.
This class is the Base class for Node, Edge and Graph. An element is made of an unique and arbitrary identifier that identifies it, and a set of attributes.

Since:

20040910

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractElement.AttributeChangeEvent

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractElement.AttributeChangeEvent`

Constructor Summary

Constructors
Constructor and Description

AbstractElement(String id)
New element.

Constructors
Constructor and Description
`AbstractElement(String id)` New element.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAttribute(String attribute, Object... values)` Add or replace the value of an attribute.
`void`	`addAttributes(Map<String,Object> attributes)` Add or replace each attribute found in attributes.
`void`	`changeAttribute(String attribute, Object... values)` Like `Element.addAttribute(String, Object...)` but for consistency.
`void`	`clearAttributes()` Remove all registered attributes.
`Object[]`	`getArray(String key)` Get the array of objects bound to key.
`<T> T`	`getAttribute(String key)` Get the attribute object bound to the given key.
`<T> T`	`getAttribute(String key, Class<T> clazz)` Get the attribute object bound to the given key if it is an instance of the given class.
`int`	`getAttributeCount()` Number of attributes stored in this element.
`Iterator<String>`	`getAttributeKeyIterator()` Iterator on all attributes keys.
`Collection<String>`	`getAttributeKeySet()` An unmodifiable view on the set of attribute keys.
`Iterable<String>`	`getEachAttributeKey()` An iterable view on the set of attribute keys usable within a for-each loop.
`<T> T`	`getFirstAttributeOf(Class<T> clazz, String... keys)` Like `Element.getAttribute(String, Class)`, but returns the first existing attribute in a list of keys, instead of only one key.
`<T> T`	`getFirstAttributeOf(String... keys)` Like `Element.getAttribute(String)`, but returns the first existing attribute in a list of keys, instead of only one key.
`HashMap<?,?>`	`getHash(String key)` Get the hash bound to key.
`String`	`getId()` Unique identifier of this element.
`int`	`getIndex()` The current index of this element
`String`	`getLabel(String key)` Get the label string bound to the given key key.
`double`	`getNumber(String key)` Get the number bound to key.
`ArrayList<? extends Number>`	`getVector(String key)` Get the vector of number bound to key.
`boolean`	`hasArray(String key)` Does this element store an array value for the given key?
`boolean`	`hasAttribute(String key)` Does this element store a value for the given attribute key?
`boolean`	`hasAttribute(String key, Class<?> clazz)` Does this element store a value for the given attribute key and this value is an instance of the given class?
`boolean`	`hasHash(String key)` Does this element store a hash value for the given key?
`boolean`	`hasLabel(String key)` Does this element store a label value for the given key?
`boolean`	`hasNumber(String key)` Does this element store a number for the given key?
`boolean`	`hasVector(String key)` Does this element store a vector value for the given key?
`void`	`removeAttribute(String attribute)` Remove an attribute.
`void`	`setAttribute(String attribute, Object... values)` Like `Element.addAttribute(String, Object...)` but for consistency.
`String`	`toString()` Override the Object method

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AbstractElement
```
public AbstractElement(String id)
```
    New element.
    
    Parameters:
    id - The unique identifier of this element.
- Method Detail
  - getId
```
public String getId()
```
    Description copied from interface: Element
    
    Unique identifier of this element.
    
    Specified by:
    
    getId in interface Element
    
    Returns:
    The identifier value.
  - getIndex
```
public int getIndex()
```
    Description copied from interface: Element
    
    The current index of this element
    
    Specified by:
    
    getIndex in interface Element
    
    Returns:
    The index value
  - getAttribute
```
public <T> T getAttribute(String key)
```
    Description copied from interface: Element
    
    Get the attribute object bound to the given key. The returned value may be null to indicate the attribute does not exists or is not supported.
    
    Specified by:
    
    getAttribute in interface Element
    
    Parameters:
    key - Name of the attribute to search.
    
    Returns:
    The object bound to the given key or null if no object match this attribute name.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - getFirstAttributeOf
```
public <T> T getFirstAttributeOf(String... keys)
```
    Description copied from interface: Element
    
    Like Element.getAttribute(String), but returns the first existing attribute in a list of keys, instead of only one key. The key list order matters.
    
    Specified by:
    
    getFirstAttributeOf in interface Element
    
    Parameters:
    keys - Several strings naming attributes.
    
    Returns:
    The first attribute that exists.
    Computational Complexity :
    
    O(log(n*m)) with n being the number of attributes of this element and m the number of keys given.
  - getAttribute
```
public <T> T getAttribute(String key,
                 Class<T> clazz)
```
    Description copied from interface: Element
    
    Get the attribute object bound to the given key if it is an instance of the given class. Some The returned value maybe null to indicate the attribute does not exists or is not an instance of the given class.
    
    Specified by:
    
    getAttribute in interface Element
    
    Parameters:
    key - The attribute name to search.
    clazz - The expected attribute class.
    
    Returns:
    The object bound to the given key or null if no object match this attribute.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - getFirstAttributeOf
```
public <T> T getFirstAttributeOf(Class<T> clazz,
                        String... keys)
```
    Description copied from interface: Element
    
    Like Element.getAttribute(String, Class), but returns the first existing attribute in a list of keys, instead of only one key. The key list order matters.
    
    Specified by:
    
    getFirstAttributeOf in interface Element
    
    Parameters:
    clazz - The class the attribute must be instance of.
    keys - Several string naming attributes.
    
    Returns:
    The first attribute that exists.
    Computational Complexity :
    
    O(log(n*m)) with n being the number of attributes of this element and m the number of keys given.
  - getLabel
```
public String getLabel(String key)
```
    Description copied from interface: Element
    
    Get the label string bound to the given key key. Labels are special attributes whose value is a character sequence. If an attribute with the same name exists but is not a character sequence, null is returned.
    
    Specified by:
    
    getLabel in interface Element
    
    Parameters:
    key - The label to search.
    
    Returns:
    The label string value or null if not found.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - getNumber
```
public double getNumber(String key)
```
    Description copied from interface: Element
    
    Get the number bound to key. Numbers are special attributes whose value is an instance of Number. If an attribute with the same name exists but is not a Number, NaN is returned.
    
    Specified by:
    
    getNumber in interface Element
    
    Parameters:
    key - The name of the number to search.
    
    Returns:
    The number value or NaN if not found.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - getVector
```
public ArrayList<? extends Number> getVector(String key)
```
    Description copied from interface: Element
    
    Get the vector of number bound to key. Vectors of numbers are special attributes whose value is a sequence of numbers. If an attribute with the same name exists but is not a vector of number, null is returned.
    
    Specified by:
    
    getVector in interface Element
    
    Parameters:
    key - The name of the number to search.
    
    Returns:
    The vector of numbers or null if not found.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - getArray
```
public Object[] getArray(String key)
```
    Description copied from interface: Element
    
    Get the array of objects bound to key. Arrays of objects are special attributes whose value is a sequence of objects. If an attribute with the same name exists but is not an array, null is returned.
    
    Specified by:
    
    getArray in interface Element
    
    Parameters:
    key - The name of the array to search.
    
    Returns:
    The array of objects or null if not found.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - getHash
```
public HashMap<?,?> getHash(String key)
```
    Description copied from interface: Element
    
    Get the hash bound to key. Hashes are special attributes whose value is a set of pairs (name,object). Instances of object implementing the CompoundAttribute interface are considered like hashes since they can be transformed to a hash. If an attribute with the same name exists but is not a hash, null is returned. We cannot enforce the type of the key. It is considered a string and you should use "Object.toString()" to get it.
    
    Specified by:
    
    getHash in interface Element
    
    Parameters:
    key - The name of the hash to search.
    
    Returns:
    The hash or null if not found.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - hasAttribute
```
public boolean hasAttribute(String key)
```
    Description copied from interface: Element
    
    Does this element store a value for the given attribute key?
    
    Specified by:
    
    hasAttribute in interface Element
    
    Parameters:
    key - The name of the attribute to search.
    
    Returns:
    True if a value is present for this attribute.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - hasAttribute
```
public boolean hasAttribute(String key,
                   Class<?> clazz)
```
    Description copied from interface: Element
    
    Does this element store a value for the given attribute key and this value is an instance of the given class?
    
    Specified by:
    
    hasAttribute in interface Element
    
    Parameters:
    key - The name of the attribute to search.
    clazz - The expected class of the attribute value.
    
    Returns:
    True if a value is present for this attribute.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - hasLabel
```
public boolean hasLabel(String key)
```
    Description copied from interface: Element
    
    Does this element store a label value for the given key? A label is an attribute whose value is a string.
    
    Specified by:
    
    hasLabel in interface Element
    
    Parameters:
    key - The name of the label.
    
    Returns:
    True if a value is present for this attribute and implements CharSequence.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - hasNumber
```
public boolean hasNumber(String key)
```
    Description copied from interface: Element
    
    Does this element store a number for the given key? A number is an attribute whose value is an instance of Number.
    
    Specified by:
    
    hasNumber in interface Element
    
    Parameters:
    key - The name of the number.
    
    Returns:
    True if a value is present for this attribute and can contain a double (inherits from Number).
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - hasVector
```
public boolean hasVector(String key)
```
    Description copied from interface: Element
    
    Does this element store a vector value for the given key? A vector is an attribute whose value is a sequence of numbers.
    
    Specified by:
    
    hasVector in interface Element
    
    Parameters:
    key - The name of the vector.
    
    Returns:
    True if a value is present for this attribute and can contain a sequence of numbers.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - hasArray
```
public boolean hasArray(String key)
```
    Description copied from interface: Element
    
    Does this element store an array value for the given key? A vector is an attribute whose value is an array of objects.
    
    Specified by:
    
    hasArray in interface Element
    
    Parameters:
    key - The name of the array.
    
    Returns:
    True if a value is present for this attribute and can contain an array object.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - hasHash
```
public boolean hasHash(String key)
```
    Description copied from interface: Element
    
    Does this element store a hash value for the given key? A hash is a set of pairs (key,value) or objects that implement the CompoundAttribute class.
    
    Specified by:
    
    hasHash in interface Element
    
    Parameters:
    key - The name of the hash.
    
    Returns:
    True if a value is present for this attribute and can contain a hash.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - getAttributeKeyIterator
```
public Iterator<String> getAttributeKeyIterator()
```
    Description copied from interface: Element
    
    Iterator on all attributes keys.
    
    Specified by:
    
    getAttributeKeyIterator in interface Element
    
    Returns:
    An iterator on the key set of attributes.
  - getEachAttributeKey
```
public Iterable<String> getEachAttributeKey()
```
    Description copied from interface: Element
    
    An iterable view on the set of attribute keys usable within a for-each loop.
    
    Specified by:
    
    getEachAttributeKey in interface Element
    
    Returns:
    an iterable view on attribute keys.
  - getAttributeKeySet
```
public Collection<String> getAttributeKeySet()
```
    Description copied from interface: Element
    
    An unmodifiable view on the set of attribute keys.
    
    Specified by:
    
    getAttributeKeySet in interface Element
    
    Returns:
    an unmodifiable collection containing the attribute keys.
  - toString
```
public String toString()
```
    Override the Object method
    
    Overrides:
    
    toString in class Object
  - getAttributeCount
```
public int getAttributeCount()
```
    Description copied from interface: Element
    
    Number of attributes stored in this element.
    
    Specified by:
    
    getAttributeCount in interface Element
    
    Returns:
    the number of attributes.
  - clearAttributes
```
public void clearAttributes()
```
    Description copied from interface: Element
    
    Remove all registered attributes. This includes numbers, labels and vectors.
    
    Specified by:
    
    clearAttributes in interface Element
  - addAttribute
```
public void addAttribute(String attribute,
                Object... values)
```
    Description copied from interface: Element
    
    Add or replace the value of an attribute. Existing attributes are overwritten silently. All classes inheriting from Number can be considered as numbers. All classes inheriting from CharSequence can be considered as labels. You can pass zero, one or more arguments for the attribute values. If no value is given, a boolean with value "true" is added. If there is more than one value, an array is stored. If there is only one value, the value is stored (but not in an array).
    
    Specified by:
    
    addAttribute in interface Element
    
    Parameters:
    attribute - The attribute name.
    values - The attribute value or set of values.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - changeAttribute
```
public void changeAttribute(String attribute,
                   Object... values)
```
    Description copied from interface: Element
    
    Like Element.addAttribute(String, Object...) but for consistency.
    
    Specified by:
    
    changeAttribute in interface Element
    
    Parameters:
    attribute - The attribute name.
    values - The attribute value or array of values.
    See Also:
    Element.addAttribute(String, Object...)
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - setAttribute
```
public void setAttribute(String attribute,
                Object... values)
```
    Description copied from interface: Element
    
    Like Element.addAttribute(String, Object...) but for consistency.
    
    Specified by:
    
    setAttribute in interface Element
    
    Parameters:
    attribute - The attribute name.
    values - The attribute value or array of values.
    See Also:
    Element.addAttribute(String, Object...)
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - addAttributes
```
public void addAttributes(Map<String,Object> attributes)
```
    Description copied from interface: Element
    
    Add or replace each attribute found in attributes. Existing attributes are overwritten silently. All classes inheriting from Number can be considered as numbers. All classes inheriting from CharSequence can be considered as labels.
    
    Specified by:
    
    addAttributes in interface Element
    
    Parameters:
    attributes - A set of (key,value) pairs.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.
  - removeAttribute
```
public void removeAttribute(String attribute)
```
    Description copied from interface: Element
    
    Remove an attribute. Non-existent attributes errors are ignored silently.
    
    Specified by:
    
    removeAttribute in interface Element
    
    Parameters:
    attribute - Name of the attribute to remove.
    Computational Complexity :
    
    O(log(n)) with n being the number of attributes of this element.

Class AbstractElement

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractElement

Method Detail

getId

getIndex

getAttribute

getFirstAttributeOf

getAttribute

getFirstAttributeOf

getLabel

getNumber

getVector

getArray

getHash

hasAttribute

hasAttribute

hasLabel

hasNumber

hasVector

hasArray

hasHash

getAttributeKeyIterator

getEachAttributeKey

getAttributeKeySet

toString

getAttributeCount

clearAttributes

addAttribute

changeAttribute

setAttribute

addAttributes

removeAttribute