Edge (arcadedb-engine 22.1.2 API)

All Superinterfaces:

Document, Identifiable, Record

All Known Subinterfaces:

LightEdge

All Known Implementing Classes:

ImmutableEdge, ImmutableLightEdge, MutableEdge
```
public interface Edge
extends Document
```
An Edge represents the connection between two vertices in a Property Graph. The edge can have properties and point to the same vertex. The direction of the edge goes from the source vertex to the destination vertex. By default edges are bidirectional, that means they can be traversed from both sides. Unidirectional edges can only be traversed from the direction they were created, never backwards. Edges can be Immutable (read-only) and Mutable.

Author:

Luca Garulli ([email protected])

See Also:

Vertex

Field Summary

Fields
Modifier and Type Field Description

static byte RECORD_TYPE

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default Edge`	`asEdge()`	Returns the edge record.
`default Edge`	`asEdge(boolean loadContent)`	Returns the edge record.
`RID`	`getIn()`
`Vertex`	`getInVertex()`
`RID`	`getOut()`
`Vertex`	`getOutVertex()`
`Vertex`	`getVertex(Vertex.DIRECTION iDirection)`
`MutableEdge`	`modify()`

Methods inherited from interface com.arcadedb.database.Document
asDocument, asDocument, detach, get, getBoolean, getByte, getDate, getDecimal, getDouble, getEmbedded, getFloat, getInteger, getLong, getPropertyNames, getShort, getString, getType, getTypeName, has, toJSON, toMap

Methods inherited from interface com.arcadedb.database.Identifiable
asVertex, asVertex, getRecord, getRecord

Methods inherited from interface com.arcadedb.database.Record
delete, getDatabase, getIdentity, getRecordType, reload

- Field Detail
  - RECORD_TYPE
```
static final byte RECORD_TYPE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - modify
```
MutableEdge modify()
```
    Specified by:
    
    modify in interface Document
  - getOut
```
RID getOut()
```
  - getOutVertex
```
Vertex getOutVertex()
```
  - getIn
```
RID getIn()
```
  - getInVertex
```
Vertex getInVertex()
```
  - getVertex
```
Vertex getVertex(Vertex.DIRECTION iDirection)
```
  - asEdge
```
default Edge asEdge()
```
    Description copied from interface: Identifiable
    
    Returns the edge record. If the record is not an edge, a UnsupportedOperationException exception is thrown. *
    
    Specified by:
    
    asEdge in interface Identifiable
    
    Returns:
    
    the Edge
  - asEdge
```
default Edge asEdge(boolean loadContent)
```
    Description copied from interface: Identifiable
    
    Returns the edge record. If the record is not an edge, a UnsupportedOperationException exception is thrown.
    
    Specified by:
    
    asEdge in interface Identifiable
    
    Parameters:
    
    loadContent - specifies if pre-load the record content
    
    Returns:
    
    the Edge