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

Class OOfflineCluster

java.lang.Object

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

All Implemented Interfaces:

OCluster

public class OOfflineCluster
extends Object
implements OCluster

Represents an offline cluster, created with the "alter cluster X status offline" command. To restore the original cluster assure to have the cluster files in the right path and execute: "alter cluster X status online".

Since:

2.0

Author:

Luca Garulli

Nested Class Summary

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

OCluster.ATTRIBUTES

Constructor Summary

Constructors

Constructor and Description
OOfflineCluster(OAbstractPaginatedStorage iStorage, int iId, String iName)

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 attribute, Object value)
void	synch()
void	truncate() Truncates the cluster content.
void	updateRecord(long clusterPosition, byte[] content, int recordVersion, byte recordType)

Methods inherited from class java.lang.Object

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

Constructor Detail

OOfflineCluster

public OOfflineCluster(OAbstractPaginatedStorage iStorage,
                       int iId,
                       String iName)

Method Detail

configure

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

Specified by:

configure in interface OCluster

Throws:

IOException

configure

public void configure(OStorage iStorage,
                      OStorageClusterConfiguration iConfig)
               throws IOException

Specified by:

configure in interface OCluster

Throws:

IOException

create

public void create(int iStartSize)
            throws IOException

Specified by:

create in interface OCluster

Throws:

IOException

open

public void open()
          throws IOException

Specified by:

open in interface OCluster

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

encryption

public String encryption()

Specified by:

encryption in interface OCluster

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

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

deleteRecord

public boolean deleteRecord(long clusterPosition)
                     throws IOException

Specified by:

deleteRecord in interface OCluster

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

Description copied from interface: OCluster

Recycling a record position that was deleted.

Specified by:

recycleRecord in interface OCluster

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

exists

public boolean exists()

Specified by:

exists in interface OCluster

getPhysicalPosition

public OPhysicalPosition getPhysicalPosition(OPhysicalPosition iPPosition)
                                      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

synch

public void synch()
           throws IOException

Specified by:

synch in interface OCluster

Throws:

IOException

getName

public String getName()

Specified by:

getName in interface OCluster

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

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

isHashBased

public boolean isHashBased()

Specified by:

isHashBased in interface OCluster

isSystemCluster

public boolean isSystemCluster()

Specified by:

isSystemCluster 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

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

getRecordConflictStrategy

public ORecordConflictStrategy getRecordConflictStrategy()

Specified by:

getRecordConflictStrategy in interface OCluster

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

checkClusterConsistency

public int checkClusterConsistency()
                            throws IOException

Specified by:

checkClusterConsistency in interface OCluster

Throws:

IOException