com.tinkerpop.blueprints.impls.orient

Class OrientElement

java.lang.Object

com.tinkerpop.blueprints.impls.orient.OrientElement

All Implemented Interfaces:

OIdentifiable, OSerializableStream, com.tinkerpop.blueprints.Element, Externalizable, Serializable, Comparable<OIdentifiable>, Comparator<OIdentifiable>

Direct Known Subclasses:

OrientEdge, OrientVertex

public abstract class OrientElement
extends Object
implements com.tinkerpop.blueprints.Element, OSerializableStream, Externalizable, OIdentifiable

Base Graph Element where OrientVertex and OrientEdge classes extends from. Labels are managed as OrientDB classes.

Author:

Luca Garulli (http://www.orientechnologies.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Object	DEF_ORIGINAL_ID_FIELDNAME
protected OrientBaseGraph	graph
static String	LABEL_FIELD_NAME
protected OIdentifiable	rawElement
protected OrientBaseGraph.Settings	settings

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OrientElement(OrientBaseGraph rawGraph, OIdentifiable iRawElement)

Method Summary

Methods

Modifier and Type	Method and Description
OrientElement	attach(OrientBaseGraph iNewGraph) (Blueprints Extension) Replaces current graph instance with new one on @detach -ed elements.
protected void	checkClass()
protected String	checkForClassInSchema(String iClassName) Check if a class already exists, otherwise create it at the fly.
protected void	checkIfAttached()
int	compare(OIdentifiable iFirst, OIdentifiable iSecond)
int	compareTo(OIdentifiable iOther)
OrientElement	detach() (Blueprints Extension) Removes the reference to the current graph instance to let working offline.
boolean	equals(Object object)
OSerializableStream	fromStream(byte[] iStream) (Blueprints Extension) Fills the Element from a byte[]
abstract String	getBaseClassName()
abstract String	getElementType() (Blueprints Extension) Returns the element type in form of String between "Vertex" and "Edge".
OrientBaseGraph	getGraph() (Blueprints Extension) Returns the Graph instance associated to the current element.
Object	getId() Returns the Element Id assuring to save it if it's transient yet.
ORID	getIdentity() (Blueprints Extension) Returns the record's identity.
<T> T	getProperty(String key) Returns a Property value.
ODocument	getRecord() (Blueprints Extension) Returns the underlying record.
int	hashCode()
boolean	isDetached() (Blueprints Extension) Tells if the current element has been @detach ed.
void	lock(boolean iExclusive) (Blueprints Extension) Locks current Element to prevent concurrent access.
void	readExternal(ObjectInput in)
void	remove() Removes the Element from the Graph.
<T> T	removeProperty(String key) Removed a Property.
void	save() (Blueprints Extension) Saves current element.
void	save(String iClusterName) (Blueprints Extension) Saves current element to a particular cluster.
protected void	setCurrentGraphInThreadLocal()
<T extends OrientElement> T	setProperties(Object... fields) (Blueprints Extension) Sets multiple properties in one shot against Vertices and Edges.
void	setProperty(String key, Object value) Set a Property value.
protected void	setPropertyInternal(com.tinkerpop.blueprints.Element element, ODocument doc, String key, Object value)
byte[]	toStream() (Blueprints Extension) Serializes the Element as byte[]
void	unlock() (Blueprints Extension) Unlocks previous acquired @lock against the Element.
void	validateProperty(com.tinkerpop.blueprints.Element element, String key, Object value) (Blueprints Extension) Validates an Element property.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tinkerpop.blueprints.Element

getPropertyKeys

Field Detail

LABEL_FIELD_NAME

public static final String LABEL_FIELD_NAME

See Also:

Constant Field Values

DEF_ORIGINAL_ID_FIELDNAME

public static final Object DEF_ORIGINAL_ID_FIELDNAME

graph

protected transient OrientBaseGraph graph

settings

protected transient OrientBaseGraph.Settings settings

rawElement

protected OIdentifiable rawElement

Constructor Detail

OrientElement

protected OrientElement(OrientBaseGraph rawGraph,
             OIdentifiable iRawElement)

Method Detail

getBaseClassName

public abstract String getBaseClassName()

getElementType

public abstract String getElementType()

(Blueprints Extension) Returns the element type in form of String between "Vertex" and "Edge".

remove

public void remove()

Removes the Element from the Graph. In case the element is a Vertex, all the incoming and outgoing edges are automatically removed too.

Specified by:

remove in interface com.tinkerpop.blueprints.Element

setProperties

public <T extends OrientElement> T setProperties(Object... fields)

(Blueprints Extension) Sets multiple properties in one shot against Vertices and Edges. This improves performance avoiding to save the graph element at every property set. Example: vertex.setProperties( "name", "Jill", "age", 33, "city", "Rome", "born", "Victoria, TX" ); You can also pass a Map of values as first argument. In this case all the map entries will be set as element properties: Map props = new HashMap(); props.put("name", "Jill"); props.put("age", 33); props.put("city", "Rome"); props.put("born", "Victoria, TX"); vertex.setProperties(props);

Type Parameters:

T -

Parameters:

fields - Odd number of fields to set as repeating pairs of key, value, or if one parameter is received and it's a Map, the Map entries are used as field key/value pairs.

Returns:

setProperty

public void setProperty(String key,
               Object value)

Set a Property value.

Specified by:

setProperty in interface com.tinkerpop.blueprints.Element

Parameters:

key - Property name

value - Property value

removeProperty

public <T> T removeProperty(String key)

Removed a Property.

Specified by:

removeProperty in interface com.tinkerpop.blueprints.Element

Parameters:

key - Property name

Returns:

Old value if any

getProperty

public <T> T getProperty(String key)

Returns a Property value.

Specified by:

getProperty in interface com.tinkerpop.blueprints.Element

Parameters:

key - Property name

Returns:

Property value if any, otherwise NULL.

getId

public Object getId()

Returns the Element Id assuring to save it if it's transient yet.

Specified by:

getId in interface com.tinkerpop.blueprints.Element

save

public void save()

(Blueprints Extension) Saves current element. You don't need to call save() unless you're working against Temporary Vertices.

save

public void save(String iClusterName)

(Blueprints Extension) Saves current element to a particular cluster. You don't need to call save() unless you're working against Temporary Vertices.

Parameters:

iClusterName - Cluster name or null to use the default "E"

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toStream

public byte[] toStream()
                throws OSerializationException

(Blueprints Extension) Serializes the Element as byte[]

Specified by:

toStream in interface OSerializableStream

Throws:

OSerializationException

fromStream

public OSerializableStream fromStream(byte[] iStream)
                               throws OSerializationException

(Blueprints Extension) Fills the Element from a byte[]

Specified by:

fromStream in interface OSerializableStream

Parameters:

iStream - byte array representation of the object

Throws:

OSerializationException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

lock

public void lock(boolean iExclusive)

(Blueprints Extension) Locks current Element to prevent concurrent access. If lock is exclusive, then no concurrent threads can read/write it. If the lock is shared, then concurrent threads can only read Element properties, but can't change them. Locks can be freed by calling @unlock or when the current transaction is closed (committed or rollbacked).

Specified by:

lock in interface OIdentifiable

Parameters:

iExclusive - True = Exclusive Lock, False = Shared Lock

See Also:

lock(boolean)

unlock

public void unlock()

(Blueprints Extension) Unlocks previous acquired @lock against the Element.

Specified by:

unlock in interface OIdentifiable

See Also:

lock(boolean)

getIdentity

public ORID getIdentity()

(Blueprints Extension) Returns the record's identity.

Specified by:

getIdentity in interface OIdentifiable

getRecord

public ODocument getRecord()

(Blueprints Extension) Returns the underlying record.

Specified by:

getRecord in interface OIdentifiable

detach

public OrientElement detach()

(Blueprints Extension) Removes the reference to the current graph instance to let working offline. To reattach it use @attach.

Returns:

Current object to allow chained calls.

See Also:

#attach(OrientBaseGraph), #isDetached

attach

public OrientElement attach(OrientBaseGraph iNewGraph)

(Blueprints Extension) Replaces current graph instance with new one on @detach -ed elements. Use this method to pass elements between graphs or to switch between Tx and NoTx instances.

Parameters:

iNewGraph - The new Graph instance to use.

Returns:

Current object to allow chained calls.

See Also:

#detach(), #isDetached

isDetached

public boolean isDetached()

(Blueprints Extension) Tells if the current element has been @detach ed.

Returns:

True if detached, otherwise false

See Also:

#attach(OrientBaseGraph), #detach

equals

public boolean equals(Object object)

Specified by:

equals in interface Comparator<OIdentifiable>

Overrides:

equals in class Object

compare

public int compare(OIdentifiable iFirst,
          OIdentifiable iSecond)

Specified by:

compare in interface Comparator<OIdentifiable>

compareTo

public int compareTo(OIdentifiable iOther)

Specified by:

compareTo in interface Comparable<OIdentifiable>

getGraph

public OrientBaseGraph getGraph()

(Blueprints Extension) Returns the Graph instance associated to the current element. On @detach ed elements returns NULL.

validateProperty

public final void validateProperty(com.tinkerpop.blueprints.Element element,
                    String key,
                    Object value)
                            throws IllegalArgumentException

(Blueprints Extension) Validates an Element property.

Parameters:

element - Element instance

key - Property name

value - property value

Throws:

IllegalArgumentException

checkClass

protected void checkClass()

checkForClassInSchema

protected String checkForClassInSchema(String iClassName)

Check if a class already exists, otherwise create it at the fly. If a transaction is running commit changes, create the class and begin a new transaction.

Parameters:

iClassName - Class's name

setPropertyInternal

protected void setPropertyInternal(com.tinkerpop.blueprints.Element element,
                       ODocument doc,
                       String key,
                       Object value)

setCurrentGraphInThreadLocal

protected void setCurrentGraphInThreadLocal()

checkIfAttached

protected void checkIfAttached()