com.persistit

Class Management.VolumeInfo

java.lang.Object

com.persistit.Management.AcquisitionTimeBase

com.persistit.Management.VolumeInfo

All Implemented Interfaces:

Serializable, Comparable<Management.VolumeInfo>

Enclosing interface:

Management

public static class Management.VolumeInfo
extends Management.AcquisitionTimeBase
implements Serializable, Comparable<Management.VolumeInfo>

Exposes information about a Volume. The Management.getVolumeInfoArray() returns information about all open Volumes in an array of VolumeInfo elements.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description

VolumeInfo(int pageSize, String path, String name, long id, long createTime, long openTime, long generation, long getCounter, long readCounter, long writeCounter, long lastRead, long lastWrite, long lastExtension, long maximumPage, long currentPageCount, long maximumPageCount, long extensionPageCount, long garbageRootPage, long fetchCounter, long traverseCounter, long storeCounter, long removeCounter, boolean isTransient)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Management.VolumeInfo volumeInfo)
boolean	equals(Object object) Tests whether the supplied object is a VolumeInfo with the same volume name and id as this one.
Date	getCreateTime() Return the time and date when this Volume was created.
long	getCurrentSize() Return the current size in bytes of this Volume.
long	getExtensionSize() Return the size in bytes by which Persistit will extend this Volume when additional file space is required.
long	getFetchCounter() Return the count of Exchange.fetch() operations.
long	getGeneration() Return the generation number for this Volume.
long	getGetCounter() Return the number of get operations on this Volume.
long	getId() Return the internal identifier value for this Volume
Date	getLastExtensionTime() Return the time and date when the most recent file extension occurred.
Date	getLastReadTime() Return the time and date when the most recent file read occurred.
Date	getLastWriteTime() Return the time and date when the most recent file write occurred.
long	getMaximumPageAddress() Return the largest page address currently in use within the Volume.
long	getMaximumSize() Return the maximum size in bytes to which this Volume may grow.
String	getName() Return the alias if one was assigned in the system configuration.
Date	getOpenTime() Return the time and date when this Volume was opened.
int	getPageSize() Return the page size for this Volume.
String	getPath() Return the full path name.
long	getReadCounter() Return the number of physical read operations performed against pages in this Volume.
long	getRemoveCounter() Return the count of Exchange.remove() operations, including Exchange.fetchAndRemove() operations.
long	getStoreCounter() Return the count of Exchange.store(com.persistit.Key, com.persistit.Value) operations, including Exchange.fetchAndStore() operations.
long	getTraverseCounter() Return the count of Exchange.traverse(com.persistit.Key.Direction, boolean) operations.
long	getWriteCounter() Return the number of physical write operations performed against pages in this Volume.
boolean	isTransient()
String	toString() Return the name of this Volume

Methods inherited from class com.persistit.Management.AcquisitionTimeBase

getAcquisitionTime, setAcquisitionTime

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

VolumeInfo

@ConstructorProperties(value={"pageSize","path","name","id","createTime","openTime","generation","getCounter","readCounter","writeCounter","lastRead","lastWrite","lastExtension","maximumPage","currentPageCount","maximumPageCount","extensionPageCount","garbageRootPage","fetchCounter","traverseCounter","storeCounter","removeCounter","isTransient"})
public VolumeInfo(int pageSize,
                                                                                                                                                                                                                                                                                                                                                                               String path,
                                                                                                                                                                                                                                                                                                                                                                               String name,
                                                                                                                                                                                                                                                                                                                                                                               long id,
                                                                                                                                                                                                                                                                                                                                                                               long createTime,
                                                                                                                                                                                                                                                                                                                                                                               long openTime,
                                                                                                                                                                                                                                                                                                                                                                               long generation,
                                                                                                                                                                                                                                                                                                                                                                               long getCounter,
                                                                                                                                                                                                                                                                                                                                                                               long readCounter,
                                                                                                                                                                                                                                                                                                                                                                               long writeCounter,
                                                                                                                                                                                                                                                                                                                                                                               long lastRead,
                                                                                                                                                                                                                                                                                                                                                                               long lastWrite,
                                                                                                                                                                                                                                                                                                                                                                               long lastExtension,
                                                                                                                                                                                                                                                                                                                                                                               long maximumPage,
                                                                                                                                                                                                                                                                                                                                                                               long currentPageCount,
                                                                                                                                                                                                                                                                                                                                                                               long maximumPageCount,
                                                                                                                                                                                                                                                                                                                                                                               long extensionPageCount,
                                                                                                                                                                                                                                                                                                                                                                               long garbageRootPage,
                                                                                                                                                                                                                                                                                                                                                                               long fetchCounter,
                                                                                                                                                                                                                                                                                                                                                                               long traverseCounter,
                                                                                                                                                                                                                                                                                                                                                                               long storeCounter,
                                                                                                                                                                                                                                                                                                                                                                               long removeCounter,
                                                                                                                                                                                                                                                                                                                                                                               boolean isTransient)

Method Detail

getPageSize

public int getPageSize()

Return the page size for this Volume.

Returns:

the size of each page in this Volume

getPath

public String getPath()

Return the full path name.

Returns:

the path name.

getName

public String getName()

Return the alias if one was assigned in the system configuration.

Returns:

the alias for this volume, or null if there is none

getId

public long getId()

Return the internal identifier value for this Volume

Returns:

the id

getCreateTime

public Date getCreateTime()

Return the time and date when this Volume was created.

Returns:

The creation date

getOpenTime

public Date getOpenTime()

Return the time and date when this Volume was opened.

Returns:

The date when this Volume was opened.

getLastReadTime

public Date getLastReadTime()

Return the time and date when the most recent file read occurred.

Returns:

The date when the most recent file read occurred

getLastWriteTime

public Date getLastWriteTime()

Return the time and date when the most recent file write occurred.

Returns:

The date when the most recent file write occurred

getLastExtensionTime

public Date getLastExtensionTime()

Return the time and date when the most recent file extension occurred.

Returns:

The date when the most recent file extension occurred

getGeneration

public long getGeneration()

Return the generation number for this Volume. The generation number increases as the state of the volume changes.

Returns:

The current generation

getGetCounter

public long getGetCounter()

Return the number of get operations on this Volume. A get operation occurs when a thread attempts to find or update information on the page, regardless of whether the page had previously been copied into the BufferPool.

Returns:

the get counter

getReadCounter

public long getReadCounter()

Return the number of physical read operations performed against pages in this Volume. The read occurs only when Persistit requires the content of a page that has not already been copied into the BufferPool or which has become invalid.

Returns:

the read counter

getWriteCounter

public long getWriteCounter()

Return the number of physical write operations performed against pages in this Volume.

Returns:

the write counter

getFetchCounter

public long getFetchCounter()

Return the count of Exchange.fetch() operations. These include Exchange.fetchAndStore() and Exchange.fetchAndRemove() operations. This count is maintained within the stored Volume and is not reset when Persistit closes. It is provided to assist in application performance tuning.

Returns:

The count of records fetched from this Volume.

getTraverseCounter

public long getTraverseCounter()

Return the count of Exchange.traverse(com.persistit.Key.Direction, boolean) operations. These include Exchange.next(), Exchange.previous() and other derivative operations. This count is maintained within the stored Volume and is not reset when Persistit closes. It is provided to assist in application performance tuning.

Returns:

The count of key traversal operations performed on this in this Volume.

getStoreCounter

public long getStoreCounter()

Return the count of Exchange.store(com.persistit.Key, com.persistit.Value) operations, including Exchange.fetchAndStore() operations. This count is maintained within the stored Volume and is not reset when Persistit closes. It is provided to assist in application performance tuning.

Returns:

The count of records fetched from this Volume.

getRemoveCounter

public long getRemoveCounter()

Return the count of Exchange.remove() operations, including Exchange.fetchAndRemove() operations. This count is maintained within the stored Volume and is not reset when Persistit closes. It is provided to assist in application performance tuning.

Returns:

The count of records fetched from this Volume.

getCurrentSize

public long getCurrentSize()

Return the current size in bytes of this Volume.

Returns:

current size

getMaximumPageAddress

public long getMaximumPageAddress()

Return the largest page address currently in use within the Volume.

Returns:

the largest page address

getMaximumSize

public long getMaximumSize()

Return the maximum size in bytes to which this Volume may grow.

Returns:

the maximum size

getExtensionSize

public long getExtensionSize()

Return the size in bytes by which Persistit will extend this Volume when additional file space is required.

Returns:

The extension size

isTransient

public boolean isTransient()

toString

public String toString()

Return the name of this Volume

Overrides:

toString in class Object

Returns:

The name

equals

public boolean equals(Object object)

Tests whether the supplied object is a VolumeInfo with the same volume name and id as this one.

Overrides:

equals in class Object

Returns:

true if equal, otherwise false

compareTo

public int compareTo(Management.VolumeInfo volumeInfo)

Specified by:

compareTo in interface Comparable<Management.VolumeInfo>