com.orientechnologies.orient.core.id

Class ORecordId

java.lang.Object

com.orientechnologies.orient.core.id.ORecordId

All Implemented Interfaces:

OIdentifiable, ORID, OSerializableStream, Serializable, Comparable<OIdentifiable>, Comparator<OIdentifiable>

Direct Known Subclasses:

OContextualRecordId, OImmutableRecordId

public class ORecordId
extends Object
implements ORID

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ORecordId	EMPTY_RECORD_ID
static byte[]	EMPTY_RECORD_ID_STREAM
static int	PERSISTENT_SIZE

Fields inherited from interface com.orientechnologies.orient.core.id.ORID

CLUSTER_ID_INVALID, CLUSTER_MAX, CLUSTER_POS_INVALID, PREFIX, SEPARATOR

Constructor Summary

Constructors

Constructor and Description
ORecordId()
ORecordId(int iClusterIdId)
ORecordId(int clusterId, long position)
ORecordId(ORID parentRid) Copy constructor.
ORecordId(String iRecordId)

Method Summary

Modifier and Type	Method and Description
int	compare(OIdentifiable iObj1, OIdentifiable iObj2)
int	compareTo(OIdentifiable iOther)
ORecordId	copy()
void	copyFrom(ORID iSource)
static ORecordId	deserialize(DataInput input)
boolean	equals(Object obj)
ORecordId	fromStream(byte[] iBuffer) Unmarshalls the object.
void	fromStream(DataInput in)
ORecordId	fromStream(InputStream iStream)
ORecordId	fromStream(OMemoryStream iStream)
void	fromString(String iRecordId)
static String	generateString(int iClusterId, long iPosition)
int	getClusterId()
long	getClusterPosition()
ORID	getIdentity() Returns the record identity.
<T extends ORecord> T	getRecord() Returns the record instance.
int	hashCode()
static boolean	isA(String iString)
boolean	isLocked()
boolean	isNew()
static boolean	isNew(long pos)
boolean	isPersistent()
static boolean	isPersistent(long pos)
boolean	isTemporary()
static boolean	isTemporary(long clusterPosition)
boolean	isValid()
static boolean	isValid(long pos)
void	lock(boolean iExclusive)
OStorage.LOCKING_STRATEGY	lockingStrategy()
String	next()
ORID	nextRid() Deprecated since v2.2
void	reset()
static void	serialize(ORID id, DataOutput output)
void	setClusterId(int clusterId)
void	setClusterPosition(long clusterPosition)
byte[]	toStream() Marshalls the object.
void	toStream(DataOutput out)
int	toStream(OMemoryStream iStream)
int	toStream(OutputStream iStream)
String	toString()
StringBuilder	toString(StringBuilder iBuffer)
void	unlock()

Methods inherited from class java.lang.Object

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

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

EMPTY_RECORD_ID

public static final ORecordId EMPTY_RECORD_ID

EMPTY_RECORD_ID_STREAM

public static final byte[] EMPTY_RECORD_ID_STREAM

PERSISTENT_SIZE

public static final int PERSISTENT_SIZE

See Also:

Constant Field Values

Constructor Detail

ORecordId

public ORecordId()

ORecordId

public ORecordId(int clusterId,
                 long position)

ORecordId

public ORecordId(int iClusterIdId)

ORecordId

public ORecordId(String iRecordId)

ORecordId

public ORecordId(ORID parentRid)

Copy constructor.

Parameters:

parentRid - Source object

Method Detail

generateString

public static String generateString(int iClusterId,
                                    long iPosition)

isValid

public static boolean isValid(long pos)

isPersistent

public static boolean isPersistent(long pos)

isNew

public static boolean isNew(long pos)

isTemporary

public static boolean isTemporary(long clusterPosition)

isA

public static boolean isA(String iString)

reset

public void reset()

Specified by:

reset in interface ORID

isValid

public boolean isValid()

Specified by:

isValid in interface ORID

isPersistent

public boolean isPersistent()

Specified by:

isPersistent in interface ORID

isNew

public boolean isNew()

Specified by:

isNew in interface ORID

isTemporary

public boolean isTemporary()

Specified by:

isTemporary in interface ORID

toString

public String toString()

Overrides:

toString in class Object

toString

public StringBuilder toString(StringBuilder iBuffer)

Specified by:

toString in interface ORID

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

compareTo

public int compareTo(OIdentifiable iOther)

Specified by:

compareTo in interface Comparable<OIdentifiable>

compare

public int compare(OIdentifiable iObj1,
                   OIdentifiable iObj2)

Specified by:

compare in interface Comparator<OIdentifiable>

copy

public ORecordId copy()

Specified by:

copy in interface ORID

toStream

public void toStream(DataOutput out)
              throws IOException

Throws:

IOException

fromStream

public void fromStream(DataInput in)
                throws IOException

Throws:

IOException

fromStream

public ORecordId fromStream(InputStream iStream)
                     throws IOException

Throws:

IOException

fromStream

public ORecordId fromStream(OMemoryStream iStream)

fromStream

public ORecordId fromStream(byte[] iBuffer)

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:

iBuffer - byte array representation of the object

Returns:

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

toStream

public int toStream(OutputStream iStream)
             throws IOException

Specified by:

toStream in interface ORID

Throws:

IOException

toStream

public int toStream(OMemoryStream iStream)
             throws IOException

Throws:

IOException

toStream

public byte[] toStream()

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

See Also:

OSerializableStream.fromStream(byte[])

getClusterId

public int getClusterId()

Specified by:

getClusterId in interface ORID

getClusterPosition

public long getClusterPosition()

Specified by:

getClusterPosition in interface ORID

fromString

public void fromString(String iRecordId)

copyFrom

public void copyFrom(ORID iSource)

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

next

public String next()

Specified by:

next in interface ORID

nextRid

public ORID nextRid()

Description copied from interface: ORID

Deprecated since v2.2

Specified by:

nextRid in interface ORID

getIdentity

public ORID getIdentity()

Description copied from interface: OIdentifiable

Returns the record identity.

Specified by:

getIdentity in interface OIdentifiable

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

setClusterId

public void setClusterId(int clusterId)

setClusterPosition

public void setClusterPosition(long clusterPosition)

serialize

public static void serialize(ORID id,
                             DataOutput output)
                      throws IOException

Throws:

IOException

deserialize

public static ORecordId deserialize(DataInput input)
                             throws IOException

Throws:

IOException