Package com.syncleus.ferma

Class AbstractElementFrame

java.lang.Object

com.syncleus.ferma.AbstractElementFrame

All Implemented Interfaces:

ElementFrame

Direct Known Subclasses:

AbstractEdgeFrame, AbstractVertexFrame

public abstract class AbstractElementFrame
extends Object
implements ElementFrame

The base of all framed elements.

Constructor Summary

Constructors

Constructor	Description
AbstractElementFrame()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
org.apache.tinkerpop.gremlin.structure.Element	getElement()
FramedGraph	getGraph()
<N> N	getId()
<T> T	getProperty(String name)	Return a property value.
<T> T	getProperty(String name, Class<T> type)	Return a property value.
Set<String>	getPropertyKeys()
Class<?>	getTypeResolution()	Returns the type resolution currently encoded into the element.
int	hashCode()
void	remove()	Remove this element from the graph.
void	removeTypeResolution()	Removes type resolution from this node and decodes it from the element in the graph.
void	setElement(org.apache.tinkerpop.gremlin.structure.Element element)	Set the underlying element.
void	setProperty(String name, Object value)	Set a property value.
void	setTypeResolution(Class<?> type)	Sets the type resolution and encodes it into the element in the graph.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractElementFrame

public AbstractElementFrame()

Method Detail

getId

public <N> N getId()

Specified by:

getId in interface ElementFrame

Type Parameters:

N - The ID's type.

Returns:

The id of this element.

getPropertyKeys

public Set<String> getPropertyKeys()

Specified by:

getPropertyKeys in interface ElementFrame

Returns:

The property keys of this element.

getTypeResolution

public Class<?> getTypeResolution()

Description copied from interface: ElementFrame

Returns the type resolution currently encoded into the element.

Specified by:

getTypeResolution in interface ElementFrame

Returns:

the current type resolution.

setTypeResolution

public void setTypeResolution(Class<?> type)

Description copied from interface: ElementFrame

Sets the type resolution and encodes it into the element in the graph.

Specified by:

setTypeResolution in interface ElementFrame

Parameters:

type - The new type to resolve this element to.

removeTypeResolution

public void removeTypeResolution()

Description copied from interface: ElementFrame

Removes type resolution from this node and decodes it from the element in the graph.

Specified by:

removeTypeResolution in interface ElementFrame

remove

public void remove()

Description copied from interface: ElementFrame

Remove this element from the graph.

Specified by:

remove in interface ElementFrame

getElement

public org.apache.tinkerpop.gremlin.structure.Element getElement()

Specified by:

getElement in interface ElementFrame

Returns:

The underlying element.

setElement

public void setElement(org.apache.tinkerpop.gremlin.structure.Element element)

Description copied from interface: ElementFrame

Set the underlying element.

Specified by:

setElement in interface ElementFrame

Parameters:

element - The new underlying element.

getGraph

public FramedGraph getGraph()

Specified by:

getGraph in interface ElementFrame

Returns:

The underlying graph.

getProperty

public <T> T getProperty(String name)

Description copied from interface: ElementFrame

Return a property value.

Specified by:

getProperty in interface ElementFrame

Type Parameters:

T - The type of the property value.

Parameters:

name - The name of the property.

Returns:

the value of the property or null if none was present.

getProperty

public <T> T getProperty(String name,
                         Class<T> type)

Description copied from interface: ElementFrame

Return a property value.

Specified by:

getProperty in interface ElementFrame

Type Parameters:

T - The type of the property value.

Parameters:

name - The name of the property.

type - The type of the property.

Returns:

the value of the property or null if none was present.

setProperty

public void setProperty(String name,
                        Object value)

Description copied from interface: ElementFrame

Set a property value.

Specified by:

setProperty in interface ElementFrame

Parameters:

name - The name of the property.

value - The value of the property.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object