Package com.arcadedb.database

Interface Identifiable

All Known Subinterfaces:

Document, Edge, EdgeSegment, EmbeddedDocument, LightEdge, Record, Vertex, VertexInternal

All Known Implementing Classes:

BaseDocument, BaseRecord, DetachedDocument, ImmutableDocument, ImmutableEdge, ImmutableEmbeddedDocument, ImmutableLightEdge, ImmutableVertex, MutableDocument, MutableEdge, MutableEdgeSegment, MutableEmbeddedDocument, MutableVertex, RID

public interface Identifiable

Interface to identify an object in the database.

Author:

Luca Garulli

Method Summary

Modifier and Type	Method	Description
Document	asDocument()	Returns the document record.
Document	asDocument(boolean loadContent)	Returns the document record.
Edge	asEdge()	Returns the edge record.
Edge	asEdge(boolean loadContent)	Returns the edge record.
Vertex	asVertex()	Returns the vertex record.
Vertex	asVertex(boolean loadContent)	Returns the vertex record.
RID	getIdentity()	Returns the RID (Record ID) for the current object.
Record	getRecord()	Returns the generic record by pre-loading also its content.
Record	getRecord(boolean loadContent)	Returns the generic record.

Method Detail

getIdentity

RID getIdentity()

Returns the RID (Record ID) for the current object.

Returns:

the RID

getRecord

Record getRecord(boolean loadContent)

Returns the generic record.

Parameters:

loadContent - specifies if pre-load the record content

Returns:

the Record

getRecord

Record getRecord()

Returns the generic record by pre-loading also its content.

Returns:

the Record

asDocument

Document asDocument()

Returns the document record. If the record is not a document, a UnsupportedOperationException exception is thrown.

Returns:

the Document

asDocument

Document asDocument(boolean loadContent)

Returns the document record. If the record is not a document, a UnsupportedOperationException exception is thrown.

Parameters:

loadContent - specifies if pre-load the record content

Returns:

the Document

asVertex

Vertex asVertex()

Returns the vertex record. If the record is not a vertex, a UnsupportedOperationException exception is thrown.

Returns:

the Vertex

asVertex

Vertex asVertex(boolean loadContent)

Returns the vertex record. If the record is not a vertex, a UnsupportedOperationException exception is thrown.

Parameters:

loadContent - specifies if pre-load the record content

Returns:

the Vertex

asEdge

Edge asEdge()

Returns the edge record. If the record is not an edge, a UnsupportedOperationException exception is thrown. *

Returns:

the Edge

asEdge

Edge asEdge(boolean loadContent)

Returns the edge record. If the record is not an edge, a UnsupportedOperationException exception is thrown.

Parameters:

loadContent - specifies if pre-load the record content

Returns:

the Edge