com.orientechnologies.orient.core.record.impl

Class OEdgeDelegate

java.lang.Object

com.orientechnologies.orient.core.record.impl.OEdgeDelegate

All Implemented Interfaces:

OIdentifiable, ORecordElement, OEdge, OElement, ORecord, OSerializableStream, Serializable, Comparable<OIdentifiable>, Comparator<OIdentifiable>

public class OEdgeDelegate
extends Object
implements OEdge

Author:

Luigi Dell'Aquila

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.db.record.ORecordElement

ORecordElement.STATUS

Field Summary

Fields

Modifier and Type	Field and Description
protected ODocument	element
protected OClass	lightweightEdgeType
protected String	lightwightEdgeLabel
protected OVertex	vIn
protected OVertex	vOut

Fields inherited from interface com.orientechnologies.orient.core.record.OEdge

DIRECITON_IN, DIRECITON_OUT, DIRECTION_IN, DIRECTION_OUT

Constructor Summary

Constructors

Constructor and Description
OEdgeDelegate(ODocument elem)
OEdgeDelegate(OVertex out, OVertex in, OClass lightweightEdgeType, String edgeLabel)

Method Summary

Modifier and Type	Method and Description
Optional<OEdge>	asEdge() Returns an instance of OEdge representing current element
Optional<OVertex>	asVertex() Returns an instance of OVertex representing current element
OEdge	clear() All the fields are deleted but the record identity is maintained.
int	compare(OIdentifiable o1, OIdentifiable o2)
int	compareTo(OIdentifiable o)
OEdge	copy() Creates a copy of the record.
OEdge	delete() Deletes the record from the database.
static void	deleteLinks(OEdge delegate)
boolean	detach() Removes all the dependencies with other records.
boolean	equals(Object obj)
<RET extends ORecord> RET	fromJSON(String iJson) Fills the record parsing the content in JSON format.
OSerializableStream	fromStream(byte[] iStream) Unmarshalls the object.
ODatabaseDocument	getDatabase() Returns the database where the record belongs.
OVertex	getFrom()
ORID	getIdentity() Returns the record identity as <cluster-id>:<cluster-position>
ORecordElement.STATUS	getInternalStatus() Returns the current status of the record.
ORecordElement	getOwner()
<RET> RET	getProperty(String name) Gets a property given its name
Set<String>	getPropertyNames() Returns all the names of defined properties
<T extends ORecord> T	getRecord() Returns the record instance.
Optional<OClass>	getSchemaType() Returns the type of current element, ie the class in the schema (if any)
int	getSize() Returns the size in bytes of the record.
OVertex	getTo()
int	getVersion() Returns the current version number of the record.
int	hashCode()
boolean	hasProperty(String propertyName) Check if a property exists in the Element
boolean	isDirty() Checks if the record is dirty, namely if it was changed in memory.
boolean	isEdge() return true if the current element is an edge
boolean	isLabeled(String[] labels)
boolean	isLightweight()
boolean	isLocked()
boolean	isVertex() return true if the current element is a vertex
<RET extends ORecord> RET	load() Loads the record content in memory.
void	lock(boolean iExclusive)
OStorage.LOCKING_STRATEGY	lockingStrategy()
<RET extends ORecord> RET	reload() Loads the record content in memory.
<RET extends ORecord> RET	reload(String fetchPlan, boolean ignoreCache, boolean force)
<RET> RET	removeProperty(String name) Remove a property
<RET extends ORecord> RET	reset() Resets the record to be reused.
<RET extends ORecord> RET	save() Saves in-memory changes to the database.
<RET extends ORecord> RET	save(boolean forceCreate)
<RET extends ORecord> RET	save(String iCluster) Saves in-memory changes to the database defining a specific cluster where to save it.
<RET extends ORecord> RET	save(String iCluster, boolean forceCreate)
<RET> RET	setDirty() Marks the instance as dirty.
void	setDirtyNoChanged()
void	setInternalStatus(ORecordElement.STATUS iStatus) Changes the current internal status.
void	setProperty(String name, Object value) Sets a property value
void	setProperty(String name, Object value, OType... fieldType) Sets a property value
String	toJSON() Exports the record in JSON format.
String	toJSON(String iFormat) Exports the record in JSON format specifying additional formatting settings.
byte[]	toStream() Marshalls the object.
String	toString()
OEdge	unload() Unloads current record.
void	unlock()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orientechnologies.orient.core.record.OEdge

getVertex

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

vOut

protected OVertex vOut

vIn

protected OVertex vIn

lightweightEdgeType

protected OClass lightweightEdgeType

lightwightEdgeLabel

protected String lightwightEdgeLabel

element

protected ODocument element

Constructor Detail

OEdgeDelegate

public OEdgeDelegate(OVertex out,
                     OVertex in,
                     OClass lightweightEdgeType,
                     String edgeLabel)

OEdgeDelegate

public OEdgeDelegate(ODocument elem)

Method Detail

getFrom

public OVertex getFrom()

Specified by:

getFrom in interface OEdge

getTo

public OVertex getTo()

Specified by:

getTo in interface OEdge

isLightweight

public boolean isLightweight()

Specified by:

isLightweight in interface OEdge

getPropertyNames

public Set<String> getPropertyNames()

Description copied from interface: OElement

Returns all the names of defined properties

Specified by:

getPropertyNames in interface OElement

Returns:

all the names of defined properties

delete

public OEdge delete()

Description copied from interface: ORecord

Deletes the record from the database. Behavior depends by the current running transaction if any. If no transaction is running then the record is deleted immediately. If an Optimistic transaction is running then the record will be deleted at commit time. The current transaction will continue to see the record as deleted, while others not. If a Pessimistic transaction is running, then an exclusive lock is acquired against the record. Current transaction will continue to see the record as deleted, while others cannot access to it since it's locked.

Specified by:

delete in interface ORecord

Returns:

The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.

deleteLinks

public static void deleteLinks(OEdge delegate)

getProperty

public <RET> RET getProperty(String name)

Description copied from interface: OElement

Gets a property given its name

Specified by:

getProperty in interface OElement

Parameters:

name - the property name

Returns:

Returns the property value

hasProperty

public boolean hasProperty(String propertyName)

Description copied from interface: OElement

Check if a property exists in the Element

Specified by:

hasProperty in interface OElement

Returns:

true if exists otherwise false.

setProperty

public void setProperty(String name,
                        Object value)

Description copied from interface: OElement

Sets a property value

Specified by:

setProperty in interface OElement

Parameters:

name - the property name

value - the property value

setProperty

public void setProperty(String name,
                        Object value,
                        OType... fieldType)

Description copied from interface: OElement

Sets a property value

Specified by:

setProperty in interface OElement

Parameters:

name - the property name

value - the property value

fieldType - Forced type (not auto-determined)

removeProperty

public <RET> RET removeProperty(String name)

Description copied from interface: OElement

Remove a property

Specified by:

removeProperty in interface OElement

Parameters:

name - the property name

asVertex

public Optional<OVertex> asVertex()

Description copied from interface: OElement

Returns an instance of OVertex representing current element

Specified by:

asVertex in interface OElement

Returns:

An OVertex that represents the current element. An empty optional if the current element is not a vertex

asEdge

public Optional<OEdge> asEdge()

Description copied from interface: OElement

Returns an instance of OEdge representing current element

Specified by:

asEdge in interface OElement

Returns:

An OEdge that represents the current element. An empty optional if the current element is not an edge

isVertex

public boolean isVertex()

Description copied from interface: OElement

return true if the current element is a vertex

Specified by:

isVertex in interface OElement

Returns:

true if the current element is a vertex

isEdge

public boolean isEdge()

Description copied from interface: OElement

return true if the current element is an edge

Specified by:

isEdge in interface OElement

Returns:

true if the current element is an edge

getSchemaType

public Optional<OClass> getSchemaType()

Description copied from interface: OElement

Returns the type of current element, ie the class in the schema (if any)

Specified by:

getSchemaType in interface OElement

Returns:

the type of current element. An empty optional is returned if current element does not have a schema

isLabeled

public boolean isLabeled(String[] labels)

Specified by:

isLabeled in interface OEdge

getIdentity

public ORID getIdentity()

Description copied from interface: ORecord

Returns the record identity as <cluster-id>:<cluster-position>

Specified by:

getIdentity in interface OIdentifiable

Specified by:

getIdentity in interface ORecord

Returns:

ORID instance

getRecord

public <T extends ORecord> T getRecord()

Description copied from interface: OIdentifiable

Returns the record instance.

Specified by:

getRecord in interface OIdentifiable

Returns:

ORecord instance

lock

public void lock(boolean iExclusive)

Specified by:

lock in interface OIdentifiable

isLocked

public boolean isLocked()

Specified by:

isLocked in interface OIdentifiable

lockingStrategy

public OStorage.LOCKING_STRATEGY lockingStrategy()

Specified by:

lockingStrategy in interface OIdentifiable

unlock

public void unlock()

Specified by:

unlock in interface OIdentifiable

compare

public int compare(OIdentifiable o1,
                   OIdentifiable o2)

Specified by:

compare in interface Comparator<OIdentifiable>

compareTo

public int compareTo(OIdentifiable o)

Specified by:

compareTo in interface Comparable<OIdentifiable>

equals

public boolean equals(Object obj)

Specified by:

equals in interface Comparator<OIdentifiable>

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getInternalStatus

public ORecordElement.STATUS getInternalStatus()

Description copied from interface: ORecord

Returns the current status of the record.

Specified by:

getInternalStatus in interface ORecord

Returns:

Current status as value between the defined values in the enum STATUS

setInternalStatus

public void setInternalStatus(ORecordElement.STATUS iStatus)

Description copied from interface: ORecord

Changes the current internal status.

Specified by:

setInternalStatus in interface ORecord

Parameters:

iStatus - status between the values defined in the enum STATUS

setDirty

public <RET> RET setDirty()

Description copied from interface: ORecordElement

Marks the instance as dirty. The dirty status could be propagated up if the implementation supports ownership concept.

Specified by:

setDirty in interface ORecordElement

Returns:

The object it self. Useful to call methods in chain.

setDirtyNoChanged

public void setDirtyNoChanged()

Specified by:

setDirtyNoChanged in interface ORecordElement

getOwner

public ORecordElement getOwner()

Specified by:

getOwner in interface ORecordElement

Returns:

Returns record element which contains given one.

toStream

public byte[] toStream()
                throws OSerializationException

Description copied from interface: OSerializableStream

Marshalls the object. Transforms the current object in byte[] form to being stored or transferred over the network.

Specified by:

toStream in interface OSerializableStream

Returns:

The byte array representation of the object

Throws:

OSerializationException - if the marshalling does not succeed

See Also:

OSerializableStream.fromStream(byte[])

fromStream

public OSerializableStream fromStream(byte[] iStream)
                               throws OSerializationException

Description copied from interface: OSerializableStream

Unmarshalls the object. Fills the current object with the values contained in the byte array representation restoring a previous state. Usually byte[] comes from the storage or network.

Specified by:

fromStream in interface OSerializableStream

Parameters:

iStream - byte array representation of the object

Returns:

The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.

Throws:

OSerializationException - if the unmarshalling does not succeed

detach

public boolean detach()

Description copied from interface: ORecord

Removes all the dependencies with other records. All the relationships remain in form of RecordID. If some links contain dirty records, the detach cannot be complete and this method returns false.

Specified by:

detach in interface ORecord

Returns:

True if the document has been successfully detached, otherwise false.

reset

public <RET extends ORecord> RET reset()

Description copied from interface: ORecord

Resets the record to be reused. The record is fresh like just created. Use this method to recycle records avoiding the creation of them stressing the JVM Garbage Collector.

Specified by:

reset in interface ORecord

Returns:

The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.

unload

public OEdge unload()

Description copied from interface: ORecord

Unloads current record. All information are lost but the record identity. At the next access the record will be auto-reloaded. Useful to free memory or to avoid to keep an old version of it.

Specified by:

unload in interface ORecord

Returns:

The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.

clear

public OEdge clear()

Description copied from interface: ORecord

All the fields are deleted but the record identity is maintained. Use this to remove all the document's fields.

Specified by:

clear in interface ORecord

Returns:

The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.

copy

public OEdge copy()

Description copied from interface: ORecord

Creates a copy of the record. All the record contents are copied.

Specified by:

copy in interface ORecord

Returns:

The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.

getVersion

public int getVersion()

Description copied from interface: ORecord

Returns the current version number of the record. When the record is created has version = 0. At every change the storage increment the version number. Version number is used by Optimistic transactions to check if the record is changed in the meanwhile of the transaction.

Specified by:

getVersion in interface ORecord

Returns:

The version number. 0 if it's a brand new record.

See Also:

OTransactionOptimistic

getDatabase

public ODatabaseDocument getDatabase()

Description copied from interface: ORecord

Returns the database where the record belongs.

Specified by:

getDatabase in interface ORecord

Returns:

isDirty

public boolean isDirty()

Description copied from interface: ORecord

Checks if the record is dirty, namely if it was changed in memory.

Specified by:

isDirty in interface ORecord

Returns:

True if dirty, otherwise false

load

public <RET extends ORecord> RET load()
                               throws ORecordNotFoundException

Description copied from interface: ORecord

Loads the record content in memory. If the record is in cache will be returned a new instance, so pay attention to use the returned. If the record is dirty, then it returns to the original content. If the record does not exist a ORecordNotFoundException exception is thrown.

Specified by:

load in interface ORecord

Returns:

The record loaded or itself if the record has been reloaded from the storage. Useful to call methods in chain.

Throws:

ORecordNotFoundException

reload

public <RET extends ORecord> RET reload()
                                 throws ORecordNotFoundException

Description copied from interface: ORecord

Loads the record content in memory. No cache is used. If the record is dirty, then it returns to the original content. If the record does not exist a ORecordNotFoundException exception is thrown.

Specified by:

reload in interface ORecord

Returns:

The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.

Throws:

ORecordNotFoundException

reload

public <RET extends ORecord> RET reload(String fetchPlan,
                                        boolean ignoreCache,
                                        boolean force)
                                 throws ORecordNotFoundException

Specified by:

reload in interface ORecord

Throws:

ORecordNotFoundException

save

public <RET extends ORecord> RET save()

Description copied from interface: ORecord

Saves in-memory changes to the database. Behavior depends by the current running transaction if any. If no transaction is running then changes apply immediately. If an Optimistic transaction is running then the record will be changed at commit time. The current transaction will continue to see the record as modified, while others not. If a Pessimistic transaction is running, then an exclusive lock is acquired against the record. Current transaction will continue to see the record as modified, while others cannot access to it since it's locked.

Specified by:

save in interface ORecord

Returns:

The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.

save

public <RET extends ORecord> RET save(String iCluster)

Description copied from interface: ORecord

Saves in-memory changes to the database defining a specific cluster where to save it. Behavior depends by the current running transaction if any. If no transaction is running then changes apply immediately. If an Optimistic transaction is running then the record will be changed at commit time. The current transaction will continue to see the record as modified, while others not. If a Pessimistic transaction is running, then an exclusive lock is acquired against the record. Current transaction will continue to see the record as modified, while others cannot access to it since it's locked.

Specified by:

save in interface ORecord

Returns:

The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.

save

public <RET extends ORecord> RET save(boolean forceCreate)

Specified by:

save in interface ORecord

save

public <RET extends ORecord> RET save(String iCluster,
                                      boolean forceCreate)

Specified by:

save in interface ORecord

fromJSON

public <RET extends ORecord> RET fromJSON(String iJson)

Description copied from interface: ORecord

Fills the record parsing the content in JSON format.

Specified by:

fromJSON in interface ORecord

Parameters:

iJson - Object content in JSON format

Returns:

The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.

toJSON

public String toJSON()

Description copied from interface: ORecord

Exports the record in JSON format.

Specified by:

toJSON in interface ORecord

Returns:

Object content in JSON format

toJSON

public String toJSON(String iFormat)

Description copied from interface: ORecord

Exports the record in JSON format specifying additional formatting settings.

Specified by:

toJSON in interface ORecord

Parameters:

iFormat - Format settings separated by comma. Available settings are:

• rid: exports the record's id as property "@rid"
• version: exports the record's version as property "@version"
• class: exports the record's class as property "@class"
• attribSameRow: exports all the record attributes in the same row
• indent:<level>: Indents the output if the <level> specified. Default is 0

Example: "rid,version,class,indent:6" exports record id, version and class properties along with record properties using an indenting level equals of 6.

Returns:

Object content in JSON format

getSize

public int getSize()

Description copied from interface: ORecord

Returns the size in bytes of the record. The size can be computed only for not new records.

Specified by:

getSize in interface ORecord

Returns:

the size in bytes

toString

public String toString()

Overrides:

toString in class Object