Package com.arcadedb.database

Class RID

java.lang.Object

com.arcadedb.database.RID

All Implemented Interfaces:

Identifiable, Serializable, Comparable<Identifiable>

public class RID
extends Object
implements Identifiable, Comparable<Identifiable>, Serializable

It represents the logical address of a record in the database. The record id is composed by the bucket id (the bucket containing the record) and the offset as the absolute position of the record in the bucket.
Immutable class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	bucketId
protected long	offset

Constructor Summary

Constructors

Constructor	Description
RID(Database database, int bucketId, long offset)
RID(Database database, String value)

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.
int	compareTo(Identifiable o)
boolean	equals(Object obj)
int	getBucketId()
Database	getDatabase()
RID	getIdentity()	Returns the RID (Record ID) for the current object.
long	getPosition()
Record	getRecord()	Returns the generic record by pre-loading also its content.
Record	getRecord(boolean loadContent)	Returns the generic record.
int	hashCode()
static boolean	is(Object value)
boolean	isValid()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

bucketId

protected final int bucketId

offset

protected final long offset

Constructor Detail

RID

public RID(Database database,
           int bucketId,
           long offset)

RID

public RID(Database database,
           String value)

Method Detail

is

public static boolean is(Object value)

getBucketId

public int getBucketId()

getPosition

public long getPosition()

toString

public String toString()

Overrides:

toString in class Object

getIdentity

public RID getIdentity()

Description copied from interface: Identifiable

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

Specified by:

getIdentity in interface Identifiable

Returns:

the RID

getRecord

public Record getRecord()

Description copied from interface: Identifiable

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

Specified by:

getRecord in interface Identifiable

Returns:

the Record

getRecord

public Record getRecord(boolean loadContent)

Description copied from interface: Identifiable

Returns the generic record.

Specified by:

getRecord in interface Identifiable

Parameters:

loadContent - specifies if pre-load the record content

Returns:

the Record

asDocument

public Document asDocument()

Description copied from interface: Identifiable

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

Specified by:

asDocument in interface Identifiable

Returns:

the Document

asDocument

public Document asDocument(boolean loadContent)

Description copied from interface: Identifiable

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

Specified by:

asDocument in interface Identifiable

Parameters:

loadContent - specifies if pre-load the record content

Returns:

the Document

asVertex

public Vertex asVertex()

Description copied from interface: Identifiable

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

Specified by:

asVertex in interface Identifiable

Returns:

the Vertex

asVertex

public Vertex asVertex(boolean loadContent)

Description copied from interface: Identifiable

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

Specified by:

asVertex in interface Identifiable

Parameters:

loadContent - specifies if pre-load the record content

Returns:

the Vertex

asEdge

public 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

public 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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Identifiable o)

Specified by:

compareTo in interface Comparable<Identifiable>

getDatabase

public Database getDatabase()

isValid

public boolean isValid()