|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.graphstream.graph.implementations.AbstractElement
public abstract class AbstractElement
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.
Nested Class Summary | |
---|---|
static class |
AbstractElement.AttributeChangeEvent
|
Constructor Summary | |
---|---|
AbstractElement(String id)
New element. |
Method Summary | ||
---|---|---|
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. |
|
|
getAttribute(String key)
Get the attribute object bound to the given key. |
|
|
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 iterable view on the set of attributes keys usable with the for-each loop. |
|
Iterable<String> |
getEachAttributeKey()
|
|
|
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. |
|
|
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 |
|
CharSequence |
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 |
---|
public AbstractElement(String id)
id
- The unique identifier of this element.Method Detail |
---|
public String getId()
Element
getId
in interface Element
public int getIndex()
Element
getIndex
in interface Element
public <T> T getAttribute(String key)
Element
getAttribute
in interface Element
key
- Name of the attribute to search.
public <T> T getFirstAttributeOf(String... keys)
Element
Element.getAttribute(String)
, but returns the first existing
attribute in a list of keys, instead of only one key. The key list order
matters.
getFirstAttributeOf
in interface Element
keys
- Several strings naming attributes.
public <T> T getAttribute(String key, Class<T> clazz)
Element
getAttribute
in interface Element
key
- The attribute name to search.clazz
- The expected attribute class.
public <T> T getFirstAttributeOf(Class<T> clazz, String... keys)
Element
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.
getFirstAttributeOf
in interface Element
clazz
- The class the attribute must be instance of.keys
- Several string naming attributes.
public CharSequence getLabel(String key)
Element
getLabel
in interface Element
key
- The label to search.
public double getNumber(String key)
Element
getNumber
in interface Element
key
- The name of the number to search.
public ArrayList<? extends Number> getVector(String key)
Element
getVector
in interface Element
key
- The name of the number to search.
public Object[] getArray(String key)
Element
getArray
in interface Element
key
- The name of the array to search.
public HashMap<?,?> getHash(String key)
Element
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.
getHash
in interface Element
key
- The name of the hash to search.
public boolean hasAttribute(String key)
Element
hasAttribute
in interface Element
key
- The name of the attribute to search.
public boolean hasAttribute(String key, Class<?> clazz)
Element
hasAttribute
in interface Element
key
- The name of the attribute to search.clazz
- The expected class of the attribute value.
public boolean hasLabel(String key)
Element
hasLabel
in interface Element
key
- The name of the label.
public boolean hasNumber(String key)
Element
hasNumber
in interface Element
key
- The name of the number.
public boolean hasVector(String key)
Element
hasVector
in interface Element
key
- The name of the vector.
public boolean hasArray(String key)
Element
hasArray
in interface Element
key
- The name of the array.
public boolean hasHash(String key)
Element
CompoundAttribute
class.
hasHash
in interface Element
key
- The name of the hash.
public Iterator<String> getAttributeKeyIterator()
Element
getAttributeKeyIterator
in interface Element
public Iterable<String> getEachAttributeKey()
public Collection<String> getAttributeKeySet()
Element
getAttributeKeySet
in interface Element
public String toString()
toString
in class Object
public int getAttributeCount()
Element
getAttributeCount
in interface Element
public void clearAttributes()
Element
clearAttributes
in interface Element
public void addAttribute(String attribute, Object... values)
Element
addAttribute
in interface Element
attribute
- The attribute name.values
- The attribute value or set of values.public void changeAttribute(String attribute, Object... values)
Element
Element.addAttribute(String, Object...)
but for consistency.
changeAttribute
in interface Element
attribute
- The attribute name.values
- The attribute value or array of values.Element.addAttribute(String, Object...)
public void setAttribute(String attribute, Object... values)
Element
Element.addAttribute(String, Object...)
but for consistency.
setAttribute
in interface Element
attribute
- The attribute name.values
- The attribute value or array of values.Element.addAttribute(String, Object...)
public void addAttributes(Map<String,Object> attributes)
Element
addAttributes
in interface Element
attributes
- A set of (key,value) pairs.public void removeAttribute(String attribute)
Element
removeAttribute
in interface Element
attribute
- Name of the attribute to remove.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |