com.datastax.driver.dse.graph

Interface Element

All Known Subinterfaces:

Edge, Vertex, VertexProperty

public interface Element

The representation of an element in DSE Graph.

Elements in DSE Graph can be of three specific types: Vertex, Edge and VertexProperty.

Method Summary

Modifier and Type	Method and Description
GraphNode	getId() Returns the element's identifier.
String	getLabel() Returns the element's label.
Iterator<? extends Property>	getProperties() Returns an iterator over the element's properties, or an empty iterator, if the element does not have any property.
Iterator<? extends Property>	getProperties(String name) Returns all the properties of this element that have the given name, or an empty iterator, if such a property name does not exist.
Property	getProperty(String name) Returns the first property of this element that has the given name, or null, if such a property name does not exist.
Set<String>	getPropertyNames() Returns the set of property names for this element, or an empty set, if this element has no properties.

Method Detail

getId

GraphNode getId()

Returns the element's identifier. Should never be null.

Returns:

the element's identifier.

getLabel

String getLabel()

Returns the element's label. Should never be null.

Returns:

the element's label.

getPropertyNames

Set<String> getPropertyNames()

Returns the set of property names for this element, or an empty set, if this element has no properties.

The returned set is immutable.

Returns:

the set of property names for this element.

getProperty

Property getProperty(String name)

Returns the first property of this element that has the given name, or null, if such a property name does not exist.

If more than one property of this element has the given name, which one will be returned is unspecified.

Returns:

the first property of this element that has the given name.

getProperties

Iterator<? extends Property> getProperties(String name)

Returns all the properties of this element that have the given name, or an empty iterator, if such a property name does not exist.

The returned iterator is immutable.

Returns:

all the properties of this element that have the given name.

getProperties

Iterator<? extends Property> getProperties()

Returns an iterator over the element's properties, or an empty iterator, if the element does not have any property.

The returned iterator is immutable.

Returns:

an iterator over the element's properties.