com.orientechnologies.orient.core.storage

Interface OCluster

All Known Implementing Classes:

OClusterRemote, OOfflineCluster, OPaginatedCluster

public interface OCluster

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OCluster.ATTRIBUTES

Method Summary

Modifier and Type	Method and Description
OClusterEntryIterator	absoluteIterator()
void	acquireAtomicExclusiveLock() Acquires exclusive lock in the active atomic operation running on the current thread for this cluster.
OPhysicalPosition	allocatePosition(byte recordType) Allocates a physical position pointer on the storage for generate an id without a content.
OPhysicalPosition[]	ceilingPositions(OPhysicalPosition position)
int	checkClusterConsistency()
void	close()
void	close(boolean flush)
void	compact()
String	compression()
void	configure(OStorage iStorage, int iId, String iClusterName, Object... iParameters)
void	configure(OStorage iStorage, OStorageClusterConfiguration iConfig)
void	create(int iStartSize)
OPhysicalPosition	createRecord(byte[] content, int recordVersion, byte recordType, OPhysicalPosition allocatedPosition) Creates a new record in the cluster.
void	delete()
boolean	deleteRecord(long clusterPosition)
String	encryption()
boolean	exists()
OPhysicalPosition[]	floorPositions(OPhysicalPosition position)
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()
long	getRecordsSize() Returns the size of the records contained in the cluster in bytes.
long	getTombstonesCount()
boolean	hideRecord(long position) Hides records content by putting tombstone on the records position but does not delete record itself.
OPhysicalPosition[]	higherPositions(OPhysicalPosition position)
boolean	isHashBased()
boolean	isSystemCluster()
OPhysicalPosition[]	lowerPositions(OPhysicalPosition position)
void	open()
ORawBuffer	readRecord(long clusterPosition, boolean prefetchRecords)
ORawBuffer	readRecordIfVersionIsNotLatest(long clusterPosition, int recordVersion)
float	recordGrowFactor()
float	recordOverflowGrowFactor()
void	recycleRecord(long clusterPosition) Recycling a record position that was deleted.
Object	set(OCluster.ATTRIBUTES iAttribute, Object iValue)
void	synch()
void	truncate() Truncates the cluster content.
void	updateRecord(long clusterPosition, byte[] content, int recordVersion, byte recordType)

Method Detail

configure

void configure(OStorage iStorage,
               int iId,
               String iClusterName,
               Object... iParameters)
        throws IOException

Throws:

IOException

configure

void configure(OStorage iStorage,
               OStorageClusterConfiguration iConfig)
        throws IOException

Throws:

IOException

create

void create(int iStartSize)
     throws IOException

Throws:

IOException

open

void open()
   throws IOException

Throws:

IOException

close

void close()
    throws IOException

Throws:

IOException

close

void close(boolean flush)
    throws IOException

Throws:

IOException

delete

void delete()
     throws IOException

Throws:

IOException

set

Object set(OCluster.ATTRIBUTES iAttribute,
           Object iValue)
    throws IOException

Throws:

IOException

encryption

String encryption()

getTombstonesCount

long getTombstonesCount()

truncate

void truncate()
       throws IOException

Truncates the cluster content. All the entries will be removed.

Throws:

IOException

compact

void compact()
      throws IOException

Throws:

IOException

allocatePosition

OPhysicalPosition allocatePosition(byte recordType)
                            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)
                        throws IOException

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.

Throws:

IOException

deleteRecord

boolean deleteRecord(long clusterPosition)
              throws IOException

Throws:

IOException

updateRecord

void updateRecord(long clusterPosition,
                  byte[] content,
                  int recordVersion,
                  byte recordType)
           throws IOException

Throws:

IOException

recycleRecord

void recycleRecord(long clusterPosition)
            throws IOException

Recycling a record position that was deleted.

Throws:

IOException

readRecord

ORawBuffer readRecord(long clusterPosition,
                      boolean prefetchRecords)
               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

getEntries

long getEntries()

getFirstPosition

long getFirstPosition()
               throws IOException

Throws:

IOException

getLastPosition

long getLastPosition()
              throws IOException

Throws:

IOException

getNextPosition

long getNextPosition()
              throws IOException

Throws:

IOException

getFileName

String getFileName()

getId

int getId()

synch

void synch()
    throws IOException

Throws:

IOException

getName

String getName()

getRecordsSize

long getRecordsSize()
             throws IOException

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

Returns:

Throws:

IOException

recordGrowFactor

float recordGrowFactor()

recordOverflowGrowFactor

float recordOverflowGrowFactor()

compression

String compression()

isHashBased

boolean isHashBased()

isSystemCluster

boolean isSystemCluster()

absoluteIterator

OClusterEntryIterator absoluteIterator()

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

hideRecord

boolean hideRecord(long position)
            throws IOException

Hides records content by putting tombstone on the records position but does not delete record itself.

This method is used in case of record content itself is broken and cannot be read or deleted. So it is emergence method.

Parameters:

position - Position of record in cluster

Returns:

false if record does not exist.

Throws:

UnsupportedOperationException - In case current version of cluster does not support given operation.

IOException

getRecordConflictStrategy

ORecordConflictStrategy getRecordConflictStrategy()

acquireAtomicExclusiveLock

void acquireAtomicExclusiveLock()

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

checkClusterConsistency

int checkClusterConsistency()
                     throws IOException

Throws:

IOException