com.orientechnologies.orient.core.storage.impl.local.paginated

Class OPaginatedCluster

java.lang.Object

com.orientechnologies.common.concur.resource.OSharedResourceAdaptive

com.orientechnologies.orient.core.storage.impl.local.paginated.base.ODurableComponent

com.orientechnologies.orient.core.storage.impl.local.paginated.OPaginatedCluster

All Implemented Interfaces:

OCluster

public class OPaginatedCluster
extends ODurableComponent
implements OCluster

Since:

10/7/13

Author:

Andrey Lomakin (a.lomakin-at-orientechnologies.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OPaginatedCluster.RECORD_STATUS

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.storage.OCluster

OCluster.ATTRIBUTES

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEF_EXTENSION
static OPhysicalPosition	NO_POSITION

Fields inherited from class com.orientechnologies.orient.core.storage.impl.local.paginated.base.ODurableComponent

atomicOperationsManager, extension, performanceStatisticManager, readCache, storage, writeCache

Constructor Summary

Constructors

Constructor and Description
OPaginatedCluster(String name, OAbstractPaginatedStorage storage)

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 storage, int id, String clusterName, Object... parameters)
void	configure(OStorage storage, OStorageClusterConfiguration config)
void	create(int startSize)
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()
long	getFileId() Returns the fileId used in disk cache.
String	getFileName()
long	getFirstPosition()
int	getId()
long	getLastPosition()
long	getNextPosition()
OPhysicalPosition	getPhysicalPosition(OPhysicalPosition position) 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.
OPaginatedCluster.RECORD_STATUS	getRecordStatus(long clusterPosition)
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()
OPaginatedClusterDebug	readDebug(long clusterPosition)
ORawBuffer	readRecord(long clusterPosition, boolean prefetchRecords)
ORawBuffer	readRecordIfVersionIsNotLatest(long clusterPosition, int recordVersion)
float	recordGrowFactor()
float	recordOverflowGrowFactor()
void	recycleRecord(long clusterPosition) Recycles a deleted record.
void	registerInStorageConfig(OStorageConfigurationImpl root)
void	replaceClusterMapFile(File file)
void	replaceFile(File file)
Object	set(OCluster.ATTRIBUTES attribute, Object value)
protected void	startOperation()
void	synch()
String	toString()
void	truncate() Truncates the cluster content.
void	updateRecord(long clusterPosition, byte[] content, int recordVersion, byte recordType)

Methods inherited from class com.orientechnologies.orient.core.storage.impl.local.paginated.base.ODurableComponent

acquireExclusiveLock, addFile, addPage, completeOperation, deleteFile, endAtomicOperation, getChanges, getExtension, getFilledUpTo, getFullName, getLockName, getName, isFileExists, isFileExists, loadPage, loadPage, openFile, pinPage, releasePage, setName, startAtomicOperation, truncateFile

Methods inherited from class com.orientechnologies.common.concur.resource.OSharedResourceAdaptive

acquireSharedLock, addUser, assertExclusiveLockHold, assertSharedLockHold, getUsers, isConcurrent, releaseExclusiveLock, releaseSharedLock, removeUser, tryAcquireExclusiveLock, tryAcquireSharedLock

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.orientechnologies.orient.core.storage.OCluster

getName

Field Detail

NO_POSITION

public static final OPhysicalPosition NO_POSITION

DEF_EXTENSION

public static final String DEF_EXTENSION

See Also:

Constant Field Values

Constructor Detail

OPaginatedCluster

public OPaginatedCluster(String name,
                         OAbstractPaginatedStorage storage)

Method Detail

configure

public void configure(OStorage storage,
                      int id,
                      String clusterName,
                      Object... parameters)
               throws IOException

Specified by:

configure in interface OCluster

Throws:

IOException

configure

public void configure(OStorage storage,
                      OStorageClusterConfiguration config)
               throws IOException

Specified by:

configure in interface OCluster

Throws:

IOException

exists

public boolean exists()

Specified by:

exists in interface OCluster

create

public void create(int startSize)
            throws IOException

Specified by:

create in interface OCluster

Throws:

IOException

registerInStorageConfig

public void registerInStorageConfig(OStorageConfigurationImpl root)

open

public void open()
          throws IOException

Specified by:

open in interface OCluster

Throws:

IOException

checkClusterConsistency

public int checkClusterConsistency()
                            throws IOException

Specified by:

checkClusterConsistency in interface OCluster

Throws:

IOException

replaceFile

public void replaceFile(File file)
                 throws IOException

Throws:

IOException

replaceClusterMapFile

public void replaceClusterMapFile(File file)
                           throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface OCluster

Throws:

IOException

close

public void close(boolean flush)
           throws IOException

Specified by:

close in interface OCluster

Throws:

IOException

delete

public void delete()
            throws IOException

Specified by:

delete in interface OCluster

Throws:

IOException

set

public Object set(OCluster.ATTRIBUTES attribute,
                  Object value)
           throws IOException

Specified by:

set in interface OCluster

Throws:

IOException

isSystemCluster

public boolean isSystemCluster()

Specified by:

isSystemCluster in interface OCluster

recordGrowFactor

public float recordGrowFactor()

Specified by:

recordGrowFactor in interface OCluster

recordOverflowGrowFactor

public float recordOverflowGrowFactor()

Specified by:

recordOverflowGrowFactor in interface OCluster

compression

public String compression()

Specified by:

compression in interface OCluster

encryption

public String encryption()

Specified by:

encryption in interface OCluster

allocatePosition

public OPhysicalPosition allocatePosition(byte recordType)
                                   throws IOException

Description copied from interface: OCluster

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

Specified by:

allocatePosition in interface OCluster

Parameters:

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

Returns:

the allocated position.

Throws:

IOException

createRecord

public OPhysicalPosition createRecord(byte[] content,
                                      int recordVersion,
                                      byte recordType,
                                      OPhysicalPosition allocatedPosition)
                               throws IOException

Description copied from interface: OCluster

Creates a new record in the cluster.

Specified by:

createRecord in interface OCluster

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

readRecord

public ORawBuffer readRecord(long clusterPosition,
                             boolean prefetchRecords)
                      throws IOException

Specified by:

readRecord in interface OCluster

Throws:

IOException

readRecordIfVersionIsNotLatest

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

Specified by:

readRecordIfVersionIsNotLatest in interface OCluster

Throws:

IOException

ORecordNotFoundException

deleteRecord

public boolean deleteRecord(long clusterPosition)
                     throws IOException

Specified by:

deleteRecord in interface OCluster

Throws:

IOException

hideRecord

public boolean hideRecord(long position)
                   throws IOException

Description copied from interface: OCluster

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.

Specified by:

hideRecord in interface OCluster

Parameters:

position - Position of record in cluster

Returns:

false if record does not exist.

Throws:

IOException

updateRecord

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

Specified by:

updateRecord in interface OCluster

Throws:

IOException

recycleRecord

public void recycleRecord(long clusterPosition)
                   throws IOException

Recycles a deleted record.

Specified by:

recycleRecord in interface OCluster

Throws:

IOException

getTombstonesCount

public long getTombstonesCount()

Specified by:

getTombstonesCount in interface OCluster

truncate

public void truncate()
              throws IOException

Description copied from interface: OCluster

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

Specified by:

truncate in interface OCluster

Throws:

IOException

compact

public void compact()
             throws IOException

Specified by:

compact in interface OCluster

Throws:

IOException

getPhysicalPosition

public OPhysicalPosition getPhysicalPosition(OPhysicalPosition position)
                                      throws IOException

Description copied from interface: OCluster

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

Specified by:

getPhysicalPosition in interface OCluster

Throws:

IOException

getEntries

public long getEntries()

Specified by:

getEntries in interface OCluster

getFirstPosition

public long getFirstPosition()
                      throws IOException

Specified by:

getFirstPosition in interface OCluster

Throws:

IOException

getLastPosition

public long getLastPosition()
                     throws IOException

Specified by:

getLastPosition in interface OCluster

Throws:

IOException

getNextPosition

public long getNextPosition()
                     throws IOException

Specified by:

getNextPosition in interface OCluster

Throws:

IOException

getFileName

public String getFileName()

Specified by:

getFileName in interface OCluster

getId

public int getId()

Specified by:

getId in interface OCluster

getFileId

public long getFileId()

Returns the fileId used in disk cache.

synch

public void synch()
           throws IOException

Specified by:

synch in interface OCluster

Throws:

IOException

getRecordsSize

public long getRecordsSize()
                    throws IOException

Description copied from interface: OCluster

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

Specified by:

getRecordsSize in interface OCluster

Returns:

Throws:

IOException

isHashBased

public boolean isHashBased()

Specified by:

isHashBased in interface OCluster

absoluteIterator

public OClusterEntryIterator absoluteIterator()

Specified by:

absoluteIterator in interface OCluster

higherPositions

public OPhysicalPosition[] higherPositions(OPhysicalPosition position)
                                    throws IOException

Specified by:

higherPositions in interface OCluster

Throws:

IOException

ceilingPositions

public OPhysicalPosition[] ceilingPositions(OPhysicalPosition position)
                                     throws IOException

Specified by:

ceilingPositions in interface OCluster

Throws:

IOException

lowerPositions

public OPhysicalPosition[] lowerPositions(OPhysicalPosition position)
                                   throws IOException

Specified by:

lowerPositions in interface OCluster

Throws:

IOException

floorPositions

public OPhysicalPosition[] floorPositions(OPhysicalPosition position)
                                   throws IOException

Specified by:

floorPositions in interface OCluster

Throws:

IOException

getRecordConflictStrategy

public ORecordConflictStrategy getRecordConflictStrategy()

Specified by:

getRecordConflictStrategy in interface OCluster

startOperation

protected void startOperation()

Overrides:

startOperation in class ODurableComponent

readDebug

public OPaginatedClusterDebug readDebug(long clusterPosition)
                                 throws IOException

Throws:

IOException

getRecordStatus

public OPaginatedCluster.RECORD_STATUS getRecordStatus(long clusterPosition)
                                                throws IOException

Throws:

IOException

acquireAtomicExclusiveLock

public void acquireAtomicExclusiveLock()

Description copied from interface: OCluster

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

Specified by:

acquireAtomicExclusiveLock in interface OCluster

toString

public String toString()

Overrides:

toString in class Object