com.tinkerpop.gremlin.structure.util.detached

Class DetachedElement<E>

java.lang.Object

com.tinkerpop.gremlin.structure.util.detached.DetachedElement<E>

All Implemented Interfaces:

Element, Element.Iterators, Attachable<E>, java.io.Serializable

Direct Known Subclasses:

DetachedEdge, DetachedVertex, DetachedVertexProperty

public abstract class DetachedElement<E>
extends java.lang.Object
implements Element, Element.Iterators, java.io.Serializable, Attachable<E>

Author:

Stephen Mallette (http://stephen.genoprime.com), Marko A. Rodriguez (http://markorodriguez.com)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.tinkerpop.gremlin.structure.Element

Element.Exceptions, Element.Iterators

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	id
protected java.lang.String	label
protected java.util.Map<java.lang.String,java.util.List<? extends Property>>	properties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DetachedElement()
protected	DetachedElement(Element element)
protected	DetachedElement(java.lang.Object id, java.lang.String label)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object)
Graph	graph() Get the graph that this element is within.
int	hashCode()
java.lang.Object	id() Gets the unique identifier for the graph Element.
Element.Iterators	iterators() Gets the iterators for the Element.
java.lang.String	label() Gets the label for the graph Element which helps categorize it.
<V> Property<V>	property(java.lang.String key) Get a Property for the Element given its key.
<V> Property<V>	property(java.lang.String key, V value) Add or set a property value for the Element given its key.
<V> java.util.Iterator<? extends Property<V>>	propertyIterator(java.lang.String... propertyKeys) Get an Iterator of properties.
void	remove() Removes the Element from the graph.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.tinkerpop.gremlin.structure.Element

keys, value

Methods inherited from interface com.tinkerpop.gremlin.structure.Element.Iterators

valueIterator

Methods inherited from interface com.tinkerpop.gremlin.structure.util.detached.Attachable

attach, attach

Field Detail

id

protected java.lang.Object id

label

protected java.lang.String label

properties

protected java.util.Map<java.lang.String,java.util.List<? extends Property>> properties

Constructor Detail

DetachedElement

protected DetachedElement()

DetachedElement

protected DetachedElement(Element element)

DetachedElement

protected DetachedElement(java.lang.Object id,
                          java.lang.String label)

Method Detail

graph

public Graph graph()

Description copied from interface: Element

Get the graph that this element is within.

Specified by:

graph in interface Element

Returns:

the graph of this element

id

public java.lang.Object id()

Description copied from interface: Element

Gets the unique identifier for the graph Element.

Specified by:

id in interface Element

Returns:

The id of the element

label

public java.lang.String label()

Description copied from interface: Element

Gets the label for the graph Element which helps categorize it.

Specified by:

label in interface Element

Returns:

The label of the element

property

public <V> Property<V> property(java.lang.String key,
                                V value)

Description copied from interface: Element

Add or set a property value for the Element given its key.

Specified by:

property in interface Element

property

public <V> Property<V> property(java.lang.String key)

Description copied from interface: Element

Get a Property for the Element given its key. The default implementation calls the raw Element#iterators#propertyIterator.

Specified by:

property in interface Element

remove

public void remove()

Description copied from interface: Element

Removes the Element from the graph.

Specified by:

remove in interface Element

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

iterators

public Element.Iterators iterators()

Description copied from interface: Element

Gets the iterators for the Element. Iterators provide low-level access to the data associated with an Element as they do not come with the overhead of Traversal construction. Use iterators in places where performance is most crucial.

Specified by:

iterators in interface Element

propertyIterator

public <V> java.util.Iterator<? extends Property<V>> propertyIterator(java.lang.String... propertyKeys)

Description copied from interface: Element.Iterators

Get an Iterator of properties.

Specified by:

propertyIterator in interface Element.Iterators