Package com.orientechnologies.orient.core.storage

Interface OCluster

All Superinterfaces:

OClusterInfo

All Known Implementing Classes:

OClusterRemote, OOfflineCluster, OPaginatedCluster, OPaginatedClusterV0, OPaginatedClusterV1, OPaginatedClusterV2

public interface OCluster
extends OClusterInfo

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	OCluster.ATTRIBUTES

Method Summary

Modifier and Type	Method	Description
void	acquireAtomicExclusiveLock()	Acquires exclusive lock in the active atomic operation running on the current thread for this cluster.
OPhysicalPosition	allocatePosition(byte recordType, OAtomicOperation atomicOperation)	Allocates a physical position pointer on the storage for generate an id without a content.
OPhysicalPosition[]	ceilingPositions(OPhysicalPosition position)
void	close()
void	close(boolean flush)
String	compression()
void	configure(int iId, String iClusterName)
void	configure(OStorage iStorage, OStorageClusterConfiguration iConfig)
void	create(OAtomicOperation atomicOperation)
OPhysicalPosition	createRecord(byte[] content, int recordVersion, byte recordType, OPhysicalPosition allocatedPosition, OAtomicOperation atomicOperation)	Creates a new record in the cluster.
void	delete(OAtomicOperation atomicOperation)
boolean	deleteRecord(OAtomicOperation atomicOperation, long clusterPosition)
String	encryption()
boolean	exists()
OPhysicalPosition[]	floorPositions(OPhysicalPosition position)
int	getBinaryVersion()
long	getEntries()
String	getFileName()
long	getFirstPosition()
int	getId()
long	getLastPosition()
String	getName()
long	getNextPosition()
OPhysicalPosition	getPhysicalPosition(OPhysicalPosition iPPosition)	Fills and return the PhysicalPosition object received as parameter with the physical position of logical record iPosition
ORecordConflictStrategy	getRecordConflictStrategy()
default String	getRecordConflictStrategyName()
long	getRecordsSize()	Returns the size of the records contained in the cluster in bytes.
OPhysicalPosition[]	higherPositions(OPhysicalPosition position)
boolean	isDeleted(OPhysicalPosition iPPosition)	Check if a rid is existent and deleted or not existent return true only if delete flag is set.
boolean	isSystemCluster()
OPhysicalPosition[]	lowerPositions(OPhysicalPosition position)
OClusterBrowsePage	nextPage(long lastPosition)
void	open(OAtomicOperation atomicOperation)
ORawBuffer	readRecord(long clusterPosition)
ORawBuffer	readRecordIfVersionIsNotLatest(long clusterPosition, int recordVersion)
void	setClusterName(String name)
void	setEncryption(String encryptionName, String encryptionKey)
void	setRecordConflictStrategy(String conflictStrategy)
void	synch()
void	updateRecord(long clusterPosition, byte[] content, int recordVersion, byte recordType, OAtomicOperation atomicOperation)

Method Details

configure

void configure(int iId,
 String iClusterName)
        throws IOException

Throws:

IOException

configure

void configure(OStorage iStorage,
 OStorageClusterConfiguration iConfig)
        throws IOException

Throws:

IOException

create

void create(OAtomicOperation atomicOperation)
     throws IOException

Throws:

IOException

open

void open(OAtomicOperation atomicOperation)
   throws IOException

Throws:

IOException

close

void close()
    throws IOException

Throws:

IOException

close

void close(boolean flush)
    throws IOException

Throws:

IOException

delete

void delete(OAtomicOperation atomicOperation)
     throws IOException

Throws:

IOException

setClusterName

void setClusterName(String name)

setRecordConflictStrategy

void setRecordConflictStrategy(String conflictStrategy)

setEncryption

void setEncryption(String encryptionName,
 String encryptionKey)

encryption

String encryption()

Specified by:

encryption in interface OClusterInfo

allocatePosition

OPhysicalPosition allocatePosition(byte recordType,
 OAtomicOperation atomicOperation)
                            throws IOException

Allocates a physical position pointer on the storage for generate an id without a content.

Parameters:

recordType - the type of record of which allocate the position.

Returns:

the allocated position.

Throws:

IOException

createRecord

OPhysicalPosition createRecord(byte[] content,
 int recordVersion,
 byte recordType,
 OPhysicalPosition allocatedPosition,
 OAtomicOperation atomicOperation)

Creates a new record in the cluster.

Parameters:

content - the content of the record.

recordVersion - the current version

recordType - the type of the record

allocatedPosition - the eventual allocated position or null if there is no allocated position.

Returns:

the position where the record si created.

deleteRecord

boolean deleteRecord(OAtomicOperation atomicOperation,
 long clusterPosition)

updateRecord

void updateRecord(long clusterPosition,
 byte[] content,
 int recordVersion,
 byte recordType,
 OAtomicOperation atomicOperation)

readRecord

ORawBuffer readRecord(long clusterPosition)
               throws IOException

Throws:

IOException

readRecordIfVersionIsNotLatest

ORawBuffer readRecordIfVersionIsNotLatest(long clusterPosition,
 int recordVersion)
                                   throws IOException,
ORecordNotFoundException

Throws:

IOException

ORecordNotFoundException

exists

boolean exists()

getPhysicalPosition

OPhysicalPosition getPhysicalPosition(OPhysicalPosition iPPosition)
                               throws IOException

Fills and return the PhysicalPosition object received as parameter with the physical position of logical record iPosition

Throws:

IOException

isDeleted

boolean isDeleted(OPhysicalPosition iPPosition)
           throws IOException

Check if a rid is existent and deleted or not existent return true only if delete flag is set.

Throws:

IOException

getEntries

long getEntries()

Specified by:

getEntries in interface OClusterInfo

getFirstPosition

long getFirstPosition()
               throws IOException

Throws:

IOException

getLastPosition

long getLastPosition()
              throws IOException

Throws:

IOException

getNextPosition

long getNextPosition()
              throws IOException

Throws:

IOException

getFileName

String getFileName()

Specified by:

getFileName in interface OClusterInfo

getId

int getId()

Specified by:

getId in interface OClusterInfo

synch

void synch()
    throws IOException

Throws:

IOException

getName

String getName()

Specified by:

getName in interface OClusterInfo

getRecordsSize

long getRecordsSize()
             throws IOException

Returns the size of the records contained in the cluster in bytes.

Throws:

IOException

compression

String compression()

isSystemCluster

boolean isSystemCluster()

higherPositions

OPhysicalPosition[] higherPositions(OPhysicalPosition position)
                             throws IOException

Throws:

IOException

ceilingPositions

OPhysicalPosition[] ceilingPositions(OPhysicalPosition position)
                              throws IOException

Throws:

IOException

lowerPositions

OPhysicalPosition[] lowerPositions(OPhysicalPosition position)
                            throws IOException

Throws:

IOException

floorPositions

OPhysicalPosition[] floorPositions(OPhysicalPosition position)
                            throws IOException

Throws:

IOException

getRecordConflictStrategyName

default String getRecordConflictStrategyName()

Specified by:

getRecordConflictStrategyName in interface OClusterInfo

getRecordConflictStrategy

ORecordConflictStrategy getRecordConflictStrategy()

acquireAtomicExclusiveLock

void acquireAtomicExclusiveLock()

Acquires exclusive lock in the active atomic operation running on the current thread for this cluster.

nextPage

OClusterBrowsePage nextPage(long lastPosition)
                     throws IOException

Throws:

IOException

getBinaryVersion

int getBinaryVersion()