PageCacheStats (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.mercury.mami.indexing.v10.PageCacheStats

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class PageCacheStats
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable
```
No documentation for this element.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`long`	`faults`
`int`	`files`
`long`	`freeBytes`
`long`	`hits`
`long`	`ios`
`long`	`lockedBytes`
`long`	`lookups`
`java.lang.String`	`name`
`long`	`sizeMB`
`long`	`waitHits`
`long`	`waitHitsTimeMS`

Constructor Summary

Constructors
Constructor and Description

PageCacheStats()

PageCacheStats(PageCacheStats o)
Copy constructor

Constructors
Constructor and Description
`PageCacheStats()`
`PageCacheStats(PageCacheStats o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this PageCacheStats.
`static PageCacheStats`	`fromString(java.lang.String s)` String representation of this PageCacheStats.
`long`	`getFaults()` Number of times the page was not available in the cache and had to be fetched synchronously.
`int`	`getFiles()`
`long`	`getFreeBytes()` Free size of the cache. This is linked to the number of pages that have never been required and should quickly drop to zero.
`long`	`getHits()` Number of times the page was available in the cache. The page is considered as available even if it was not yet loaded (prefetching).
`long`	`getIos()` Number of IO operations performed, either synchronously or asynchronously. This counts the operations, not the pages.
`long`	`getLockedBytes()` Currently "locked" size of the cache. This is the number of bytes (pages*page size) that are currently used by running queries. This should not go near the cache size.
`long`	`getLookups()`
`java.lang.String`	`getName()`
`long`	`getSizeMB()`
`long`	`getWaitHits()` Number of times we had to wait for an available page to actually become available. This counts the number of times that prefetch was "right" but not fast enough.
`long`	`getWaitHitsTimeMS()` Total time in milliseconds waited for an available page to actually become available.
`PageCacheStats`	`makeCopy()` Creates and returns a deep copy of this PageCacheStats.
`static PageCacheStats`	`readFrom(java.io.InputStream is)` Read this PageCacheStats from an XML fragment.
`void`	`setFaults(long faults)` Number of times the page was not available in the cache and had to be fetched synchronously.
`void`	`setFiles(int files)`
`void`	`setFreeBytes(long freeBytes)` Free size of the cache. This is linked to the number of pages that have never been required and should quickly drop to zero.
`void`	`setHits(long hits)` Number of times the page was available in the cache. The page is considered as available even if it was not yet loaded (prefetching).
`void`	`setIos(long ios)` Number of IO operations performed, either synchronously or asynchronously. This counts the operations, not the pages.
`void`	`setLockedBytes(long lockedBytes)` Currently "locked" size of the cache. This is the number of bytes (pages*page size) that are currently used by running queries. This should not go near the cache size.
`void`	`setLookups(long lookups)`
`void`	`setName(java.lang.String name)`
`void`	`setSizeMB(long sizeMB)`
`void`	`setWaitHits(long waitHits)` Number of times we had to wait for an available page to actually become available. This counts the number of times that prefetch was "right" but not fast enough.
`void`	`setWaitHitsTimeMS(long waitHitsTimeMS)` Total time in milliseconds waited for an available page to actually become available.
`java.lang.String`	`toString()` String representation of this PageCacheStats.
`PageCacheStats`	`withFaults(long faults)`
`PageCacheStats`	`withFaults(java.lang.Long faults)`
`PageCacheStats`	`withFiles(int files)`
`PageCacheStats`	`withFiles(java.lang.Integer files)`
`PageCacheStats`	`withFreeBytes(long freeBytes)`
`PageCacheStats`	`withFreeBytes(java.lang.Long freeBytes)`
`PageCacheStats`	`withHits(long hits)`
`PageCacheStats`	`withHits(java.lang.Long hits)`
`PageCacheStats`	`withIos(long ios)`
`PageCacheStats`	`withIos(java.lang.Long ios)`
`PageCacheStats`	`withLockedBytes(long lockedBytes)`
`PageCacheStats`	`withLockedBytes(java.lang.Long lockedBytes)`
`PageCacheStats`	`withLookups(long lookups)`
`PageCacheStats`	`withLookups(java.lang.Long lookups)`
`PageCacheStats`	`withName(java.lang.String name)`
`PageCacheStats`	`withSizeMB(long sizeMB)`
`PageCacheStats`	`withSizeMB(java.lang.Long sizeMB)`
`PageCacheStats`	`withWaitHits(long waitHits)`
`PageCacheStats`	`withWaitHits(java.lang.Long waitHits)`
`PageCacheStats`	`withWaitHitsTimeMS(long waitHitsTimeMS)`
`PageCacheStats`	`withWaitHitsTimeMS(java.lang.Long waitHitsTimeMS)`
`void`	`writeTo(java.io.OutputStream os)` Write this PageCacheStats as an XML fragment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
public java.lang.String name
```
  - files
```
public int files
```
  - sizeMB
```
public long sizeMB
```
  - lookups
```
public long lookups
```
  - hits
```
public long hits
```
  - waitHits
```
public long waitHits
```
  - waitHitsTimeMS
```
public long waitHitsTimeMS
```
  - faults
```
public long faults
```
  - ios
```
public long ios
```
  - freeBytes
```
public long freeBytes
```
  - lockedBytes
```
public long lockedBytes
```
- Constructor Detail
  - PageCacheStats
```
public PageCacheStats()
```
  - PageCacheStats
```
public PageCacheStats(PageCacheStats o)
```
    Copy constructor
- Method Detail
  - setName
```
public void setName(java.lang.String name)
```
  - getName
```
public java.lang.String getName()
```
  - withName
```
public PageCacheStats withName(java.lang.String name)
```
  - setFiles
```
public void setFiles(int files)
```
  - getFiles
```
public int getFiles()
```
  - withFiles
```
public PageCacheStats withFiles(int files)
```
  - withFiles
```
public PageCacheStats withFiles(java.lang.Integer files)
```
  - setSizeMB
```
public void setSizeMB(long sizeMB)
```
  - getSizeMB
```
public long getSizeMB()
```
  - withSizeMB
```
public PageCacheStats withSizeMB(long sizeMB)
```
  - withSizeMB
```
public PageCacheStats withSizeMB(java.lang.Long sizeMB)
```
  - setLookups
```
public void setLookups(long lookups)
```
  - getLookups
```
public long getLookups()
```
  - withLookups
```
public PageCacheStats withLookups(long lookups)
```
  - withLookups
```
public PageCacheStats withLookups(java.lang.Long lookups)
```
  - setHits
```
public void setHits(long hits)
```
    Number of times the page was available in the cache.
    The page is considered as available even if it was not yet loaded (prefetching).
  - getHits
```
public long getHits()
```
    Number of times the page was available in the cache.
    The page is considered as available even if it was not yet loaded (prefetching).
  - withHits
```
public PageCacheStats withHits(long hits)
```
  - withHits
```
public PageCacheStats withHits(java.lang.Long hits)
```
  - setWaitHits
```
public void setWaitHits(long waitHits)
```
    Number of times we had to wait for an available page to actually become available.
    This counts the number of times that prefetch was "right" but not fast enough.
  - getWaitHits
```
public long getWaitHits()
```
    Number of times we had to wait for an available page to actually become available.
    This counts the number of times that prefetch was "right" but not fast enough.
  - withWaitHits
```
public PageCacheStats withWaitHits(long waitHits)
```
  - withWaitHits
```
public PageCacheStats withWaitHits(java.lang.Long waitHits)
```
  - setWaitHitsTimeMS
```
public void setWaitHitsTimeMS(long waitHitsTimeMS)
```
    Total time in milliseconds waited for an available page to actually become available.
  - getWaitHitsTimeMS
```
public long getWaitHitsTimeMS()
```
    Total time in milliseconds waited for an available page to actually become available.
  - withWaitHitsTimeMS
```
public PageCacheStats withWaitHitsTimeMS(long waitHitsTimeMS)
```
  - withWaitHitsTimeMS
```
public PageCacheStats withWaitHitsTimeMS(java.lang.Long waitHitsTimeMS)
```
  - setFaults
```
public void setFaults(long faults)
```
    Number of times the page was not available in the cache and had to be fetched synchronously.
  - getFaults
```
public long getFaults()
```
    Number of times the page was not available in the cache and had to be fetched synchronously.
  - withFaults
```
public PageCacheStats withFaults(long faults)
```
  - withFaults
```
public PageCacheStats withFaults(java.lang.Long faults)
```
  - setIos
```
public void setIos(long ios)
```
    Number of IO operations performed, either synchronously or asynchronously.
    This counts the operations, not the pages. An asynchronous operation can span several pages.
  - getIos
```
public long getIos()
```
    Number of IO operations performed, either synchronously or asynchronously.
    This counts the operations, not the pages. An asynchronous operation can span several pages.
  - withIos
```
public PageCacheStats withIos(long ios)
```
  - withIos
```
public PageCacheStats withIos(java.lang.Long ios)
```
  - setFreeBytes
```
public void setFreeBytes(long freeBytes)
```
    Free size of the cache.
    This is linked to the number of pages that have never been required
    and should quickly drop to zero.
  - getFreeBytes
```
public long getFreeBytes()
```
    Free size of the cache.
    This is linked to the number of pages that have never been required
    and should quickly drop to zero.
  - withFreeBytes
```
public PageCacheStats withFreeBytes(long freeBytes)
```
  - withFreeBytes
```
public PageCacheStats withFreeBytes(java.lang.Long freeBytes)
```
  - setLockedBytes
```
public void setLockedBytes(long lockedBytes)
```
    Currently "locked" size of the cache.
    This is the number of bytes (pages*page size) that are currently used by running queries.
    This should not go near the cache size.
  - getLockedBytes
```
public long getLockedBytes()
```
    Currently "locked" size of the cache.
    This is the number of bytes (pages*page size) that are currently used by running queries.
    This should not go near the cache size.
  - withLockedBytes
```
public PageCacheStats withLockedBytes(long lockedBytes)
```
  - withLockedBytes
```
public PageCacheStats withLockedBytes(java.lang.Long lockedBytes)
```
  - makeCopy
```
public PageCacheStats makeCopy()
```
    Creates and returns a deep copy of this PageCacheStats.
  - readFrom
```
public static PageCacheStats readFrom(java.io.InputStream is)
                               throws javax.xml.bind.JAXBException
```
    Read this PageCacheStats from an XML fragment.
    
    Throws:
    
    javax.xml.bind.JAXBException
  - writeTo
```
public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException
```
    Write this PageCacheStats as an XML fragment
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static PageCacheStats fromString(java.lang.String s)
                                 throws javax.xml.bind.JAXBException,
                                        java.io.UnsupportedEncodingException
```
    String representation of this PageCacheStats.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this PageCacheStats.
    
    Overrides:
    
    toString in class java.lang.Object
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this PageCacheStats.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Throws:
    
    com.exalead.util.TypedException

Class PageCacheStats

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

files

sizeMB

lookups

hits

waitHits

waitHitsTimeMS

faults

ios

freeBytes

lockedBytes

Constructor Detail

PageCacheStats

PageCacheStats

Method Detail

setName

getName

withName

setFiles

getFiles

withFiles

withFiles

setSizeMB

getSizeMB

withSizeMB

withSizeMB

setLookups

getLookups

withLookups

withLookups

setHits

getHits

withHits

withHits

setWaitHits

getWaitHits

withWaitHits

withWaitHits

setWaitHitsTimeMS

getWaitHitsTimeMS

withWaitHitsTimeMS

withWaitHitsTimeMS

setFaults

getFaults

withFaults

withFaults

setIos

getIos

withIos

withIos

setFreeBytes

getFreeBytes

withFreeBytes

withFreeBytes

setLockedBytes

getLockedBytes

withLockedBytes

withLockedBytes

makeCopy

readFrom

writeTo

fromString

toString

check